InícioReferência

Consultar transação

O endpoint de consulta permite recuperar todos os detalhes de uma transação específica, incluindo seu status atual, o histórico de mudanças e outras informações relevantes (como valor, método de pagamento, taxas, etc.). Isso é útil para monitorar o ciclo de vida de um pagamento ou saque (Cash Out), verificar se uma transação já foi paga (Cash In), ou se ocorreu um reembolso, entre outras possibilidades.

Mais detalhesCopied!

[GET] /transactions/:id

Busca os detalhes de uma transação

Observações ImportantesCopied!

  1. Histórico de Status: No array history, você consegue ver o passo a passo da transação, como confirmações, pagamentos ou reembolsos.

  2. Exemplos de Status:

    • WAITING_CONFIRMATION: Aguardando confirmação do saldo ou dados.

    • WAITING_PAYMENT: Aguardando o pagamento do usuário.

    • WAITING_WITHDRAW: Aguardando o processamento do saque.

    • PAID: Transação paga com sucesso (Cash In).

    • WITHDRAW_PAID: Se for um saque (Cash Out) que finalizou, por exemplo.

    • REFUND_IN: Valor reembolsado, se houve devolução.

    • ERROR: Algum erro foi gerado e a transação não foi concluída.

  3. Finalidade: É possível usar esse endpoint para verificar se a transação foi paga, se foi reembolsada, ou em que momento ela se encontra no fluxo.

  4. Autenticação: Lembre-se de incluir o header apiKey válido em cada requisição para evitar erros de autenticação.

  5. Endpoint Somente Leitura: Este método GET não altera nenhuma informação; serve apenas para consulta.

Conclusão

O endpoint de consulta de transação (GET /transactions/:id) fornece uma visão detalhada do status e do histórico da transação. Ele é fundamental para acompanhar o fluxo de pagamentos Pix (Cash In), saques (Cash Out) ou reembolsos. Em caso de dúvidas ou para informações adicionais, consulte a documentação completa ou entre em contato com o suporte da Fire Banking.