Skip to main content
POST
Refund a payment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

paymentId
string
required

ID of the payment to refund

Body

application/json
amountCents
integer<int64>
required

Amount to refund in cents. For a full refund, use the full payment amount.

Example:

5000

reason
string

Optional reason for the refund

Example:

"Customer requested refund"

Response

Successful operation

id
string
status
string
Example:

"SUCCEEDED"

fees
object[]
amountInCents
integer<int64>
Example:

10000

chargedAmountInCents
integer<int64>
Example:

10290

platformFeeInCents
integer<int64>
Example:

290

paymentMethod
object | null
disbursement
object | null
refunds
object[]
createdAt
number
estimatedDisbursementDate
string | null