ListProfileBalances
GET
https://test.api.neotek.sa/single-api-aggregator/v1/profiles/balancesSandbox URL · in Production call https://api.neotek.sa
Returns the current balance for every account across all the customer's linked banks in one call, with the balance type and an as-of timestamp for each.
Query parameters:
| Parameter | Required | Description |
|---|---|---|
PSUId | Required | the Payment Service User id: the identifier you assign to the customer in your own system. Use the same id you sent when creating the accounts link, since that is how Neotek resolves which consented accounts to return |
PSUId is the only required parameter. Everything else is optional:
| Parameter | Filters by |
|---|---|
ProfileId | profile |
AccountsLinkId | one consent/link |
FinancialInstitutionId | one bank (BIC) |
FinancialInstitutionName | bank name |
AccountId | one account |
BalanceType | e.g. KSAOB.InterimAvailable |
Currency | currency |
BalanceAmountType | amount type |
FromAmount / ToAmount | amount range |
Page | page number |
An optional x-request-id header is also supported.
cURL
curl -G 'https://test.api.neotek.sa/single-api-aggregator/v1/profiles/balances' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -d 'PSUId=PTP100'Response (trimmed to one balance)
JSON
{ "Data": { "Balances": [ { "ProfileId": "SINGLEAPI", "AccountsLinkId": "2603", "FinancialInstitution": { "FinancialInstitutionId": "SAIBCSARI", "NameEn": "The Saudi Investment Bank" }, "AccountId": "ACC-070", "CreditDebitIndicator": "KSAOB.Credit", "Type": "KSAOB.InterimAvailable", "DateTime": "2026-07-29T07:18:43+03:00", "Amount": { "Amount": 100009.0000, "Currency": "SAR" } } ] }, "Meta": { "PageNumber": 1, "TotalPages": 1 }}Errors
| Scenario | Status | Code | Message |
|---|---|---|---|
| Missing required param | 400 | NTSP.ERROR.400.090 | One or more required API parameters are missing in the API request. |
| Invalid enum value | 400 | NTSP.ERROR.400.901 | Backend Invalid Request Body |
| Invalid/expired token | 401 | NTSP.ERROR.401.001 | Cannot pass the security checks that are required by the target API or operation… |
| No Authorization header | 401 | NTSP.ERROR.401.001 | Invalid client id or secret. |
| Wrong method | 405 | null | The method is not allowed for the requested URL |