PaymentMethod
PaymentMethod
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: '' }) @Column({ default: '' }) code: string;
description: LocaleString;
@OneToMany(type => PaymentMethodTranslation, translation => translation.base, { eager: true }) @OneToMany(type => PaymentMethodTranslation, translation => translation.base, { eager: true })
translations: Array<Translation<PaymentMethod>>;
@Column() @Column() enabled: boolean;
@Column('simple-json', { nullable: true }) @Column('simple-json', { nullable: true }) checker: ConfigurableOperation | null;
@Column('simple-json') @Column('simple-json') handler: ConfigurableOperation;
@ManyToMany(type => Channel) @JoinTable() @ManyToMany(type => Channel)
@JoinTable()
channels: Channel[];
@Column(type => CustomPaymentMethodFields) @Column(type => CustomPaymentMethodFields)
customFields: CustomPaymentMethodFields;
}
Extends
Implements
- Translatable
- ChannelAware
- HasCustomFields
Members
constructor
method
type:
(input?: DeepPartial<PaymentMethod>) => PaymentMethod
name
property
type:
LocaleString
code
property
type:
string
description
property
type:
LocaleString
translations
property
type:
Array<Translation<PaymentMethod>>
enabled
property
type:
boolean
checker
property
type:
ConfigurableOperation | null
handler
property
type:
ConfigurableOperation
channels
property
type:
Channel[]
customFields
property
type:
CustomPaymentMethodFields