@acceleratxr/core_sdk / Payment
Class: Payment#
Tracks the lifecycle of a payment for a given customer.
REQUIRES: Purchasing Services
author Jean-Philippe Steinmetz info@acceleratxr.com
Hierarchy#
-
↳ Payment
Index#
Constructors#
Properties#
Accessors#
Constructors#
constructor#
+ new Payment(other?: any): Payment
Overrides EntityBase.constructor
Defined in src/models/Payment.ts:85
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Payment
Properties#
amount#
• amount: number = 0
Defined in src/models/Payment.ts:45
The amount of the payment to be made.
confirmation#
• Optional confirmation: undefined | string = undefined
Defined in src/models/Payment.ts:55
The digital confirmation code that was received from the payment processor.
currency#
• currency: Currency = Currency.USD
Defined in src/models/Payment.ts:50
The form of currency pertaining to the price.
data#
• data: any
Defined in src/models/Payment.ts:60
Custom data to store about this payment.
dateCreated#
• dateCreated: Date = new Date()
Inherited from EntityBase.dateCreated
Defined in src/EntityBase.ts:18
The date and time that the object was created.
dateModified#
• dateModified: Date = new Date()
Inherited from EntityBase.dateModified
Defined in src/EntityBase.ts:23
The date and time that the object was last modified.
offline#
• offline: boolean = false
Defined in src/models/Payment.ts:65
Indicates that the payment will be made when the customer is offline.
orderUid#
• Optional orderUid: undefined | string = undefined
Defined in src/models/Payment.ts:70
The optional unique identifier of the order that the payment is being made for.
provider#
• provider: ProviderType = ProviderType.NULL
Defined in src/models/Payment.ts:75
The backend provider that will process this payment.
status#
• status: PaymentStatus = PaymentStatus.CREATED
Defined in src/models/Payment.ts:80
The current status of the payment.
uid#
• uid: string = uuid.v4()
Inherited from EntityBase.uid
Defined in src/EntityBase.ts:13
The universally unique identifier of the object.
version#
• version: number = 0
Inherited from EntityBase.version
Defined in src/EntityBase.ts:28
The optimistic locking version of the object.
walletUid#
• walletUid: string = “”
Defined in src/models/Payment.ts:85
The unique identifier of the wallet that the payment was made with.
Accessors#
ClassName#
• Staticget ClassName(): string
Defined in src/models/Payment.ts:40
Returns: string