Get Payment Refundability

Returns whether a payment can currently be refunded, the remaining refundable amount, and a machine-readable reason when it cannot. Use this as a pre-flight check to render a refund affordance without attempting a refund. Refundability is a pre-flight indication, not a guarantee — the provider remains the final authority at execution time.

Path parameters

transactionIdstringRequiredformat: "uuid"
Identifier of the payment to check. UUID v7.

Response

Refundability retrieved successfully.
refundableboolean

Whether the payment can currently be refunded. Branch on this field — it determines whether notRefundableReason is present.

refundableUntildatetimeOptional

ISO-8601 instant until which a refund may still be initiated. Unset when the window is unbounded or the payment is not refundable.

notRefundableReasonenumOptional

Machine-readable reason the payment cannot be refunded. Present exactly when refundable is false; never present when refundable is true.

refundableAmountobjectOptional

Remaining refundable amount in minor units (original minus prior non-failed refunds).

Errors

401
Unauthorized Error
404
Not Found Error