Sign in

v5

OpenAPI 3.1.0Proprietary2026-08-011476181.4 MB
Sandbox

Simulate a card balance inquiry

Simulate a balance-inquiry authorization against a card in the sandbox environment. A balance inquiry is always a 0-amount authorization, so the request carries no amount — only the merchant. Drives the same internal paths the card issuer would call in production. The resulting card operation is delivered asynchronously via the issuer's events webhook.

Production returns 404 on this path.

post/sandbox/cards/{id}/simulate/balance_inquiry

Path parameters

idstring required

The id of the card to simulate a balance inquiry against.

Request body

Example request

{
  "merchant": {
    "descriptor": "BLUE BOTTLE COFFEE SF",
    "mcc": "5814",
    "country": "US"
  }
}

Response

Simulation accepted. The resulting card operation is delivered asynchronously via the issuer's events webhook. Returns the issuer transaction token that correlates the simulated event.

issuerTransactionTokenstring required

The card issuer's transaction token for the simulated event. Correlates the eventual webhook-delivered card operation back to this simulate call.

Example response

{
  "issuerTransactionToken": "f3a1c2d4-5b6e-7890-abcd-ef0123456789"
}