Interface Refund

A refund request and its status. Extra provider fields may be present.

interface Refund {
    amount: string;
    currency: string;
    merchantTradeNo: string;
    refundRequestId: string;
    status: string;
    [k: string]: unknown;
}

[k: string]: unknown
Additional provider-specific fields passed through untyped.

Properties

amount: string

Refund amount as a decimal string.

currency: string

Currency/asset code of the refund.

merchantTradeNo: string

Order reference of the collection that was refunded.

refundRequestId: string

The refund's id — pass to Refunds.get to poll its status.

status: string

Current refund status string (e.g. pending/processing/refunded/failed).