Get pool account by id
GET
/public/v1/erp/pool_accounts/{poolAccountId}Retrieve one pool account with its full funding and control configuration.
Returns a single pool account. The payload is the list entry plus how the account is topped up, the balance thresholds that trigger an automatic top-up, who is alerted when the balance runs low, and the spend controls applied to cards funded by it.
Path parameters
poolAccountIdstringrequiredthe account identifier.
Response
One pool account object. All list fields, plus:
| Field | Type | Description |
|---|---|---|
topup_configuration | object | { topup_type, auto_topup_enabled, auto_topup_amount, topup_frequency } |
balance_and_topup_configuration | object | { topup_source, auto_topup_enabled, auto_topup_threshold, auto_topup_amount } |
low_balance_alert_configuration | object | { alert_threshold_amount, notification_recipients } |
spend_controls | object | Spend limits applied to cards on this account |
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 | |
spend_controls | 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 | |
topup_configuration | object | |
topup_type | string | |
auto_topup_enabled | boolean | |
auto_topup_amount | string | |
topup_frequency | string | |
balance_and_topup_configuration | object | |
topup_source | string | |
auto_topup_enabled | boolean | |
auto_topup_threshold | string | |
auto_topup_amount | string | |
low_balance_alert_configuration | object | |
alert_threshold_amount | string | |
notification_recipients | object[] | |
meta | object | |
request_id | string | |
timestamp | string |
6 nested fields
data.low_balance_alert_configuration.notification_recipients[].id | string | |
data.low_balance_alert_configuration.notification_recipients[].name | string | |
data.low_balance_alert_configuration.notification_recipients[].label | string | |
data.low_balance_alert_configuration.notification_recipients[].code | string | |
data.low_balance_alert_configuration.notification_recipients[].erp_internal_id | string | |
data.low_balance_alert_configuration.notification_recipients[].erp_code | string |
Errors
401, 403, 404.
401Unauthorized - missing or invalid Bearer token404Not Found
Every error carries an errors[] array and a meta.request_id. See Errors for the full envelope.