v5

OpenAPI 3.1.0Proprietary2026-08-011476181.4 MB

Sandbox

Simulate a card return reversal

Simulate a RETURN_REVERSAL against an existing REFUNDED card transaction in the sandbox environment — reversing a previously settled return. The parent transaction must be in REFUNDED state. The resulting card operation is delivered asynchronously via the issuer's events webhook.

Note: authorization reversal / void has no dedicated card-issuer simulate path (the void simulator emits a distinct VOID event), so — like authorization expiry — it is not exposed here.

Production returns 404 on this path.

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

Path parameters

idstring required

The id of the card the return reversal applies to.

Request body

cardTransactionIdstring required

The id of the CardTransaction to act against.

Example request

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

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