Create an Outflow Transaction
Use este endpoint para iniciar uma transação de saída, abstraindo o processo de movimentação de fundos das contas internas do ledger para o mundo externo.
Instead of requiring full transaction details, you only need to provide the source accounts. Based on the asset provided, the system automatically includes the corresponding external account in the distribute section of the transaction.
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 o Access Manager habilitado.
O tipo de mídia do recurso. Deve ser 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 com base nos dados da transação.
O tempo de vida (TTL) da chave, definido em segundos.
Parâmetros de caminho
O identificador único da Organização associada ao Ledger.
O identificador único do Ledger associado.
Corpo
Um objeto contendo informações sobre a transação que será enviada.
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.
100Indica se a transação deve seguir um processo em duas etapas: autorização seguida de execução. Quando definido como true, a transação é criada em estado pendente, reservando fundos (on_hold) sem movê-los imediatamente. Um commit subsequente é necessário para finalizar a transferência.
Uma descrição para a transação.
Especifica a Rota de Transação associada à transação. Importante: Quando a validação de Rota de Transação está habilitada para o seu Ledger, este campo se torna obrigatório e deve corresponder a um id existente das suas Rotas de Transação configuradas. No entanto, quando a validação está desabilitada (comportamento padrão), este campo é opcional e aceita qualquer string de formato livre.
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'.
Resposta
Indica que o recurso foi criado com sucesso e a operação foi concluída conforme esperado.
O identificador único da transação.
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'.