Saldo
Saldo informado en USDT y su cartola.
El saldo es un importe informado a partir de cobros y transferencias registrados en Clobepay; no representa custodia de fondos. Los cobros acreditados que no han liquidado aparecen como pendientes de liquidar y no suman al disponible.
GET
Consultar el saldo
/api/v1/balance
Disponible y por liquidar, en USDT.
Parámetros
NombreTipoUsoDescripción
Authorizationheader
stringObligatorioBearer $CLOBEPAY_API_KEY. También se acepta X-API-Key con el mismo valor. No envíes ambos.
Respuestas
- HTTP 200Saldo informado.
Errores
- HTTP 400
ambiguous_credentialsAuthorization: Bearer y X-API-Key traen llaves distintas. - HTTP 401
missing_credentialsNo enviaste la llave (Authorization: Bearer o X-API-Key). - HTTP 401
invalid_api_keyLa llave no existe, está mal formada o no coincide. - HTTP 401
api_key_revokedLa llave fue revocada. - HTTP 401
api_key_expiredLa llave expiró. - HTTP 401
api_key_wrong_environmentLa llave es de otro ambiente (llave de prueba en producción o al revés). - HTTP 403
insufficient_scopeLa llave no tiene el scope de esta ruta. - HTTP 429
rate_limitedDemasiadas peticiones. Respeta Retry-After.
GET/balance
curl -X GET "$CLOBEPAY_API_BASE/balance" \ -H "Authorization: Bearer $CLOBEPAY_API_KEY"Respuesta
HTTP 200{
"sellerId": "7c2e1a4b-9d83-4f21-a6b0-2e8c91f04d17",
"asset": "USDT",
"available": "1250.00",
"held": "0.00",
"heldCount": 0,
"pendingSettlement": "50.00",
"pendingSettlementCount": 1,
"informational": true,
"custody": false,
"asOf": "2026-11-19T18:00:00.000Z",
"note": "Saldo informado; no representa custodia de fondos."
}GET
Cartola de movimientos
/api/v1/balance/statement
Movimientos del saldo informado, en USDT.
Parámetros
NombreTipoUsoDescripción
Authorizationheader
stringObligatorioBearer $CLOBEPAY_API_KEY. También se acepta X-API-Key con el mismo valor. No envíes ambos.
periodquery
stringOpcionaltoday, 7d, 30d o month. Para un rango usa from y to.
today · 7d · 30d · month
fromquery
stringOpcionalYYYY-MM-DD (UTC), junto con to.
toquery
stringOpcionalYYYY-MM-DD (UTC), junto con from.
Respuestas
- HTTP 200Cartola en camelCase (openingBalance, closingBalance, inflows, outflows).
Errores
- HTTP 400
ambiguous_credentialsAuthorization: Bearer y X-API-Key traen llaves distintas. - HTTP 401
missing_credentialsNo enviaste la llave (Authorization: Bearer o X-API-Key). - HTTP 401
invalid_api_keyLa llave no existe, está mal formada o no coincide. - HTTP 401
api_key_revokedLa llave fue revocada. - HTTP 401
api_key_expiredLa llave expiró. - HTTP 401
api_key_wrong_environmentLa llave es de otro ambiente (llave de prueba en producción o al revés). - HTTP 403
insufficient_scopeLa llave no tiene el scope de esta ruta. - HTTP 429
rate_limitedDemasiadas peticiones. Respeta Retry-After. - HTTP 400
invalid_periodperiod, from o to inválidos.
GET/balance/statement
curl -X GET "$CLOBEPAY_API_BASE/balance/statement?period=7d" \ -H "Authorization: Bearer $CLOBEPAY_API_KEY"Respuesta
HTTP 200{
"sellerId": "7c2e1a4b-9d83-4f21-a6b0-2e8c91f04d17",
"asset": "USDT",
"period": "7d",
"from": "2026-11-12",
"to": "2026-11-19",
"openingBalance": "1000.00",
"inflows": "300.00",
"outflows": "50.00",
"closingBalance": "1250.00",
"balanced": true
}