Skip to main content
GET
Returns the refund rows for a payment and the authoritative remaining-refundable amount — call it before refunding so you know exactly how much is left.

Authorization

API key scope refunds:read or dashboard JWT with team permission refunds:view. Rate limit 60/min.

Parameters

string
required
ID of the payment whose refund history to fetch.
Call this before Create a refund: refundable is the authoritative remaining-refundable amount, and eligible tells you up front whether a refund attempt can succeed at all.

Response

array
The refund rows for this payment.
string
The authoritative remaining-refundable amount, as a decimal string.
boolean
Whether the payment can currently be refunded.
string
The payment’s currency — refunds are always made in it.

Errors

Attempting to refund a non-settled payment fails safely on Create a refund:

See also