Typescript SDK Type Docs
    Preparing search index...

    Interface PaymentIntentRefundAction

    Requests to refund the given amount to the customer. Checkout will request the PSP or gift card management system to proceed with the financial process to refund the amount.

    interface PaymentIntentRefundAction {
        action: "refundPayment";
        amount: Amount;
        merchantReference?: string;
        transactionId?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    action amount merchantReference? transactionId?

    Properties

    action: "refundPayment"

    Action to execute for the given Payment.

    amount: Amount

    Amount to be refunded. It must be less than or equal to the captured amount.

    merchantReference?: string

    A merchant-defined identifier associated with the Payment to track and reconcile the Payment Intent Action on the merchant's side. For example, an invoice number.

    transactionId?: string

    The identifier of the capture transaction that is associated with the refund action.

    Settings

    Member Visibility

    On This Page

    Properties