Get Accounts
GET{baseUrl}/be/api/v1/accounts
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| accountType | String | No | Return accounts matching this account type. |
| userId | Integer | No | Return accounts belonging to this user ID. |
| shownMyAccounts | Boolean | No | If true, only return accounts of the logged-in SaaS user. |
| thirdPartyConfigSlug | String | No | Filter by third-party configuration slug. |
| currencyCode | String | No | Filter by currency code (e.g., AED). |
| transactionType | String | No | Filter by transaction type. |
Response
| Field | Type | Description |
|---|---|---|
| data | Array | List of account objects (same shape as Create Account response). |
| pagination | Object | { currentPage, perPage, totalPages, totalCount, sort }. |
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
}
],
"pagination": {
"currentPage": 1,
"perPage": 20,
"totalPages": 1,
"totalCount": 1,
"sort": "id: DESC"
}
}