Skip to main content
POST
Refund an order

Authorizations

x-api-key
string
header
required

Path Parameters

orderUuid
string<uuid>
required

Order UUID.

Body

application/json
amount
number<float>

Amount to refund. When omitted, the full captured amount is refunded.

Required range: x >= 0
Example:

50

reason
string

Explanation for the refund.

Maximum string length: 500
Example:

"Item returned by customer."

Response

Order refunded successfully.

status
boolean
required
Example:

true

message
string | null
required
Example:

""

appended_data
object
required
Example:
data
object
required