Reverter uma Transação
Use este endpoint para reverter uma transação existente gerando automaticamente uma nova na direção oposta da original.
The new transaction is linked to the original using the parentTransactionId field, ensuring full traceability between both operations.
Important: Only transactions with status APPROVED can be reverted. If the original transaction already has a parent (i.e., was already reverted) the request will be rejected. On success this endpoint creates the reversing transaction and returns 201 Created with the created transaction payload.
Autorizações
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Cabeçalhos
O token de autorização. Este cabeçalho é obrigatório se o seu ambiente tiver Access Manager habilitado.
Um identificador único utilizado para rastrear e acompanhar cada requisição.
Uma chave única que garante a idempotência da transação. Se não fornecida, o sistema gera automaticamente um hash SHA-256 com base no corpo da requisição. As chaves são escopadas por organização e ledger.
Sempre valide o header de resposta X-Idempotency-Replayed para distinguir transações novas de replays em cache.
Consulte Retentativas e idempotência para boas práticas.
O tempo de vida (TTL) da chave de idempotência, definido em segundos. Se não fornecido, o padrão é 300 segundos (5 minutos). Apenas o TTL da primeira requisição é utilizado; alterá-lo em retentativas não tem efeito.
Consulte Retentativas e idempotência para mais detalhes.
Parâmetros de caminho
O identificador único da Organização associada ao Ledger.
O identificador único do Ledger associado.
O identificador único da transação que você deseja consultar.
Resposta
Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados.
A resposta inclui o header X-Idempotency-Replayed.
Se o valor for false, a transação foi recém-processada. Se o valor for true, a resposta é uma repetição de uma requisição processada anteriormente.
Consulte Retentativas e idempotência para mais detalhes.
O identificador único da transação.
O identificador único da transação pai/original para reversões. Este campo é preenchido pelo servidor quando uma transação é revertida e deve ser tratado como somente leitura pelos clientes.
O identificador único da Organização.
O identificador único do Ledger.
Descrição da transação.
Especifica a Rota de Transação associada à transação.
O status da transação (pendente, concluída, revertida).
O valor enviado.
O nome do ativo utilizado na operação.
O nome do grupo do plano de contas.
A lista de contas utilizadas como origem.
A lista de contas utilizadas como destino.
Data e hora de criação (UTC).
Data e hora da última atualização (UTC).
Data e hora da exclusão lógica, se aplicável (UTC).
Um objeto contendo pares de chave-valor para adicionar como metadata, onde o campo name é a chave e o campo value é o valor. Por exemplo, para adicionar um Centro de Custo, use 'costCenter': 'BR_11101997'.