Refund a card charge

Refunds a card charge in full or in part. Call it more than once to refund in steps, up to the amount still refundable. Only charges in paid or partially_refunded state can be refunded. Sandbox credentials only see sandbox charges and live credentials only see live charges.

Send an Idempotency-Key header. Without one, the key is derived from the transaction and amount, so an identical retry is collapsed, but two deliberate partial refunds of the same amount would also be collapsed.

Your balance is debited when the refund is processed, not when this call returns. You also receive refunded or partially_refunded callbacks and CARD_REFUND callbacks when the refund changes state.

This endpoint stays available for accounts limited to refunds (REFUND_ONLY).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Your API token. Live token, or sandbox token (prefix tk_test_) where sandbox is supported.

string
required

Your API secret. Live secret, or sandbox secret (prefix sk_test_) where sandbox is supported.

string
required

The card charge idTransaction.

number | null
≥ 0.01

Amount to refund in USD. Omit to refund everything still refundable.

string | null

Optional free text. Accepted but not forwarded to the processor.

string | null

Alternative to the Idempotency-Key header.

Headers
string
length ≤ 255

Unique key per logical operation. A retry with the same key returns the result of the first request instead of creating a second operation. You can also send it as idempotency_key in the body.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json