Reverse a payment request
Payment Requests
Reverse a payment request
Unwind a reserved payment request and return all escrowed funds to the account.
POST
Reverse a payment request
Reverses a reserved payment request, returning the full escrow balance to the account wallet through a
REVERSAL execution. The call returns 202 Accepted with status: REVERSING, and the request becomes REVERSED — a final state — once the transfer confirms on-chain. Pass a reason (CUSTOMER_CANCELLATION, MERCHANT_VOID, ACQUIRER_FAILURE, NETWORK_DECLINE, or OTHER); it’s recorded on the request.
Send a unique idempotencyKey; repeating the same key and body returns the original result.
Concept guide: Payment requests
To reverse a request by its card-provider reference instead of its ID, use reverse by reference.
Authorizations
OAuth2 client credentials flow. Token endpoints:
Path Parameters
Unique payment request identifier
Body
application/json
Why a payment request was reversed (recorded for audit).
Available options:
CUSTOMER_CANCELLATION, MERCHANT_VOID, ACQUIRER_FAILURE, NETWORK_DECLINE, OTHER Unique key to prevent duplicate operations on retry
Maximum string length:
255Optional free-text reason for the reversal
Maximum string length:
1000
