Developers
qashio.com

Get a pool account by ID

GET/pool-accounts/{poolAccountId}
Bearer token

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

poolAccountIdstringrequired

Example ACcsifpt46hpqrh3

Header parameters

companyIdstringrequired

ID of the company to filter records

x-api-keystringrequired

Please provide a valid API Key

Response

FieldTypeDescription
idstring
accountNamestring
statusstring
currencystring
topupTypestring
allowedMaxBalancenumber
lowBalanceNotificationActiveboolean
lowBalanceNotificationAmountnumber
companyNamestring
createdAtstring
createdByobject
userIdstring
namestring
accountManagersobject[]
userIdstring
namestring
emailstring
topupConfigurationobject
topupTypestring
topupSourceDetailsobject
autoTopupEnabledboolean
autoTopupThresholdnumber
autoTopupAmountnumber
frequencystring
balanceAndTopupConfigurationobject
topupSourcestring
autoTopupEnabledboolean
autoTopupThresholdnumber
autoTopupAmountnumber
lowBalanceAlertConfigurationobject
alertThresholdAmountnumber
notificationRecipientsobject[]
spendControlsobject
maxBalancenumber
currencystring
limitsobject[]
13 nested fields
topupConfiguration.topupSourceDetails.sourceIdstring
topupConfiguration.topupSourceDetails.sourceTypestring
lowBalanceAlertConfiguration.notificationRecipients[].userIdstring
lowBalanceAlertConfiguration.notificationRecipients[].namestring
lowBalanceAlertConfiguration.notificationRecipients[].emailstring
spendControls.limits[].namestring
spendControls.limits[].limitTypestring
spendControls.limits[].maxAmountnumber
spendControls.limits[].minAmountnumber
spendControls.limits[].currencystring
spendControls.limits[].periodstring
spendControls.limits[].channelScopestring
spendControls.limits[].frequencynumber

Errors

  • 400Bad Request

Every error carries an errors[] array and a meta.request_id. See Errors for the full envelope.

This request takes no parameters.

Response

Send the request to see the response.

Esc

Start here

IntroductionIntegration walkthroughAuthenticationConventions

Popular endpoints

POSTExchange code for tokens/oauth2/tokenGETGet company summary/public/v1/erp/company/summaryGETList bank accounts/public/v1/erp/bank_accountsGETList cards/public/v1/erp/cardsGETList chart of accounts/public/v1/erp/chart_of_accounts