Criar uma Transação de Entrada
Use este endpoint para registrar fundos recebidos de fontes externas no ledger. Você só precisa fornecer as contas de destino — com base no ativo selecionado, o sistema atribui automaticamente a conta externa apropriada como origem da transação, simplificando o processo de entrada.
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.
O tipo de mídia do recurso. O valor recomendado é application/json.
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.
Corpo
O nome do grupo do plano de contas que categoriza esta transação em um grupo específico.
Código da transação para referência.
100Uma descrição para a transação.
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'.
A data em que a transação foi realizada. Usado para adicionar transações passadas. Deve ser uma data no passado.
Um objeto contendo informações sobre a transação que será enviada.
Resposta
Indica que o recurso foi criado com sucesso e a operação foi concluída conforme esperado.
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'.