Consultar saldo

Descripción

Devuelve el saldo de tu organización. Orion maneja dos bolsas independientes:

Bolsa	Se usa para vender
`TAE`	Productos del grupo TAE.
`SERVICIOS`	Productos de los grupos SERVICIO y PIN.

Las bolsas no se cruzan: no tener saldo en servicios no impide vender tiempo aire, y al revés. Antes de vender, revisa el currentBalance de la bolsa que corresponde al producto.

URL API

BASE URLhttps://api.faxil.mx/api/v1

Autenticación

Header	Requerido	Permiso de la API Key
`x-api-key`	Sí	`balances.read`

Ver Autenticación (API Key).

Ejemplo de uso

Endpoint:

GETapi.faxil.mx/api/v1/tae/balance

curl -s "$ORION_API/api/v1/tae/balance" \
  -H "x-api-key: $ORION_API_KEY"

Body: No aplica

Respuestas

200 — Saldos Success

{
  "error": false,
  "message": "Saldos",
  "data": {
    "wallets": {
      "TAE": {
        "wallet": "TAE",
        "initialBalance": 0,
        "purchases": 50000,
        "sales": 12450,
        "transfers": 0,
        "commissions": 435.75,
        "reserved": 100,
        "currentBalance": 37885.75
      },
      "SERVICIOS": {
        "wallet": "SERVICIOS",
        "initialBalance": 0,
        "purchases": 20000,
        "sales": 8320.5,
        "transfers": 0,
        "commissions": 0,
        "reserved": 0,
        "currentBalance": 11679.5
      }
    },
    "totals": {
      "initialBalance": 0,
      "purchases": 70000,
      "sales": 20770.5,
      "transfers": 0,
      "commissions": 435.75,
      "reserved": 100,
      "currentBalance": 49565.25
    }
  },
  "results": 1
}

401 / 403 — Autenticación Client Error

{ "error": true, "message": "Permiso insuficiente", "data": [], "results": 0 }

Código	`message`	Causa
`401`	`Token requerido`	Falta el header `x-api-key`.
`401`	`API key inválida`	Clave inexistente, revocada o expirada.
`403`	`Organización o canal API no disponible`	Organización suspendida o canal API deshabilitado.
`403`	`Permiso insuficiente`	La clave no tiene el permiso `balances.read`.

Parámetros de salida

Cada bolsa en data.wallets y el consolidado data.totals tienen la misma forma. Los importes están en pesos mexicanos (MXN) con dos decimales.

Campo	Tipo	Descripción
`wallet`	string	Nombre de la bolsa: `TAE` o `SERVICIOS` (no aparece en `totals`).
`initialBalance`	number	Saldo inicial de la bolsa.
`purchases`	number	Abonos acumulados (fondeos y compras de saldo).
`sales`	number	Ventas acumuladas.
`transfers`	number	Saldo traspasado a otras organizaciones.
`commissions`	number	Comisiones abonadas a tu favor.
`reserved`	number	Saldo apartado por ventas en proceso. Se libera o se cobra cuando la venta termina.
`currentBalance`	number	Saldo disponible para vender.

Probar endpoint

GEThttps://api.faxil.mx/api/v1/tae/balance
Consulta el saldo de tu organización. Requiere el permiso balances.read.
Headers