Consultar saldo da carteira
https://api.zypfy.com/api/accounts/balanceRetorna o saldo atual da carteira do merchant autenticado. Use este
endpoint para fazer um pre-check antes de disparar um saque — assim
você evita o erro INSUFFICIENT_BALANCE.
Semântica dos campos
balance: saldo disponível para saque agora.balance_block: valor bloqueado em saques em processamento (já reservado, ainda não debitado efetivamente).total_balance:balance+balance_block.available_balance: alias debalance.balance_mxn: saldo em MXN (pesos) vindo de depósitos México, moeda separada do BRL. Converta para reais comPOST /api/accounts/mxn/convertantes de sacar via PIX.0.00se você não usa depósito México.withdraw_receiver_document_required: setrue, saques por chaveEMAIL/PHONE/EVPexigem o CPF/CNPJ do recebedor emtaxId; sefalse, a configuração de saque da sua conta dispensa o documento nesses tipos de chave.
Respostas
200Saldo retornado com sucesso.
messagestringexemplo:Wallet balance retrieved successfully.total_balancenumber (float)balance+balance_block.exemplo:1000balancenumber (float)Saldo disponível para saque.
exemplo:800balance_blocknumber (float)Saldo bloqueado (saques em processamento).
exemplo:200available_balancenumber (float)Alias de
balance.exemplo:800balance_mxnnumber (float)Saldo em MXN (pesos) de depósitos México, moeda separada do BRL. Converta para reais com
POST /api/accounts/mxn/convertantes de sacar via PIX.0.00se você não usa depósito México.exemplo:0withdraw_receiver_document_requiredbooleanSe
true, informe o CPF/CNPJ do recebedor (taxId) em saques por chaveEMAIL/PHONE/EVP. Sefalse, a configuração de saque da sua conta dispensa o documento do recebedor nesses tipos de chave — basta apix_key.exemplo:true
401Token ausente.
messagestringMensagem humana descrevendo o erro.
exemplo:Invalid amount.codestring | nullCódigo opcional de erro para roteamento no seu sistema.
min_amountnumber (float) | nullPresente em erros de valor abaixo do mínimo configurado.
max_amountnumber (float) | nullPresente em erros de valor acima do máximo absoluto.
limitnumber (float) | nullPresente em erros de limite diário por transação excedido.
retry_after_secondsinteger | nullPresente em erros
WITHDRAWAL_COOLDOWN/ 429.
403Token inválido ou expirado.
messagestringMensagem humana descrevendo o erro.
exemplo:Invalid amount.codestring | nullCódigo opcional de erro para roteamento no seu sistema.
min_amountnumber (float) | nullPresente em erros de valor abaixo do mínimo configurado.
max_amountnumber (float) | nullPresente em erros de valor acima do máximo absoluto.
limitnumber (float) | nullPresente em erros de limite diário por transação excedido.
retry_after_secondsinteger | nullPresente em erros
WITHDRAWAL_COOLDOWN/ 429.
404Carteira não encontrada para este usuário.
messagestringMensagem humana descrevendo o erro.
exemplo:Invalid amount.codestring | nullCódigo opcional de erro para roteamento no seu sistema.
min_amountnumber (float) | nullPresente em erros de valor abaixo do mínimo configurado.
max_amountnumber (float) | nullPresente em erros de valor acima do máximo absoluto.
limitnumber (float) | nullPresente em erros de limite diário por transação excedido.
retry_after_secondsinteger | nullPresente em erros
WITHDRAWAL_COOLDOWN/ 429.