Skip to main content
POST
Create a refund

Authorizations

Authorization
string
header
required

API key starting with sk_live_ or sk_test_

Headers

Idempotency-Key
string

Body

application/json
paymentIntentId
string
required
amount
integer

Partial refund amount in centavos (omit for full refund)

reason
string
metadata
object | null

Arbitrary key-value metadata (max 50 keys)

Response

200 - application/json

Refund created

id
string
Example:

"re_abc123"

paymentIntentId
string
amount
string
currency
enum<string>

ISO currency code

Available options:
CVE,
AOA
status
enum<string>
Available options:
PENDING,
PROCESSING,
SUCCEEDED,
FAILED
reason
string | null
failureCode
string | null
failureMessage
string | null
operatorRefundId
string | null
metadata
object | null

Arbitrary key-value metadata (max 50 keys)

createdAt
string<date-time>
updatedAt
string<date-time>