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
id
stringRequiredThe refund's ID
created_at
DateRequiredThe date with timezone at which the resource was created.
updated_at
DateRequiredThe date with timezone at which the resource was updated.
order_id
stringRequiredThe ID of the order this refund was created for.
payment_id
stringRequiredThe payment's ID, if available.
The details of the order this refund was created for.
The details of the payment associated with the refund.
amount
numberRequiredThe amount that has be refunded to the Customer.
note
stringRequiredAn optional note explaining why the amount was refunded.
reason
stringRequiredThe reason given for the Refund, will automatically be set when processed as part of a Swap, Claim or Return.
metadata
Record<string, unknown>RequiredAn optional key-value map with additional details
idempotency_key
stringRequiredRandomly generated key used to continue the completion of the refund in case of failure.
Was this section helpful?