Ledger overview
This is the very first point to enter into the banking ecosystem.
Ledgers are mandatory to create Cards, Send money and Receive money.
You will have the possibility to chose the type and the country of the Ledger, among the following :
EUR_BELGIUM
Here is the Ledger structure :
| Name | Type | Description |
|---|---|---|
| id | string (uuid) | The unique identifier for the account. |
| endUserId | string (uuid) | The unique identifier for the associated end-user. |
| friendlyName | string | A user-friendly name for the account. |
| status | string | The current status of the account. Enum: ACTIVE, CLOSED, CREATED, SUSPENDED, PENDING. |
| currency | string | The currency of the account. Enum: EUR, GBP, USD, PLN, AUD, CHF, CAD, SEK, NOK, JPY, HUF, HKD, NZD, CZK, SGD, RON, HRK. |
| country | string | The country associated with the account. Enum: ESTONIA, FRANCE, GREAT_BRITAIN, LITHUANIA, USA. |
| totalAmount | number | The total amount in the account. |
| availableAmount | number | The available amount in the account. |
| reservedAmount | number | The reserved amount in the account. |
| creationDate | string (date-time) | The date and time when the account was created. |
| updateDate | string (date-time) | The date and time when the account was last updated. |
| isUpgraded | boolean | Indicates whether the account is upgraded. When inactive, no external banking information will be returned. Assign an account number to enable the fields. |
| iban | string | The International Bank Account Number of the account. |
| bicOrSwift | string | The BIC or SWIFT code of the account. |
| accountNumber | string | The account number. |
| sortCode | string | The sort code for the account. |
| routingNumber | string | The routing number for the account. |
Each Ledger has a isUpgraded parameter :
- When
false, no external banking information will be returned (such as Account Number and BIC or Swift). The ledger can't be used to Send Money to a Beneficiary or to Receive Money from an external account. The Ledger can only be used for inter-ledger transactions. - When
true, external banking information are displayed. The ledger can be used for all type of transactions.
Virtual Ledgers
Description coming soon