interface PaymentDraft {
    amountAuthorized?: _Money;
    amountPaid?: _Money;
    amountPlanned: _Money;
    amountRefunded?: _Money;
    anonymousId?: string;
    authorizedUntil?: string;
    custom?: CustomFieldsDraft;
    customer?: CustomerResourceIdentifier;
    externalId?: string;
    interfaceId?: string;
    interfaceInteractions?: CustomFieldsDraft[];
    key?: string;
    paymentMethodInfo?: PaymentMethodInfo;
    paymentStatus?: PaymentStatusDraft;
    transactions?: TransactionDraft[];
}

Properties

amountAuthorized?: _Money

Deprecated because the value can be calculated from the total amounts saved in the Transactions.

amountPaid?: _Money

Deprecated because the value can be calculated from the total amounts saved in the Transactions.

amountPlanned: _Money

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

amountRefunded?: _Money

Deprecated because the value can be calculated from the total amounts saved in the Transactions.

anonymousId?: string

Anonymous session associated with the Payment.

authorizedUntil?: string

Deprecated because this field is of little practical value, as it is either not reliably known, or the authorization time is fixed for a PSP.

Custom Fields for the Payment.

Reference to a Customer associated with the Payment.

externalId?: string

Additional identifier for external systems like Customer Relationship Management (CRM) or Enterprise Resource Planning (ERP).

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. Once set, it cannot be changed.

interfaceInteractions?: CustomFieldsDraft[]

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 for the Payment.

paymentMethodInfo?: PaymentMethodInfo

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

paymentStatus?: PaymentStatusDraft

Current status of the Payment.

transactions?: TransactionDraft[]

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

Generated using TypeDoc