Balance
Endpoint para consultar el balance del usuario.
El balance se consulta por moneda específica. Debes indicar qué moneda quieres consultar.
Consultar Balance
Obtiene el balance disponible del usuario en una moneda específica.
Endpoint
GET /balance/Headers
Authorization: Bearer [ACCESS_TOKEN]
Accept: application/json
x-api-key: [API_KEY]Parámetros Query
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
currency | string | ✅ | Moneda: COP, USD |
username | string | ❌ | Solo superusuarios: consultar otro usuario |
Ejemplos por Moneda
Peso Colombiano
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"
}Campos de Respuesta
| Campo | Tipo | Descripción |
|---|---|---|
balance | string | Balance total |
currency | string | Código de moneda |
available | string | Balance disponible para usar |
pending | string | Balance pendiente de confirmación |
💡
Nota: El balance available es lo que realmente puedes usar. El pending
incluye transacciones en proceso.
Monedas Soportadas
| Código | Moneda | Descripción |
|---|---|---|
COP | 🇨🇴 Peso Colombiano | Moneda principal para Colombia |
USD | 🇺🇸 Dólar | Dólar estadounidense |
Errores Posibles
| Código | Error | Descripción |
|---|---|---|
400 | InvalidCurrency | Moneda no válida o no soportada |
403 | Forbidden | Sin permisos para consultar |
404 | ProfileNotFound | Perfil no encontrado |
Notas Importantes
⚠️
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.
Ejemplo para Superusuarios
curl -X GET "https://dev.backend.colurs.co/balance/?currency=COP&username=otro_usuario" \
-H "Authorization: Bearer [SUPER_ADMIN_TOKEN]" \
-H "x-api-key: [API_KEY]"