Typescript SDK Type Docs
    Preparing search index...

    Interface OrderPaymentRemovedMessagePayload

    Generated after a successful Remove Payment update action or when a Payment is removed via Order Edits.

    interface OrderPaymentRemovedMessagePayload {
        paymentRef: PaymentReference;
        removedPaymentInfo: boolean;
        type: "OrderPaymentRemoved";
    }

    Hierarchy (View Summary)

    Index

    Properties

    paymentRef removedPaymentInfo type

    Properties

    paymentRef: PaymentReference

    Payment that was removed from the Order.

    removedPaymentInfo: boolean

    Indicates whether the removal of the Payment resulted in no Payments remaining on the Order. The value is true if all Payments have been removed (none remain), and false if there are still Payments associated with the Order after the removal.

    type: "OrderPaymentRemoved"

    Settings

    Member Visibility

    On This Page

    Properties