interface Payment {
    amountPlanned: CentPrecisionMoney;
    anonymousId?: string;
    createdAt: string;
    createdBy?: CreatedBy;
    custom?: CustomFields;
    customer?: CustomerReference;
    id: string;
    interfaceId?: string;
    interfaceInteractions: CustomFields[];
    key?: string;
    lastModifiedAt: string;
    lastModifiedBy?: LastModifiedBy;
    paymentMethodInfo: PaymentMethodInfo;
    paymentStatus: PaymentStatus;
    transactions: Transaction[];
    version: number;
}

Hierarchy (view full)

Properties

amountPlanned: CentPrecisionMoney

Money value the Payment intends to receive from the customer. The value typically matches the Cart or Order gross total.

anonymousId?: string

Anonymous session associated with the Payment.

createdAt: string

Date and time (UTC) the Payment was initially created.

createdBy?: CreatedBy

IDs and references that created the Payment.

custom?: CustomFields

Custom Fields for the Payment.

customer?: CustomerReference

Reference to a Customer associated with the Payment.

id: string

Unique identifier of the Payment.

interfaceId?: string

Identifier used by the payment service that processes the Payment (for example, a PSP). The combination of interfaceId and the paymentInterface field on PaymentMethodInfo must be unique.

interfaceInteractions: CustomFields[]

Represents information exchange with the payment service, for example, a PSP. An interaction may be a request sent, or a response or notification received from the payment service.

key?: string

User-defined unique identifier of the Payment.

lastModifiedAt: string

Date and time (UTC) the Payment was last updated.

lastModifiedBy?: LastModifiedBy

IDs and references that last modified the Payment.

paymentMethodInfo: PaymentMethodInfo

Information regarding the payment interface (for example, a PSP), and the specific payment method used.

paymentStatus: PaymentStatus

Current status of the Payment.

transactions: Transaction[]

Financial transactions of the Payment. Each Transaction has a TransactionType and a TransactionState.

version: number

Current version of the Payment.