List pool accounts
/public/v1/erp/pool_accountsRetrieve the shared funding accounts that multiple cards draw from.
Returns a paginated list of pool accounts, newest first. A pool account holds a shared balance that several cards spend against, with its own top-up settings, maximum balance, low-balance alerting and set of account managers. Company funding accounts, credit accounts and single-card accounts are never returned here.
Query parameters
pageintegerPage number, 1-based. Default
1Example
1page_sizeintegerRecords per page. Default
20Example
20statusstringactive,inactive,terminated, orallto disable the filtermanager_idstringAccounts managed by this user profile
created_bystringAccounts created by this user profile
created_time_fromdateCreation window,
YYYY-MM-DD. Either may be sent alonecreated_time_todateCreation window,
YYYY-MM-DD. Either may be sent alone
Response
Array of pool accounts, plus pagination.
| Field | Type | Description |
|---|---|---|
id | string | Account identifier |
account_name | string | Account name |
status | string | Active, Inactive, Suspended or Terminated |
currency | string | Account currency (ISO 4217) |
topup_type | string | How the account is funded |
allowed_max_balance | number | Maximum balance the account may hold |
low_balance_notification_active | boolean | Low-balance alerting is on |
low_balance_notification_amount | number | Threshold that triggers the alert |
company_name | string | Owning company |
created_by | object | { user_id, name } |
account_managers | array | { user_id, name, email } per manager |
created_at | string | ISO 8601 timestamp |
Response schema from the OpenAPI document
| Field | Type | Description |
|---|---|---|
status_code | integer | |
success | boolean | |
data | object[] | |
id | string | |
account_name | string | |
company_name | string | |
status | string | |
currency | string | |
topup_type | string | |
allowed_max_balance | string | |
low_balance_notification_active | boolean | |
low_balance_notification_amount | string | |
created_at | string | |
created_by | object | |
name | string | |
user_id | string | |
account_managers | object[] | |
id | string | |
name | string | |
label | string | |
code | string | |
erp_internal_id | string | |
erp_code | string | |
meta | object | |
request_id | string | |
timestamp | string | |
pagination | object | |
page | integer | |
page_size | integer | |
total_pages | integer | |
total_records | integer | |
has_next | boolean | |
has_previous | boolean |
Errors
400 (unrecognised status, inverted date range), 401, 403, 404.
401Unauthorized - missing or invalid Bearer token
Every error carries an errors[] array and a meta.request_id. See Errors for the full envelope.