Check balance
Returns the user’s available balance. For COP, USD, and MXN, use GET /balance/ with the currency parameter.
Balance by currency (COP, USD, MXN)
Check Balance
Authorizations
Both
x-api-key and Authorization: Bearer <token> headers are required.Endpoint
GEThttps://dev.backend.colurs.co/balance/Required Headers
Content-Type: application/jsonAccept: application/jsonx-api-key: [API_KEY]Authorization: Bearer [ACCESS_TOKEN]Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| currency | string | Currency: COP, USD, MXN | |
| username | string | Superusers only: check another user |
cURL Example
curl -X GET "https://dev.backend.colurs.co/balance/?currency=COP" \
-H "Authorization: Bearer [ACCESS_TOKEN]" \
-H "x-api-key: [API_KEY]"Response
response.json
{
"balance": "1500000.00",
"currency": "COP",
"available": "1450000.00",
"pending":
"50000.00"}Possible Errors
| Code | Error | Description |
|---|---|---|
| 400 | InvalidCurrency | Invalid or unsupported currency |
| 403 | Forbidden | No permission to query balance |
| 404 | ProfileNotFound | Profile not found |
Colombian Peso
Response:
{
"balance": "1500000.00",
"currency": "COP",
"available": "1450000.00",
"pending": "50000.00"
}Response Fields
| Field | Type | Description |
|---|---|---|
balance | string | Total balance |
currency | string | Currency code |
available | string | Available balance to use |
pending | string | Pending balance awaiting settlement |
💡
The available balance is what you can actually use. Pending includes transactions still in progress.
Supported Currencies
| Code | Currency | Description | Endpoint |
|---|---|---|---|
COP | 🇨🇴 Colombian Peso | Main currency for Colombia | GET /balance/?currency=COP |
USD | 🇺🇸 Dollar | US Dollar | GET /balance/?currency=USD |
MXN | 🇲🇽 Mexican Peso | Mexico | GET /balance/?currency=MXN |
Other Related Endpoints
Movements (Send, Receive, Reload, Convert):
GET /movements/| Query | Type | Description |
|---|---|---|
currency | string | Currency |
page | int | Page |
per_page | int | Default: 10 |
read_quotes | bool | Default: false |
Wallet equivalents:
GET /wallet/equivalent/Header-only endpoint. Returns equivalences between currencies/balances.
⚠️
For legal entities: onboarding status is validated before showing the balance.
👑
Superusers: they can check other users’ balances using
?username=other_user.