API Reference

Balance Endpoint

GET/balance

Consulta el saldo disponible en la cuenta del cliente

Objetivo

Permite verificar el saldo actual disponible en la cuenta del cliente para realizar operaciones de pago.

Request

Headers

CampoTipoObligatorioDescripción
x-api-key
StringAPI Key requerida para acceder a este endpoint.
x-authorization-token
StringToken de acceso generado al hacer login.

Query Parameters

CampoTipoObligatorioDescripción
currency
StringNoCódigo de moneda para consultar el saldo (ej: USD, ARS, MXN). Por defecto devuelve todas las monedas.

Response

Response Body

ParámetroTipoDescripción
balances
Object[]Lista de saldos por moneda.
tx
StringID interno de transacción.
mainTx
StringID principal de transacción.

Response Examples

200 OK

Consideraciones

  • El saldo se actualiza en tiempo real con cada transacción procesada.
  • Si no se especifica una moneda, se devuelven los saldos de todas las monedas disponibles.
  • Los montos se muestran con la precisión decimal correspondiente a cada moneda.

CLIENT LIBRARIES

REQUEST EXAMPLE

curl --request GET \
--url https://tools.homo.tapila.cloud/balance?currency=USD \
--header 'x-authorization-token: YOUR_TOKEN_HERE' \
--header 'x-api-key: YOUR_API_KEY_HERE'