Skip to main content

Visión General

El endpoint GET /api/balance devuelve el saldo de la cuenta autenticada en centavos MXN (enteros). Hay dos campos:
  • availableCentavos — saldo disponible para enviar cash-out SPEI
  • pendingCentavos — saldo bloqueado (cash-out en procesamiento, cash-in en confirmación)

Endpoint

GET /api/balance

Headers

Request

Response (200)

4873490 centavos = $48,734.90 MXN.

Estructura de la Respuesta

integer
Saldo disponible en centavos MXN. Usa este valor para validar antes de un cash-out.
integer
Saldo pendiente en centavos MXN. Incluye cash-out en procesamiento y cash-in en espera de la confirmación final de la liquidación.
string
Siempre MXN en el ámbito México.

Ejemplo en Node.js

Validación Antes del Cash-Out

Aun validando el saldo antes, el cash-out puede fallar con 400 si otro cash-out concurrente consume el saldo. Trata el error 400 como “saldo insuficiente” en el momento de la llamada.

Códigos de Respuesta

Próximos Pasos

SPEI Cash-Out

Envía una transferencia SPEI usando el saldo disponible