Skip to main content
GET
Get a reversal

Authorizations

Authorization
string
header
required

Stablepay API key. Include as Authorization: Bearer <key>.

Path Parameters

reversalId
string
required

The reversal ID.

Response

Reversal found.

reversalId
string
required

The reversal ID. Use it to check the claim's status.

Example:

"ISS_RV01K5D3W8ZQ4FZXQJHBVYFT9K3F"

paymentId
string
required

The payout being reversed.

Example:

"ISS_KE01K5D3W8ZQ4FZXQJHBVYFT9K3E"

stablepayReference
string
required

The payment reference supplied on the claim.

Example:

"ISS_KE01K5D3W8ZQ4FZXQJHBVYFT9K3E"

reversalReference
string
required

The recipient's reversal confirmation reference.

Example:

"QGR7X8T2PL"

blockchain
string
required

Chain the reversal is paid on. Taken from the original payout.

Example:

"SOLANA"

status
enum<string>
required

pending_review: lodged, awaiting verification. No money has moved. approved: verified by Stablepay; the reversal is queued. sending: the reversal is in flight. confirmed: the reversal is confirmed on-chain. rejected: could not be verified. No money moved. failed: the reversal was attempted and did not complete.

Available options:
pending_review,
approved,
sending,
confirmed,
rejected,
failed
Example:

"pending_review"

reversalAmountUsdc
string
required

Full original amount returned, in USDC.

Example:

"10.500000"

toAddress
string
required

Your funding wallet on that chain. Resolved by Stablepay, never supplied on the claim.

Example:

"4Nd1mXKqRtPvYbGfJhAeZwQsUcTnVpLgDkRyXmWtB9Cq"

reversalTxHash
string | null
required

On-chain hash of the reversal transaction. Null until the reversal is sent.

Example:

null

failureReason
string | null
required

Why the reversal failed. Null unless status is failed.

Example:

null

reason
string | null
required

The note supplied on the claim, or the rejection note.

Example:

"customer requested reversal"

createdAt
string<date-time>
required

When the claim was lodged.

reviewedAt
string<date-time> | null
required

When the claim was approved or rejected. Null while pending_review.

Example:

null

sentAt
string<date-time> | null
required

When the reversal was broadcast. Null until sent.

Example:

null

confirmedAt
string<date-time> | null
required

When the reversal was confirmed on-chain. Null until confirmed.

Example:

null