Sign in

v5

OpenAPI 3.1.0Proprietary2026-08-011476181.4 MB
Sandbox

Simulate a card authorization advice

Simulate an AUTHORIZATION_ADVICE that re-sizes an existing open authorization on a CardTransaction in the sandbox environment. The amount is the new total authorized amount the advice re-sizes to. The parent transaction must be in AUTHORIZED or PARTIALLY_SETTLED state. The resulting card operation is delivered asynchronously via the issuer's events webhook.

Production returns 404 on this path.

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

Path parameters

idstring required

The id of the card the advice applies to.

Request body

cardTransactionIdstring required

The id of the CardTransaction the advice re-sizes. Must be in AUTHORIZED or PARTIALLY_SETTLED state.

amountinteger required

The new total authorized amount, in the smallest unit of the transaction's currency, that the advice re-sizes the authorization to.

Example request

{
  "cardTransactionId": "CardTransaction:019542f5-b3e7-1d02-0000-000000000100",
  "amount": 2000
}

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"
}