Skip to main content
GET
Get refund availability

Authorizations

Authorization
string
header
required

Your secret key, e.g. sk_live_... or sk_sandbox_....

Path Parameters

paymentIntentId
string
required

The payment intent id.

Response

The refund position of the payment.

data
object

What this payment can still be refunded for. refundable_amount is authoritative: it already reserves in-flight refunds, so a refund up to that amount is the one guaranteed not to be rejected on balance.