Typescript SDK Type Docs
    Preparing search index...

    Interface PaymentIntentCancelAction

    Requests to cancel the authorization for a Payment. Checkout will cancel the Payment and will request the PSP or gift card management system to proceed with the financial process to cancel the authorization.

    You cannot request to cancel the authorization for a Payment that has already been [captured](/payments-lifecycle#payment-capture).
    
    interface PaymentIntentCancelAction {
        action: "cancelPayment";
        merchantReference?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    action: "cancelPayment"

    Action to execute for the given Payment.

    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.