Ir al contenido

API

En esta página

Obtener

Consulta los saldos de token disponibles, léelos por activo en lugar de por red de origen y usa el resultado antes de crear un retiro.

GET/v1/balances

Clave de API: Payout

Devuelve el saldo disponible del comercio como un único total por moneda, sumado a través de todas las redes: una entrada por activo. Un saldo no está atado a una red; la red se elige solo al crear un retiro. Los saldos que quedan a cero se omiten. El entorno de la clave decide el conjunto de datos: una clave de sandbox devuelve saldos de sandbox y una clave real devuelve los reales.

Respuesta (200 OK)

[
  { "currency": "USDT", "available": "1750.50" },
  { "currency": "USDC", "available": "500.00" }
]

Campos de la respuesta

La respuesta es un array con una entrada por activo: el total sumado en todas las redes.

Campo Tipo Descripción
currency string Símbolo del token — p. ej. USDT, USDC, DAI
available string Saldo disponible en las unidades del propio token, sumado en todas las redes, como cadena decimal (separador de punto)

Errores

Los saldos requieren una clave Payout (rk_): una clave Payment se rechaza con 403 payout_key_required. El catálogo completo está en Códigos de error. El URI del campo type de cada respuesta de error enlaza directamente con la fila correspondiente.