Interface PaymentMethod

interface PaymentMethod {
    businessUnit?: BusinessUnitKeyReference;
    createdAt: string;
    createdBy?: CreatedBy;
    custom?: CustomFields;
    customer?: CustomerReference;
    default: boolean;
    id: string;
    interfaceAccount?: string;
    key?: string;
    lastModifiedAt: string;
    lastModifiedBy?: LastModifiedBy;
    method?: string;
    name?: LocalizedString;
    paymentInterface?: string;
    paymentMethodStatus: PaymentMethodStatus;
    token?: PaymentMethodToken;
    version: number;
}

Hierarchy (View Summary)

Properties

businessUnit? createdAt createdBy? custom? customer? default id interfaceAccount? key? lastModifiedAt lastModifiedBy? method? name? paymentInterface? paymentMethodStatus token? version

Properties

Optional ReadonlybusinessUnit

businessUnit?: BusinessUnitKeyReference

Reference to a BusinessUnit associated with the PaymentMethod.

Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.

ReadonlycreatedAt

createdAt: string

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

Optional ReadonlycreatedBy

createdBy?: CreatedBy

IDs and references that created the PaymentMethod.

Optional Readonlycustom

custom?: CustomFields

Custom Fields of the PaymentMethod.

Optional Readonlycustomer

customer?: CustomerReference

Reference to a Customer associated with the PaymentMethod.

If `businessUnit` is set, the Customer is an [Associate](ctp:api:type:Associate) of the Business Unit.

Readonlydefault

default: boolean

Indicates if the PaymentMethod is the default.

The default applies per Customer, Business Unit, or the combination of both (Associate).

Readonlyid

id: string

Unique identifier of the PaymentMethod.

Optional ReadonlyinterfaceAccount

interfaceAccount?: string

Account or instance of the payment interface when multiple accounts are used (per interface).

Optional Readonlykey

key?: string

User-defined unique identifier of the PaymentMethod.

ReadonlylastModifiedAt

lastModifiedAt: string

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

Optional ReadonlylastModifiedBy

lastModifiedBy?: LastModifiedBy

IDs and references that last modified the PaymentMethod.

Optional Readonlymethod

method?: string

Payment Method used for the Payment—for example, a credit card or direct debit.

Optional Readonlyname

name?: LocalizedString

Name of the PaymentMethod.

Optional ReadonlypaymentInterface

paymentInterface?: string

Payment service that processes the Payment—for example, a PSP.

ReadonlypaymentMethodStatus

paymentMethodStatus: PaymentMethodStatus

Status of the PaymentMethod.

Optional Readonlytoken

token?: PaymentMethodToken

Tokenized representation of the PaymentMethod used by the payment interface.

Readonlyversion

version: number

Current version of the PaymentMethod.

Settings

Member Visibility

On This Page

Properties