@gradientedge/commercetools-utils
    Preparing search index...

    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)

    Index

    Properties

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

    Properties

    businessUnit?: BusinessUnitKeyReference

    Reference to a BusinessUnit associated with the PaymentMethod.

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

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

    createdBy?: CreatedBy

    IDs and references that created the PaymentMethod.

    custom?: CustomFields

    Custom Fields of the PaymentMethod.

    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.
    default: boolean

    Indicates if the PaymentMethod is the default.

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

    Unique identifier of the PaymentMethod.

    interfaceAccount?: string

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

    key?: string

    User-defined unique identifier of the PaymentMethod.

    lastModifiedAt: string

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

    lastModifiedBy?: LastModifiedBy

    IDs and references that last modified the PaymentMethod.

    method?: string

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

    name?: LocalizedString

    Name of the PaymentMethod.

    paymentInterface?: string

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

    paymentMethodStatus: PaymentMethodStatus

    Status of the PaymentMethod.

    token?: PaymentMethodToken

    Tokenized representation of the PaymentMethod used by the payment interface.

    version: number

    Current version of the PaymentMethod.

    Settings

    Member Visibility

    On This Page

    Properties