Overview
TheGET /api/balance endpoint returns the authenticated account’s balance in MXN centavos (integers). There are two fields:
availableCentavos— balance available for sending SPEI cash-outpendingCentavos— blocked balance (cash-out in processing, cash-in awaiting confirmation)
Endpoint
GET /api/balance
Headers
Request
Response (200)
4873490 centavos = $48,734.90 MXN.
Response Structure
integer
Available balance in MXN centavos. Use this value to validate before a cash-out.
integer
Pending balance in MXN centavos. Includes cash-out in processing and cash-in awaiting final settlement confirmation.
string
Always
MXN within the Mexico scope.Node.js Example
Validation Before Cash-Out
Even after validating the balance, the cash-out can still fail with
400 if a concurrent cash-out consumes the balance. Treat the 400 error as “insufficient balance” at call time.Response Codes
Next Steps
SPEI Cash-Out
Send a SPEI transfer using the available balance