Skip to main content
POST
Reverse a payment request by card-provider reference
Reverses a payment request you identify by its card-provider reference instead of its ID: the account comes from paymentRequestReference.cardProviderReference (type + referenceId) and the request from its externalId. Behavior and response — including the { "fiat": <number>, "crypto": "<string>" } amount objects — match reversing by ID. Send a unique idempotencyKey; repeating the same key and body returns the original result. Concept guide: Payment requests

Authorizations

Body

application/json

Reverses a payment request identified by its card-provider reference.

paymentRequestReference
object
required

Identifies a payment request by the card-provider reference of its account plus the request's externalId — used by the "by reference" settle/reverse endpoints.

reason
enum<string>
required

Why a payment request was reversed (recorded for audit).

Available options:
CUSTOMER_CANCELLATION,
MERCHANT_VOID,
ACQUIRER_FAILURE,
NETWORK_DECLINE,
OTHER
idempotencyKey
string
required

Unique key to prevent duplicate operations on retry

Maximum string length: 255
description
string

Optional free-text reason for the reversal

Maximum string length: 1000

Response

Reversal accepted; on-chain processing is asynchronous

success
boolean

Indicates whether the request was successful

result
object