Retrieve company and card balance
/public/v1/core/cards/balanceCheck how much is available on a specific card, and how much the company holds, in one call.
Returns the company's available balance together with the remaining balance of the cards you identify. Card balances account for pending authorisations, so this is the figure to check before triggering a top-up or approving a purchase: not the last statement closing balance.
You must identify the cards. Send nickname or last_four; this endpoint does not list every
card in the company. status alone is not sufficient and returns 400.
Query parameters
nicknamestringExact card name. Required unless
last_fouris sentExample
testinglast_fourstringLast four digits of the card. Required unless
nicknameis sentstatusstringOptional. Narrow to one card status
Example
activebalanceintegerExample
3
Response
One object.
| Field | Type | Description |
|---|---|---|
company_balance | object | { amount, currency } for the company funding account |
cards[] | array | { card_id, nickname, last_four, status, balance, currency } per matched card |
Response schema from the OpenAPI document
| Field | Type | Description |
|---|---|---|
status_code | integer | |
success | boolean | |
data | object | |
company_balance | object | |
amount | number | |
currency | string | |
cards | object[] | |
card_id | string | |
nickname | string | |
last_four | string | |
status | string | |
balance | integer | |
currency | string | |
meta | object | |
request_id | string | |
timestamp | string |
Errors
400 (neither nickname nor last_four supplied, or an invalid status), 401.
Cards (write)
401Unauthorized - missing or invalid Bearer token
Every error carries an errors[] array and a meta.request_id. See Errors for the full envelope.