Skip to main content
POST
Simulate a card balance inquiry

Authorizations

Authorization
string
header
required

API token authentication using format <api token id>:<api client secret>

Path Parameters

id
string
required

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

Body

application/json

Sandbox-only request body for POST /sandbox/cards/{id}/simulate/balance_inquiry. Drives a balance-inquiry authorization against the card. A balance inquiry is always a 0-amount authorization, so it carries no amount.

merchant
object
required

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.

Response body for the sandbox card-event simulators. The simulate call pokes the card issuer's sandbox; the resulting card operation is delivered asynchronously via the issuer's events webhook, never synchronously in this response.

issuerTransactionToken
string
required

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

Example:

"f3a1c2d4-5b6e-7890-abcd-ef0123456789"