Instrumentos

Um Instrumento é o registro de CRM que associa um Titular a uma Conta do Ledger no Midaz. Ele guarda o ledgerId e o accountId dessa associação, junto com dados bancários, campos regulatórios, metadados e partes relacionadas. Instrumentos mantêm o contexto do CRM separado do Ledger transacional. O Ledger continua sendo o registro de saldos e movimentações. O Instrumento guarda o contexto associado a um Titular e à Conta do Ledger dele.

​

Criar um Instrumento

Crie um Instrumento no escopo de um Titular. A entrada de criação exige:

• ledgerId e accountId da Conta do Ledger associada.
• metadata.
• bankingDetails.

O objeto bankingDetails pode conter branch, account, type, openingDate, closingDate, iban, countryCode e bankId. Os campos individuais dele são opcionais. A resposta de um Instrumento inclui o id, o holderId, o ledgerId, o accountId, o document, o type, as datas e horas e os dados bancários, regulatórios, de metadados ou de partes relacionadas que estiverem configurados.

​

Campos regulatórios e partes relacionadas

Use regulatoryFields.participantDocument para guardar o documento do participante quando ele se aplicar. Um Instrumento pode incluir partes relacionadas. Cada parte relacionada exige document, name, role e startDate. Os campos id e endDate são opcionais.

​

Gerenciar Instrumentos

A API do Midaz deixa você:

• Listar Instrumentos de uma organização.
• Criar um Instrumento para um Titular.
• Consultar, atualizar ou excluir um Instrumento no escopo do Titular dele.
• Excluir uma parte relacionada de um Instrumento.

Use a referência da API do Midaz para conhecer o schema atual de requisição e resposta.

​

Próximos passos