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.

Constructors

constructor

**new 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

amountnumberRequired

The amount that has be refunded to the Customer.

created_atDateRequired

The date with timezone at which the resource was created.

idstringRequired

The refund's ID

idempotency_keystringRequired

Randomly generated key used to continue the completion of the refund in case of failure.

metadataRecord<string, unknown>Required

An optional key-value map with additional details

notestringRequired

An optional note explaining why the amount was refunded.

orderOrderRequired

The details of the order this refund was created for.

order_idstringRequired

The ID of the order this refund was created for.

paymentPaymentRequired

The details of the payment associated with the refund.

payment_idstringRequired

The payment's ID, if available.

reasonstringRequired

The reason given for the Refund, will automatically be set when processed as part of a Swap, Claim or Return.

updated_atDateRequired

The date with timezone at which the resource was updated.

Methods

beforeInsert

Private **beforeInsert**(): void

Returns

void

voidvoid