Interface RemovePaymentChange

Change triggered by the following update actions:

- [Remove Payment](ctp:api:type:OrderRemovePaymentAction) on Orders.
- [Remove Payment](ctp:api:type:StagedOrderRemovePaymentAction) on Staged Orders.
interface RemovePaymentChange {
    change: string;
    nextValue: PaymentInfo;
    previousValue: PaymentInfo;
    type: "RemovePaymentChange";
}

Hierarchy (View Summary)

Properties

change nextValue previousValue type

Properties

Readonlychange

change: string

Type of change on a resource that is similar to the update action it relates to, where possible. It is not a unique identifier for the data structure, for example, the setDescription change can occur with a localized and non-localized representation.

[Records](ctp:history:type:Record) can be filtered by this value using the `changes` query parameter.

ReadonlynextValue

nextValue: PaymentInfo

Value after the change.

ReadonlypreviousValue

previousValue: PaymentInfo

Value before the change.

Readonlytype

type: "RemovePaymentChange"

Unique discriminator value to reliably deserialize the data type.

Settings

Member Visibility

On This Page

Properties