🇪🇸 EspañolBalanceConsultar balance

Consultar balance

Retorna el saldo disponible del usuario. Para COP, USD y MXN se usa GET /balance/ con el parámetro currency.


Balance por moneda (COP, USD, MXN)

Consultar Balance

Autorización

Se requieren el header x-api-key y Authorization: Bearer <token>.

Endpoint

GEThttps://dev.backend.colurs.co/balance/

Headers Requeridos

Content-Type: application/jsonAccept: application/jsonx-api-key: [API_KEY]Authorization: Bearer [ACCESS_TOKEN]

Request Body

CampoTipoRequeridoDescripción
currencystringMoneda: COP, USD, MXN
usernamestringSolo superusuarios: consultar otro usuario

Ejemplo cURL

curl -X GET "https://dev.backend.colurs.co/balance/?currency=COP" \
-H "Authorization: Bearer [ACCESS_TOKEN]" \
-H "x-api-key: [API_KEY]"

Respuesta

response.json
{
"balance": "1500000.00",
"currency": "COP",
"available": "1450000.00",
"pending": 
"50000.00"}

Errores Posibles

CódigoErrorDescripción
400InvalidCurrencyMoneda no válida o no soportada
403ForbiddenSin permisos para consultar
404ProfileNotFoundPerfil no encontrado

Peso Colombiano

Respuesta:

{
"balance": "1500000.00",
"currency": "COP",
"available": "1450000.00",
"pending": "50000.00"
}

Campos de respuesta

CampoTipoDescripción
balancestringBalance total
currencystringCódigo de moneda
availablestringBalance disponible para usar
pendingstringBalance pendiente de confirmación
💡

El balance available es lo que realmente puedes usar. El pending incluye transacciones en proceso.

Monedas soportadas

CódigoMonedaDescripciónEndpoint
COP🇨🇴 Peso ColombianoMoneda principal para ColombiaGET /balance/?currency=COP
USD🇺🇸 DólarDólar estadounidenseGET /balance/?currency=USD
MXN🇲🇽 Peso MexicanoMéxicoGET /balance/?currency=MXN

Otros endpoints relacionados

Movimientos (Send, Receive, Reload, Convert):

GET /movements/
QueryTipoDescripción
currencystringMoneda
pageintPágina
per_pageintPor defecto 10
read_quotesboolPor defecto false

Equivalencias de wallet:

GET /wallet/equivalent/

Solo header. Devuelve equivalencias entre monedas/saldos.


⚠️

Para usuarios jurídicos: Se valida el estado del onboarding antes de mostrar el balance.

👑

Superusuarios: Pueden consultar el balance de otros usuarios usando ?username=otro_usuario.