An Account represents a financial entity that can hold and manage funds. Accounts can be created for operations or trading. Each account has specific attributes and statuses that define its state and functionality.
Once an Account is created, it can:
- Receive funds from various sources.
- Send funds to other accounts or beneficiaries.
- Transfer funds between different accounts within the system.
- Execute sell transactions in supported currencies.
| Attribute | Description | Format |
|---|---|---|
| id | Unique identifier of the Account. | UUID e.g. 27bb9d34-b78d-464a-873e-b87516451be0 |
| groupAccountId | Identifier for the group account, if applicable. | UUID e.g. 27bb9d34-b78d-464a-873e-b87516451be0 |
| createdBy | Identifier of who created the account. | String e.g. user123 |
| createdDateTime | Date of creation of the account. | Timestamp in the ISO 8601 standard. e.g. 2025-01-01T00:00:00.000000Z |
| tenantId | Identifier of the tenant. | UUID e.g. 27bb9d34-b78d-464a-873e-b87516451be0 |
| merchantId | Identifier of the merchant. | UUID e.g. 27bb9d34-b78d-464a-873e-b87516451be0 |
| name | Name of the account. | String e.g. Euro Account |
| availableBalance | Available balance for usage in the account. | Monetary value consisting of value and currency e.g. 100.00, EUR |
| actualBalance | Actual balance in the account. | Monetary value consisting of value and currency e.g. 100.00, EUR |
| status | Status of the account. | PENDING, ACTIVE, CLOSED, SUSPENDED, FAILED, BLOCKED |
| type | Currency type of the account. | FIAT, CRYPTO |
| accountFor | Purpose of the account. | OPERATIONS, TRADING |
| network | Network associated with the account, if applicable. | BITCOIN, ETHEREUM, TRON, SOLANA, RIPPLE, CARDANO, CCHAIN, BSC, POLKADOT, LITECOIN |
| bankDetails | Bank details associated with the account, if applicable. | JSON object |
| walletDetails | Wallet details associated with the account, if applicable. | JSON object |
| simpleMode | Indicates if the account is in simple mode. | Boolean e.g. true, false |