ZypfyDocs Acessar painel
Saldo

Consultar saldo da carteira

GEThttps://api.zypfy.com/api/accounts/balance

Retorna 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

Respostas

200Saldo retornado com sucesso.
  • messagestring
    exemplo: Wallet balance retrieved successfully.
  • total_balancenumber (float)

    balance + balance_block.

    exemplo: 1000
  • balancenumber (float)

    Saldo disponível para saque.

    exemplo: 800
  • balance_blocknumber (float)

    Saldo bloqueado (saques em processamento).

    exemplo: 200
  • available_balancenumber (float)

    Alias de balance.

    exemplo: 800
  • balance_mxnnumber (float)

    Saldo em MXN (pesos) de depósitos México, moeda separada do BRL. Converta para reais com POST /api/accounts/mxn/convert antes de sacar via PIX. 0.00 se você não usa depósito México.

    exemplo: 0
  • withdraw_receiver_document_requiredboolean

    Se true, informe o CPF/CNPJ do recebedor (taxId) em saques por chave EMAIL/PHONE/EVP. Se false, a configuração de saque da sua conta dispensa o documento do recebedor nesses tipos de chave — basta a pix_key.

    exemplo: true
401Token ausente.
  • messagestring

    Mensagem humana descrevendo o erro.

    exemplo: Invalid amount.
  • codestring | null

    Código opcional de erro para roteamento no seu sistema.

  • min_amountnumber (float) | null

    Presente em erros de valor abaixo do mínimo configurado.

  • max_amountnumber (float) | null

    Presente em erros de valor acima do máximo absoluto.

  • limitnumber (float) | null

    Presente em erros de limite diário por transação excedido.

  • retry_after_secondsinteger | null

    Presente em erros WITHDRAWAL_COOLDOWN / 429.

403Token inválido ou expirado.
  • messagestring

    Mensagem humana descrevendo o erro.

    exemplo: Invalid amount.
  • codestring | null

    Código opcional de erro para roteamento no seu sistema.

  • min_amountnumber (float) | null

    Presente em erros de valor abaixo do mínimo configurado.

  • max_amountnumber (float) | null

    Presente em erros de valor acima do máximo absoluto.

  • limitnumber (float) | null

    Presente em erros de limite diário por transação excedido.

  • retry_after_secondsinteger | null

    Presente em erros WITHDRAWAL_COOLDOWN / 429.

404Carteira não encontrada para este usuário.
  • messagestring

    Mensagem humana descrevendo o erro.

    exemplo: Invalid amount.
  • codestring | null

    Código opcional de erro para roteamento no seu sistema.

  • min_amountnumber (float) | null

    Presente em erros de valor abaixo do mínimo configurado.

  • max_amountnumber (float) | null

    Presente em erros de valor acima do máximo absoluto.

  • limitnumber (float) | null

    Presente em erros de limite diário por transação excedido.

  • retry_after_secondsinteger | null

    Presente em erros WITHDRAWAL_COOLDOWN / 429.