Skip to main content
POST
Refund a sale

Authorizations

Authorization
string
header
required

Workspace API key, e.g. sa_live_…. Scopes: read / write / track / *.

Body

application/json
external_id
string
required
Example:

"order_1234"

refunded_amount
number

Total refunded so far, in major units.

Example:

25

refunded_amount_cents
integer

Total refunded so far, in minor units. Don't send it together with refunded_amount.

Required range: x >= 0
Example:

2500

currency
string

The sale's currency. Optional once the sale is recorded, and must match it. Required when the refund carries an amount and its sale hasn't arrived yet.

Example:

"usd"

Response

Refund recorded

ok
boolean
Example:

true

conversion_id
string
refund
enum<string>
Available options:
full,
partial