Sign in

v5

OpenAPI 3.1.0Proprietary2026-08-011476181.4 MB
Sandbox

Simulate a card clearing

Simulate a clearing (settlement) event against an existing CardTransaction in the sandbox environment.

  • A clearing amount greater than the authorized amount exercises the over-auth post-hoc-pull path (e.g. restaurant tip on top of a 20% over-auth).
  • A clearing amount of 0 exercises the AUTHORIZATION_EXPIRY path — the auth expires with no clearing posted.
  • Suffix-driven outcomes on the parent transaction's id govern whether the post-hoc pull succeeds (use the suffix table from simulate/authorization to construct deterministic test cases).

Production returns 404 on this path.

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

Path parameters

idstring required

The id of the card the clearing applies to.

Request body

cardTransactionIdstring required

The id of the CardTransaction to clear against. Must be in AUTHORIZED or PARTIALLY_SETTLED state.

amountinteger required

Clearing amount in the smallest unit of the transaction's currency. Set to 0 to simulate an authorization expiry with no clearing.

Example request

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

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