Transações
Explore 4 endpoints de Transações, com finalidade, método e rota derivados do contrato publicado.
Endpoints relacionados
Abra um endpoint para consultar parâmetros, exemplos e respostas.
Quando usar cada endpoint
Compare a finalidade de cada operação antes de iniciar a integração.
| Endpoint | Finalidade |
|---|---|
GET/resource/transactions | Lista as transações da organização do token, da mais recente para a mais antiga. Valores em reais. Filtros de lista (status, type) aceitam o parâmetro repetido: ?status=completed&status=failed. |
GET/resource/transactions/id/{transactionId} | Buscar transação por ID |
GET/resource/transactions/external-id/{externalId} | Consulta pelo externalId que você enviou ao criar a cobrança ou o pagamento. É a forma recomendada de conciliar e de verificar o resultado depois de um timeout. |
GET/resource/transactions/end-to-end/{endToEnd} | Consulta pelo identificador end-to-end do Pix (endToEnd), preenchido quando o Pix é liquidado. |
Finalidades, métodos e rotas vêm do contrato OpenAPI publicado.
Fluxo da categoria
A ordem das chamadas, quem executa cada passo e o que vem depois. Clique numa chamada para ver o fluxo dela.
Conferir uma transação
- Você
Timeout, webhook ou dúvida
Você tem o externalId que gerou
- Chamada
/resource/transactions/external-id/{externalId}A forma mais segura de conferir
- Você
Acompanhe o status
completed e failed são finais
Outras chaves
- Chamada
/resource/transactions/id/{transactionId}transactionId da resposta 202 ou do webhook
- Chamada
/resource/transactions/end-to-end/{endToEnd}endToEnd do comprovante Pix
Conciliação em lote
- Você
Siga a paginação
Até pagination.totalPages
- Você
Compare com o seu sistema
Pelo externalId de cada transação