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

    Interface PaymentMethodDraft

    interface PaymentMethodDraft {
        businessUnit?: BusinessUnitResourceIdentifier;
        custom?: CustomFieldsDraft;
        customer?: CustomerResourceIdentifier;
        default?: boolean;
        interfaceAccount?: string;
        key?: string;
        method?: string;
        name?: LocalizedString;
        paymentInterface?: string;
        paymentMethodStatus?: PaymentMethodStatus;
        token?: PaymentMethodToken;
    }
    Index

    Properties

    businessUnit? custom? customer? default? interfaceAccount? key? method? name? paymentInterface? paymentMethodStatus? token?

    Properties

    businessUnit?: BusinessUnitResourceIdentifier

    Reference to a BusinessUnit the PaymentMethod should belong to.

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

    Custom Fields for the PaymentMethod.

    customer?: CustomerResourceIdentifier

    Reference to a Customer the PaymentMethod should belong to.

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

    Set to true if the PaymentMethod should be the default.

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

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

    key?: string

    User-defined unique identifier for the PaymentMethod.

    method?: string

    Payment method to use 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.

    Settings

    Member Visibility

    On This Page

    Properties