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() method: string;
@Column() amount: number;
@Column('varchar') state: PaymentState;
@Column({ type: 'varchar', nullable: true })
errorMessage: string | undefined;
@Column({ nullable: true })
transactionId: string;
@Column('simple-json') metadata: PaymentMetadata;
@ManyToOne(type => Order, order => order.payments)
order: Order;
@OneToMany(type => Refund, refund => refund.payment)
refunds: Refund[];
}
Extends
Members
constructor
(input?: DeepPartial<Payment>) => Payment
method
string
amount
number
state
PaymentState
errorMessage
string | undefined
transactionId
string
metadata
PaymentMetadata
order
Order
refunds
Refund[]