Antes de começar
Confirme que:
- As Contas de origem e destino existem no Ledger selecionado.
- Ambas as Contas usam o Ativo selecionado para a Transação.
- Você conhece o alias de cada Conta, incluindo o prefixo
@. - As contas de origem permitem envio e as contas de destino permitem recebimento.
- Se Validar Rotas estiver habilitado, a Transação corresponde a uma Rota Contábil existente.
Criar a Transação
O modal Nova Transação será aberto. Selecione o tipo de transação que deseja criar:
- Simples 1:1 - Transações com uma origem e um destino
- Complexa n:n - Transações com mais de uma origem ou destino
Após selecionar o tipo de transação, a página Nova Transação abre com um formulário passo a passo:
Dados da Transação
Preencha as informações básicas da transação:
- (Opcional) Adicione uma Descrição para a transação
- (Opcional) Especifique um Grupo de Rota Contábil para classificação
- Informe o Valor a ser transferido
- Selecione o Ativo que será usado na transação
Origem e Destino
Especifique as contas envolvidas:
- Pesquise a conta de origem pelo alias e selecione-a
- Pesquise a conta de destino pelo alias e selecione-a
- Em transações complexas, você pode adicionar várias origens e/ou destinos
Operações
Revise e ajuste os detalhes da operação:
- Em transações simples (1:1), os valores são preenchidos automaticamente
- Em transações complexas (n:n), especifique o valor para cada origem (débito) e destino (crédito)
- Expanda cada operação para adicionar descrições e metadados opcionais
Em transações complexas, a soma de todos os valores de origem deve ser igual à soma de todos os valores de destino.
Uma página de revisão será exibida mostrando um resumo de todas as informações da transação:
- Valor e Ativo da transação
- Contas de origem e destino
- Operações individuais de débito e crédito
- Registros de metadados (se houver)
Revise as informações com atenção. Se tudo estiver correto:
- Clique em Enviar Transação para enviar e ver os detalhes da transação
- Clique em Enviar e Criar outra para enviar e iniciar imediatamente uma nova transação
Guia de campos
Dados da Transação
| Campo | O que informar | Exemplo |
|---|---|---|
| Descrição da transação | Descrição de negócio opcional da movimentação. | Customer payment to merchant |
| Grupo de Rota Contábil | Classificação opcional de rota quando sua configuração usa validação ou agrupamento de rotas. | Pix Transfer Group |
| Rota de Transação | Selecione a Rota de Transação associada à transação. | Pix Transfer Route |
| Ativo | Ativo usado pela Transação. Deve corresponder às Contas selecionadas. | BRL |
| Valor | Valor total a movimentar. Em transações complexas, os totais de origem devem ser iguais aos de destino. | 100.00 |
| Campo | O que informar | Exemplo |
|---|---|---|
| Origem | Alias da conta que será debitada. Inclua o prefixo @. | @customer_123 |
| Destino | Alias da conta que será creditada. Inclua o prefixo @. | @merchant_456 |
| Campo | O que informar | Exemplo |
|---|---|---|
| Descrição da operação | Descrição opcional para a operação. | Debit for the source account |
| Plano de Contas | Nome opcional do Plano de Contas ao qual a operação pertence. | Pix debit - source |
| Rota de Operação | Rota de operação opcional para esta parte da transação. | Checking account validation for Pix |
| Chave de Metadados | Nome opcional de campo para classificação ou integração. | externalReference |
| Valor de Metadados | Valor para a chave de metadados. | order_98765 |
Tipos de transação explicados
Transação Simples (1:1)
Use para transferências diretas entre duas contas:- Uma conta de origem (débito)
- Uma conta de destino (crédito)
- Mesmo valor debitado e creditado
Transação Complexa (n:n)
Use para transações que envolvem múltiplas partes:- Várias contas de origem (débitos) e/ou várias contas de destino (créditos)
- Os valores podem ser distribuídos entre contas
- O total de débitos deve ser igual ao total de créditos
- Pagamento com taxas:
- O cliente paga $103
- O estabelecimento recebe $100
- A conta de taxas recebe $3
- Pagamento consolidado: Vários clientes financiam um único pagamento a fornecedor
O que fazer em seguida
Após enviar a Transação, revise a página de detalhes e confirme o status, a operação de origem, a operação de destino e os saldos das contas.
Criar uma Transação usando JSON
Crie uma Transação programaticamente com o endpoint JSON.
Recuperar uma Transação
Inspecione o status e as operações da Transação pela API.