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_LITHUANIA"
  • "GBP_GREAT_BRITAIN"

Here is the Ledger structure :

id
required
string <uuid>
endUserId
required
string <uuid>
friendlyName
string
status
required
string
Enum: "ACTIVE" "CLOSED" "CREATED" "SUSPENDED" "PENDING"
currency
required
string
Enum: "EUR" "GBP" "USD" "PLN" "AUD" "CHF" "CAD" "SEK" "NOK" "JPY" "HUF" "HKD" "NZD" "CZK" "SGD" "RON" "HRK"
country
required
string
Enum: "ESTONIA" "FRANCE" "GREAT_BRITAIN" "LITHUANIA" "USA"
totalAmount
required
number
availableAmount
required
number
reservedAmount
required
number
creationDate
required
string <date-time>
updateDate
required
string <date-time>
isUpgraded
required
boolean

When inactive, no external banking information will be returned. Assign an account number to enable the fields.

iban
string
bicOrSwift
string
accountNumber
string
sortCode
string
routingNumber
string
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.