Skip to main content
Skip to main content

Refund

A refund represents an amount of money transfered back to the customer for a given reason. Refunds may occur in relation to Returns, Swaps and Claims, but can also be initiated by an admin for an order.

Properties

idstringRequired
The refund's ID
created_atDateRequired
The date with timezone at which the resource was created.
updated_atDateRequired
The date with timezone at which the resource was updated.
order_idstringRequired
The ID of the order this refund was created for.
payment_idstringRequired
The payment's ID, if available.
orderOrderRequired
The details of the order this refund was created for.
paymentPaymentRequired
The details of the payment associated with the refund.
amountnumberRequired
The amount that has be refunded to the Customer.
notestringRequired
An optional note explaining why the amount was refunded.
reasonstringRequired
The reason given for the Refund, will automatically be set when processed as part of a Swap, Claim or Return.
metadataRecord<string, unknown>Required
An optional key-value map with additional details
idempotency_keystringRequired
Randomly generated key used to continue the completion of the refund in case of failure.
Was this section helpful?