JS API Reference
Class: Allocation
payment/allocation.Allocation
Represents a designated sum of money reserved for the purpose of making some particular payments. Allocations are currently purely virtual objects. An Allocation is connected to a payment account (wallet) specified by address and payment platform field.
Table of contents
Constructors
Properties
Constructors
constructor
• new Allocation(model
): Allocation
Parameters
Name | Type |
---|---|
model | Allocation |
Returns
Defined in
Properties
id
• Readonly
id: string
Allocation ID
Defined in
timestamp
• Readonly
timestamp: string
Timestamp of creation
Defined in
timeout
• Optional
Readonly
timeout: string
Timeout
Defined in
address
• Readonly
address: string
Address of requestor
Defined in
paymentPlatform
• Readonly
paymentPlatform: string
Payment platform
Defined in
totalAmount
• Readonly
totalAmount: string
Total allocation Amount
Defined in
spentAmount
• Readonly
spentAmount: string
The amount that has been already spent
Defined in
remainingAmount
• Readonly
remainingAmount: string
The amount left for spending