Create Account
POST{baseUrl}/be/api/v1/accounts
Payload
| Attribute | Type | Required | Description |
|---|---|---|---|
| userId | Integer | Yes | ID of the user for whom the account is being created. |
| currencyId | Integer | Yes | ID of the currency for the account. |
| accountType | String | Yes | Type of the account to create (e.g., DIGITAL). |
Request Example
{
"userId": 6,
"currencyId": 2,
"accountType": "DIGITAL"
}Response
| Field | Type | Description |
|---|---|---|
| id | Integer | Account ID. |
| userId | Integer | Owner user ID. |
| accountType | String | Account type (e.g., DIGITAL). |
| currencyCode | String | ISO 4217 currency code (e.g., AED). |
| currency | Object | Currency entity: { createdAt, createdBy, updatedAt, updatedBy, id, name, code, isoCode, decimalPoint, type, symbol, icon, status }. |
| accountTitle | String | Account title. |
| accountNumber | String | Account number. |
| balance | Number | Current available balance. |
| balanceOnHold | Number | Amount on hold. |
| totalTransactions | Integer | Null |
| status | String | Account status (e.g., ACTIVE). |
| references | Array | Additional references (if any). |
| iban | String | Null |
| isPrimary | Boolean | Whether this is the user’s primary account. |
| creditLimit | Number | Credit limit for the account, if applicable. |
200 — SUCCESS
{
"data": {
"id": 12,
"userId": 3,
"accountType": "DIGITAL",
"currencyCode": "AED",
"currency": {
"createdAt": "2024-10-07T04:56:49.699+00:00",
"createdBy": null,
"updatedAt": null,
"updatedBy": null,
"id": 2,
"name": "United ARAB EMIRATE",
"code": "AED",
"isoCode": 784,
"decimalPoint": 2,
"type": "FIAT",
"symbol": null,
"icon": null,
"status": true
},
"accountTitle": "VAULTSPAY CUSTOMER",
"accountNumber": "30132278593204",
"balance": 0,
"balanceOnHold": 0,
"totalTransactions": null,
"status": "ACTIVE",
"references": [],
"iban": null,
"isPrimary": true,
"creditLimit": 1000
}
}