Payment
Payment
A Payment represents a single payment transaction and exists in a well-defined state defined by the PaymentState type.
Signature
class Payment extends VendureEntity {
constructor(input?: DeepPartial<Payment>)
@Column() @Column() method: string;
@Money() @Money() amount: number;
@Column('varchar') @Column('varchar') state: PaymentState;
@Column({ type: 'varchar', nullable: true }) @Column({ type: 'varchar', nullable: true })
errorMessage: string | undefined;
@Column({ nullable: true }) @Column({ nullable: true })
transactionId: string;
@Column('simple-json') @Column('simple-json') metadata: PaymentMetadata;
@Index() @ManyToOne(type => Order, order => order.payments) @Index()
@ManyToOne(type => Order, order => order.payments)
order: Order;
@OneToMany(type => Refund, refund => refund.payment) @OneToMany(type => Refund, refund => refund.payment)
refunds: Refund[];
}
Extends
Members
constructor
method
type:
(input?: DeepPartial<Payment>) => Payment
method
property
type:
string
amount
property
type:
number
state
property
type:
PaymentState
errorMessage
property
type:
string | undefined
transactionId
property
type:
string
metadata
property
type:
PaymentMetadata
order
property
type:
Order
refunds
property
type:
Refund[]