Skip to main content

PaymentMethod

PaymentMethod​

@vendure/corepayment-method.entity.ts

A PaymentMethod is created automatically according to the configured PaymentMethodHandlers defined in the PaymentOptions config.

Signature
class PaymentMethod extends VendureEntity implements Translatable, ChannelAware, HasCustomFields {
    constructor(input?: DeepPartial<PaymentMethod>)
    name: LocaleString;
    @Column({ default: '' }) code: string;
    description: LocaleString;
    @OneToMany(type => PaymentMethodTranslation, translation => translation.base, { eager: true })
    translations: Array<Translation<PaymentMethod>>;
    @Column() enabled: boolean;
    @Column('simple-json', { nullable: true }) checker: ConfigurableOperation | null;
    @Column('simple-json') handler: ConfigurableOperation;
    @ManyToMany(type => Channel, channel => channel.paymentMethods)
    @JoinTable()
    channels: Channel[];
    @Column(type => CustomPaymentMethodFields)
    customFields: CustomPaymentMethodFields;
}

constructor​

method
(input?: DeepPartial<PaymentMethod>) => PaymentMethod

name​

property
LocaleString

code​

property
string

description​

property
LocaleString

translations​

property
Array<Translation<PaymentMethod>>

enabled​

property
boolean

checker​

property
ConfigurableOperation | null

handler​

property
ConfigurableOperation

channels​

property
Channel[]

customFields​

property
CustomPaymentMethodFields