Sign in

v5

OpenAPI 3.1.0Proprietary2026-08-011476181.4 MB
Sandbox

Simulate a card credit authorization

Simulate an inbound credit authorization (a merchant-initiated credit to the card, e.g. a refund pushed as an authorization) in the sandbox environment. 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.

As with simulate/authorization, the decisioning outcome is controlled by the last three characters of merchant.descriptor — see the simulate/authorization suffix table.

Production returns 404 on this path.

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

Path parameters

idstring required

The id of the card to simulate a credit authorization against.

Request body

amountinteger required

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

Example request

{
  "amount": 1250,
  "currency": {
    "code": "USD",
    "name": "United States Dollar",
    "symbol": "$",
    "decimals": 2
  },
  "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"
}