Interface PaymentDraft

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

Properties

amountPlanned anonymousId? custom? customer? interfaceId? interfaceInteractions? key? paymentMethodInfo? paymentStatus? transactions?

Properties

ReadonlyamountPlanned

amountPlanned: _Money

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

Optional ReadonlyanonymousId

anonymousId?: string

Anonymous session associated with the Payment.

Optional Readonlycustom

custom?: CustomFieldsDraft

Custom Fields for the Payment.

Optional Readonlycustomer

customer?: CustomerResourceIdentifier

Reference to a Customer associated with the Payment.

Optional ReadonlyinterfaceId

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.

Optional ReadonlyinterfaceInteractions

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.

Optional Readonlykey

key?: string

User-defined unique identifier for the Payment.

Optional ReadonlypaymentMethodInfo

paymentMethodInfo?: PaymentMethodInfo

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

Optional ReadonlypaymentStatus

paymentStatus?: PaymentStatusDraft

Current status of the Payment.

Optional Readonlytransactions

transactions?: TransactionDraft[]

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

Settings

Member Visibility

On This Page

Properties