Skip to main content

Visão Geral

O endpoint GET /api/balance retorna o saldo da conta autenticada em centavos MXN (inteiros). Há dois campos:
  • availableCentavos — saldo disponível para enviar cash-out SPEI
  • pendingCentavos — saldo bloqueado (cash-out em processamento, cash-in confirmando)

Endpoint

GET /api/balance

Headers

Request

Response (200)

4873490 centavos = $48.734,90 MXN.

Estrutura da Resposta

integer
Saldo disponível em centavos MXN. Use este valor para validar antes de um cash-out.
integer
Saldo pendente em centavos MXN. Inclui cash-out em processamento e cash-in aguardando a confirmação final da liquidação.
string
Sempre MXN no escopo México.

Exemplo em Node.js

Validação Antes do Cash-Out

Mesmo validando o saldo antes, o cash-out pode falhar com 400 se outro cash-out concorrente consumir o saldo. Trate o erro 400 como “saldo insuficiente” no momento da chamada.

Códigos de Resposta

Próximos Passos

SPEI Cash-Out

Envie uma transferência SPEI usando o saldo disponível