Simulate a card return
Simulate a merchant-initiated RETURN against an existing settled card transaction in the sandbox environment. Creates a CardRefund on the parent and either flips the parent to REFUNDED (full refund) or keeps it SETTLED with a non-zero refundedAmount (partial refund).
Production returns 404 on this path.
Authorizations
API token authentication using format <api token id>:<api client secret>
Path Parameters
The id of the card the return applies to.
Body
Sandbox-only request body for POST /sandbox/cards/{id}/simulate/return. Drives a RETURN event against an existing settled CardTransaction, which creates a CardRefund and pushes the parent transaction towards REFUNDED (full) or keeps it SETTLED (partial).
The id of the CardTransaction to refund against. Must have at least one settled clearing.
"CardTransaction:019542f5-b3e7-1d02-0000-000000000100"
Return amount in the smallest unit of the transaction's currency. Must be less than or equal to the net settled amount (settled minus previously-refunded).
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.
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.
The card issuer's transaction token for the simulated event. Correlates the eventual webhook-delivered card operation back to this simulate call.
"f3a1c2d4-5b6e-7890-abcd-ef0123456789"