ZypfyDocs Acessar painel
Consultas

Consultar saque por identificador único

GEThttps://api.zypfy.com/api/transactions/withdraw

Busca um saque específico (PIX ou cripto) usando um dos parâmetros únicos abaixo. Use este endpoint para conferir o status final após um webhook de saque não chegar ou em janelas de reconciliação agendada.

Exatamente um parâmetro entre end_to_end, transaction_id, external_id e idempotency_key deve ser informado.

Para saques cripto, a resposta traz is_crypto: true e os campos crypto_coin, crypto_network, crypto_wallet, crypto_coin_amount e crypto_tx_hash (hash on-chain, após liquidar).

Parâmetros de consulta

Respostas

200Transação encontrada (ou null em withdraw).
  • filtersobject

    Ecoa os filtros aplicados na busca (parâmetros não enviados vêm como null).

    campos de filters
    • end_to_endstring | null
    • transaction_idstring | null
    • external_idstring | null
    • txidstring | null
    • idempotency_keystring | null
  • withdraw
    campos de withdraw
    • typestring
      valores: withdraw
      exemplo: withdraw
    • idinteger
      exemplo: 202
    • transaction_idstring
      exemplo: b2c3d4e5-f6a7-8901-bcde-f23456789012
    • end_to_end_idstring | null
      exemplo: E0041696820240617152400000000002
    • external_idstring | null
      exemplo: saque-0001
    • amountnumber (float)
      exemplo: 50
    • feenumber (float)
      exemplo: 2.5
    • totalnumber (float)
      exemplo: 52.5
    • statusstring
      valores: PENDING QUEUE COMPLETED FAILED REFUNDED PARTIALLY_REFUNDED
      exemplo: COMPLETED
    • receiver_namestring | null
      exemplo: João Silva
    • receiver_cpfstring | null
      exemplo: 12345678901
    • receiver_ispbstring | null
      exemplo: 87654321
    • is_cryptoboolean

      true quando o saque é cripto; os campos crypto_* só aparecem nesse caso.

      exemplo: false
    • crypto_coinstring | null

      Só em saque cripto.

      exemplo: usdt
    • crypto_networkstring | null

      Só em saque cripto.

      exemplo: BNB Smart Chain (BEP20)
    • crypto_walletstring | null

      Endereço de destino (só cripto).

      exemplo: 0x1234567890abcdef1234567890abcdef12345678
    • crypto_coin_amountnumber (float) | null

      Quantidade na moeda (só cripto).

      exemplo: 34.512
    • crypto_tx_hashstring | null

      Hash on-chain (só cripto, após liquidar).

      exemplo: 0xabc123...def
    • created_atstring (date-time)
      exemplo: 2026-04-18T12:05:00.000Z
400Nenhum parâmetro único fornecido.
  • 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.

401Não autenticado.
  • 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.