Contas

​

Estrutura da Conta

• Conta > Ledger: Você cria uma Conta dentro de um Ledger. O Ledger rastreia e consolida todos os saldos e operações.
• Conta > Portfólio: Você pode agrupar Contas em Portfólios para representar grupos de clientes, linhas de produto ou unidades de negócio.
• Conta > Ativo: Cada Conta se vincula a um único Ativo. O Ativo define o tipo de valor que a Conta guarda, como BRL, USD, BTC ou pontos de fidelidade.
• Conta > Tipo de Conta: Quando você habilita a validação de Tipo de Conta, cada Conta não externa deve usar um Tipo de Conta registrado. Você registra Tipos de Conta para a sua classificação de negócio.

​

Características principais

• Cada Conta se vincula a exatamente um Ativo.
• Cada Conta tem um identificador único dentro de um Ledger.

​

Várias contas por cliente

• Natureza diferente: um saldo principal, um saldo de benefício ou um saldo promocional.
• Regras operacionais diferentes: uma conta por ordem judicial que aceita entradas mas restringe saídas.
• Extrato e conciliação separados: uma subconta de produto ou compartimento que você acompanha de forma independente.

​

Conta Externa

• Guardam o saldo da contraparte do dinheiro que entra ou sai do seu ledger.
• O Ledger cria uma Conta externa canônica automaticamente quando você cria um Ativo.
• A Conta externa canônica segue um padrão de nomenclatura claro: @external/<asset-code>, como @external/BRL.

​

Códigos de conta externa

• GET .../accounts/external/{code}: Busca a conta externa de um código de ativo (por exemplo, BRL resolve para @external/BRL).
• GET .../accounts/external/{code}/balances: Busca os saldos dessa conta externa.

​

Entity ID (referência de sistema externo)

• Não é o mesmo que o alias: Você usa o alias nas transações, e ele deve ser único dentro de um ledger. O entityId é apenas uma referência para a sua integração, e o Midaz não o usa para movimentar valor.
• Opcional: Defina-o quando criar a conta ou quando atualizá-la. O tamanho máximo é 256 caracteres.
• Caso de uso: Quando o seu sistema já tem um identificador de conta, como EXT-ACC-12345, armazene-o em entityId. Assim você consegue mapear entre o Midaz e a sua fonte de verdade.

{
  "name": "User Checking Account",
  "assetCode": "BRL",
  "alias": "@user_checking_123",
  "entityId": "EXT-ACC-12345",
  "type": "checking"
}

​

ID da conta pai

​

Contas bloqueadas

​

Aliases de conta

• Por exemplo: Em vez do ID 3172933b-50d2-4b17-96aa-9b378d6a6eac, você pode usar @username_1.

​

Use o Alias da Conta nas Transações

​

Gerenciando Contas

​

Pela API

• Criar uma Conta: Abra uma nova Conta vinculada a um Ativo.
• Abrir uma Conta de um Titular: Abra uma Conta que pertence a um Titular e, opcionalmente, o Instrumento dela, em uma única chamada.
• Listar Contas: Veja todas as Contas de um Ledger.
• Buscar uma Conta: Obtenha detalhes de uma Conta específica.
• Buscar uma Conta pelo Alias: Obtenha detalhes de uma Conta específica pelo alias dela.
• Buscar uma Conta Externa: Obtenha detalhes de uma Conta Externa específica pelo código do ativo dela.
• Atualizar uma Conta: Edite os metadados ou as configurações de uma Conta existente.
• Excluir uma Conta: Exclua uma Conta específica. O Midaz também arquiva os Instrumentos dela, termina a atribuição de plano de tarifas dela e remove o alias dela dos pacotes de tarifas e de cobrança do ledger.
• Encerrar uma Conta: Encerre uma Conta cujos saldos estão todos exatamente em zero. O Midaz mantém o histórico dela e recusa qualquer movimentação posterior.

​

Pelo Lerian Console