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

NameType
modelAllocation

Returns

Allocation

Defined in

src/payment/allocation.ts:41

Properties

id

Readonly id: string

Allocation ID

Defined in

src/payment/allocation.ts:18


timestamp

Readonly timestamp: string

Timestamp of creation

Defined in

src/payment/allocation.ts:21


timeout

Optional Readonly timeout: string

Timeout

Defined in

src/payment/allocation.ts:24


address

Readonly address: string

Address of requestor

Defined in

src/payment/allocation.ts:27


paymentPlatform

Readonly paymentPlatform: string

Payment platform

Defined in

src/payment/allocation.ts:30


totalAmount

Readonly totalAmount: string

Total allocation Amount

Defined in

src/payment/allocation.ts:33


spentAmount

Readonly spentAmount: string

The amount that has been already spent

Defined in

src/payment/allocation.ts:36


remainingAmount

Readonly remainingAmount: string

The amount left for spending

Defined in

src/payment/allocation.ts:39