Sign in

v5

latestOpenAPI 3.1.0Proprietary2026-08-011476181.4 MB
Sandbox

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.

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

Path parameters

idstring required

The id of the card the return applies to.

Request body

cardTransactionIdstring required

The id of the CardTransaction to refund against. Must have at least one settled clearing.

amountinteger required

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).

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