Interface CreateRefundParams

Parameters for refunding a settled collection.

interface CreateRefundParams {
    amount: Money;
    merchantTradeNo: string;
    reason?: string;
    refundRequestId?: string;
}

Properties

amount: Money

Amount to refund (decimal-string amount + currency). Supports partial refunds up to the collected total. Required.

merchantTradeNo: string

Order reference of the original checkout/collection being refunded. Required.

reason?: string

Optional free-text reason recorded with the refund.

refundRequestId?: string

Optional client-supplied refund id (idempotency handle within the order).