ZypfyDocs Acessar painel
Consultas

Consultar depósito por identificador único

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

Busca um depósito específico usando um dos parâmetros únicos abaixo. Use este endpoint para reconciliar transações após falha ou atraso de webhook — a resposta reflete o estado atual no banco.

Exatamente um parâmetro entre end_to_end, transaction_id, external_id e txid deve ser informado. Se nenhum for passado, retorna HTTP 400.

Parâmetros de consulta

Respostas

200Transação encontrada (ou null em deposit se nenhum registro bateu com os filtros).
  • 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
  • deposit
    campos de deposit
    • typestring
      valores: deposit
      exemplo: deposit
    • idinteger
      exemplo: 101
    • transaction_idstring
      exemplo: a1b2c3d4-e5f6-7890-abcd-ef1234567890
    • end_to_end_idstring | null
      exemplo: E0041696820240617152400000000001
    • external_idstring | null
      exemplo: order-2026-0001
    • txidstring | null
      exemplo: TXID123ABC
    • amountnumber (float)
      exemplo: 100
    • feenumber (float)
      exemplo: 2.5
    • totalnumber (float) | null
    • statusstring
      valores: PENDING COMPLETED FAILED
      exemplo: COMPLETED
    • payer_namestring | null
      exemplo: João Silva
    • payer_cpfstring | null
      exemplo: 12345678901
    • payer_ispbstring | null
      exemplo: 12345678
    • created_atstring (date-time)
      exemplo: 2026-04-18T12:00: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.