Ledger Creation

Prerequisite

Before creating a Ledger, you must have an active Enduser (Consumer or Corporate), with KYC/KYB in a validated status.

Creation

Create the Ledger with the "Create a Ledger" endpoint. Ledger will be owned by the End User identified in endUserId. If an End User is authenticated, endUserId will be automatically his own id. Currency and Country of the Ledger will be defined according to the type. You can give to the ledger a friendlyName which is a custom name or a reference.

Friendly name must be unique for each enduser

Request Body schema: application/json
endUserId
string <uuid>

The id of the end-user, can be a consumer or corporate. Mandatory if not authenticated as end-user.

type
required
string
Enum: "EUR_LITHUANIA" "EUR_FRANCE" "USD_USA" "GBP_GREAT_BRITAIN"
friendlyName
string [ 0 .. 255 ] characters
autoUpgrade
boolean

If true, this ledger will be automatically upgraded once activated.

application/json
{
  • "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
  • "type": "EUR_LITHUANIA",
  • "friendlyName": "string",
  • "autoUpgrade": true
}
Response will contains the id of the created Ledger.The Ledger which have been created has a parameter isUpgraded set to false. This means that it can only be used for inter-ledger transactions.

To enable banking features such as Send Money to a Beneficary or Receive Money, you have to Upgrade this Ledger.

You also have the possibility to auto-upgrade the ledger upon its creation. To do so, set the autoUpgrade parameter to truewhen creating the Ledger.

Upgrade

To upgrade a Ledger and enable Account number (IBAN) availability, use the "Upgrade a ledger" Endpoint. This activate the banking transactions features (isUpgraded: true): See Ledger Overview for details.

Then, IBAN or Account Number will now be displayed in the Ledger informations :

Copy
Copied
{
"enduserId": "9ab4bbb7-d151-4ce7-92cf-6afee623c3c6",
"friendlyName": "My Ledger",
"status": "ACTIVE",
"currency": "EUR",
"country": "LITHUANIA",
"amount": 0,
"currentAmount": 0,
"reservedAmount": 0,
"creationDate": "2022-01-01T12:35:59.071203",
"updateDate": "2022-01-01T12:45:34.520988",
"isUpgraded": "true",
"iban": "LT32398093123456789",
"bicOrSwift": "UAPALT22"
}

Update

A Ledger can be updated.
The only possible update is the friendlyName.