Accounts
Accounts are at the heart of the Layer2 platform. They are the core book of record for a customers financial transactions and are backed by a complex set of double-entry ledgers. An account has to belong to a customer and its behaviour is determined by a combination of the Product and Asset Types.
We have 3 types of accounts : Fiat Deposit, Crypto Deposit and Crypto Payment. Click here to learn more about the various product types, supported assets, and operations.
A single account can only hold a single asset (e.g. ETH, USDC-ETH, BTC, USD). Today we support various fiat and crypto currencies.
Status
The field status is informs what state the account is in and how it can be used.
Rules
Each status enforces rules as to what actions can be performed on a account.
- Read - is the account information visible.
- Update - can the account information / status be updated.
- Transact - can a account send/receive fund.
Possible next status
A account is limited by what status it can be set to based on their current status. E.g. a account in FROZEN cannot be set to PENDING.
| Status | Description | Rules | Possible Next Status |
|---|---|---|---|
ACTIVE |
Account is fully operational. | Read ✅ Update ✅ Transact ✅ |
EDD, DORMANT, CLOSED, FROZEN |
CLOSED |
Account is not operational. A account cannot be updated from Closed status. | Read ✅ Update 🚫 Transact 🚫 |
No possible next status |
EDD |
Account requires enhanced due dilligence. Account is still operational. | Read ✅ Update ✅ Transact ✅ |
ACTIVE, CLOSED, FROZEN |
PENDING |
Account is being AML checked. | Read ✅ Update ✅ Transact 🚫 |
ACTIVE, CLOSED |
FROZEN |
Account is not operational until due dilligence checks are made. | Read ✅ Update ✅ Transact 🚫 |
ACTIVE, CLOSED, EDD |
DORMANT |
Account is operational but has not been used in 12 months. | Read ✅ Update ✅ Transact ✅ |
ACTIVE, CLOSED, EDD |
Layer2 Statuses
-> Statuses may have 'l2f' after the status e.g.PENDING_L2F. This means that the account requires action by Layer2. Accounts in these statuses can only be updated by Layer2.
Fiat deposit accounts
Opening accounts
To open fiat deposit accounts, you will need to use the accounts/deposits endpoint and pass in one of the fiat product types and asset ids.
Get account info and balance
To get information on the account, including total and available balance, you will need to use the accounts/deposits/{account_id} endpoint.
Available balance refers to the funds available to withdraw, exchange, transfer. It is net of any pending or authorized transactions. Total balance refers to all the funds in the account, including any pending and authorized transactions.
Get transactions
To get the list of transactions that have occured on this account, you will need to use the accounts/deposits/{account_id}/transactions endpoint. You can filter the transactions by start date, end date and a # of other query parameters.
If you know the id of a specific transaction, you can retrieve it by using the accounts/deposits/{account_id}/transactions/{transaction_id} endpoint
Get list of all accounts
To get the full list of accounts, either for all customers or a specific customer, use the accounts/deposits endpoint.
Crypto deposit accounts
Opening accounts
To open crypto deposit accounts, you will need to use the accounts/deposits endpoint and pass in one of the crypto product types and asset ids.
Get account info and balance
To get information on the account, including total and available balance, you will need to use the accounts/deposits/{account_id} endpoint
Available balance refers to the funds available to withdraw, exchange, transfer. It is net of any pending or authorized transactions. Total balance refers to all the funds in the account, including any pending and authorized transactions.
Get transactions
To get the list of transactions that have occured on this account, you will need to use the accounts/deposits/{account_id}/transactions endpoint. You can filter the transactions by start date, end date and a # of other query parameters.
If you know the id of a specific transaction, you can retrieve it by using the accounts/deposits/{account_id}/transactions/{transaction_id} endpoint
Get list of all accounts
To get the full list of accounts, either for all customers or a specific customer, use the accounts/deposits endpoint.
Crypto payment gateway accounts
Opening accounts
The crypto payment gateway accounts are opened a bit differently than the crypto/fiat deposit accounts.
To open crypto payment accounts, you will need to use the accounts/payments endpoint.
Get account info and balance
To get information on the account, including total and available balance, you will need to use the accounts/payments/{account_id} endpoint
Available balance refers to the funds available to withdraw, exchange, transfer. It is net of any pending or authorized transactions. Total balance refers to all the funds in the account, including any pending and authorized transactions.
Get transactions
To get the list of transactions that have occured on this account, you will need to use the accounts/payments/{account_id}/transactions endpoint. You can filter the transactions by start date, end date and a # of other query parameters.
If you know the id of a specific transaction, you can retrieve it by using the accounts/deposits/{account_id}/transactions/{transaction_id} endpoint.
Get list of all accounts
To get the full list of accounts, either for all customers or a specific customer, use the accounts/payments endpoint.