Get a pool account by ID
GET
/pool-accounts/{poolAccountId}Returns full details for a single pool account by its external poolAccountId, scoped to the company in the companyId header. Includes account managers and the balance/top-up, low-balance alert, and spend-control configuration.
Path parameters
poolAccountIdstringrequiredExample
ACcsifpt46hpqrh3
Header parameters
companyIdstringrequiredID of the company to filter records
x-api-keystringrequiredPlease provide a valid API Key
Response
| Field | Type | Description |
|---|---|---|
id | string | |
accountName | string | |
status | string | |
currency | string | |
topupType | string | |
allowedMaxBalance | number | |
lowBalanceNotificationActive | boolean | |
lowBalanceNotificationAmount | number | |
companyName | string | |
createdAt | string | |
createdBy | object | |
userId | string | |
name | string | |
accountManagers | object[] | |
userId | string | |
name | string | |
email | string | |
topupConfiguration | object | |
topupType | string | |
topupSourceDetails | object | |
autoTopupEnabled | boolean | |
autoTopupThreshold | number | |
autoTopupAmount | number | |
frequency | string | |
balanceAndTopupConfiguration | object | |
topupSource | string | |
autoTopupEnabled | boolean | |
autoTopupThreshold | number | |
autoTopupAmount | number | |
lowBalanceAlertConfiguration | object | |
alertThresholdAmount | number | |
notificationRecipients | object[] | |
spendControls | object | |
maxBalance | number | |
currency | string | |
limits | object[] |
13 nested fields
topupConfiguration.topupSourceDetails.sourceId | string | |
topupConfiguration.topupSourceDetails.sourceType | string | |
lowBalanceAlertConfiguration.notificationRecipients[].userId | string | |
lowBalanceAlertConfiguration.notificationRecipients[].name | string | |
lowBalanceAlertConfiguration.notificationRecipients[].email | string | |
spendControls.limits[].name | string | |
spendControls.limits[].limitType | string | |
spendControls.limits[].maxAmount | number | |
spendControls.limits[].minAmount | number | |
spendControls.limits[].currency | string | |
spendControls.limits[].period | string | |
spendControls.limits[].channelScope | string | |
spendControls.limits[].frequency | number |
Errors
400Bad Request
Every error carries an errors[] array and a meta.request_id. See Errors for the full envelope.