Skip to main content
POST
Simulate a card credit authorization

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 credit authorization against.

Body

application/json

Sandbox-only request body shared by the card authorization-family simulate endpoints: simulate/authorization, simulate/credit_authorization, simulate/financial_authorization, simulate/financial_credit_authorization, and simulate/credit_authorization_advice. Drives the same internal authorization + reconcile paths that the issuer would call in production. The decisioning outcome is controlled by the last three characters of merchant.descriptor — see the simulate/authorization documentation for the suffix table.

amount
integer<int64>
required

Authorization amount in the smallest unit of currency (e.g. cents for USD).

Example:

1250

currency
object
required
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"