This section provides documentation for essential API calls that retrieve lists of accounts and details for individual accounts. By following these guidelines, you can effectively retrieve and utilize financial data to power your applications and services.
| Panel | ||
|---|---|---|
| ||
Get a List of Accounts |
To retrieve a comprehensive list of accounts associated with a customer, you can use the following API call:
...
CustomerId: The unique identifier of the customer.
| Panel | ||
|---|---|---|
| ||
Request Headers |
...
Authorization: Bearer {access_token}Content-Type: application/json
| Panel | ||
|---|---|---|
| ||
Response |
...
| Code Block | ||
|---|---|---|
| ||
{
"value": {
"pageData": {
"pageNumber": 1,
"pageCount": 1,
"pageSize": 50,
"hasNextPage": false,
"hasPreviousPage": false,
"firstItemOnPage": 1,
"lastItemOnPage": 16,
"totalItemCount": 16
},
"record": [
{
"accountId": "c3c0851b-cf46-4da2-a52b-24a221b991ca",
"accountName": "simi Gold",
"availableBalance": "867,940.15",
"ledgerBalance": "864,996.25",
"freezeRemarks": null,
"currencyCode": "GBP",
"currencyId": "1082ECB0-AC29-4A06-B8AD-7BC866C268AD",
"rateByPassThresholdAmount": 10000,
"isPrimary": false,
"status": "Active",
"accountExitStatus": null,
"systemAccountType": "CustomerAccount",
"accountDetails": [
{
"accountNumber": "GB11LEAT04069100007307",
"bankCountry": "United Kingdom of Great Britain and Northern Ireland",
"bankCountryIso": "GB",
"bankName": "ClearBank Ltd",
"bankAddress": null,
"paymentMethodType": "BicSwift",
"paymentMethodValue": "LEATGB22XXX",
"transitNumber": "",
"institutionCode": ""
},
{
"accountNumber": "00007307",
"bankCountry": "United Kingdom of Great Britain and Northern Ireland",
"bankCountryIso": "GB",
"bankName": "ClearBank Ltd",
"bankAddress": null,
"paymentMethodType": "SortCode",
"paymentMethodValue": "040691",
"transitNumber": "",
"institutionCode": ""
}
],
"id": "c3c0851b-cf46-4da2-a52b-24a221b991ca",
"dateAdded": "2023-05-22T14:53:15.2313269",
"dateModified": "2024-06-27T08:16:25.4701998"
},
]
},
"isSuccess": true,
"error": "",
"message": null,
"responseCode": null
} |
| Panel | ||
|---|---|---|
| ||
Get a Single Account Details |
To retrieve detailed information for a specific account, use the following API call:
...
accountId: The unique identifier of the account.
| Panel | ||
|---|---|---|
| ||
Request Headers |
...
Authorization: Bearer {access_token}Content-Type: application/json(if required)
| Panel | ||
|---|---|---|
| ||
Response |
...
| Code Block |
|---|
{
"isSuccess": true,
"error": "string",
"message": "string",
"responseCode": "string",
"value": {
"accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"accountDetails": [
{
"accountNumber": "string",
"bankCountry": "string",
"bankCountryIso": "string",
"bankName": "string",
"bankAddress": "string",
"paymentMethodType": "string",
"paymentMethodValue": "string",
"transitNumber": "string",
"institutionCode": "string"
}
]
}
} |
...