Instrumentos

Un Instrumento es el registro de CRM que asocia un Titular con una Cuenta del Ledger en Midaz. Almacena el ledgerId y el accountId de esa asociación, junto con detalles bancarios, campos regulatorios, metadatos y partes relacionadas. Los Instrumentos mantienen el contexto de CRM separado del Ledger transaccional. El Ledger sigue siendo el registro de saldos y movimientos. El Instrumento contiene el contexto asociado a un Titular y su Cuenta del Ledger.

​

Crear un Instrumento

Crea un Instrumento dentro del alcance de un Titular. La entrada de creación requiere:

• ledgerId y accountId de la Cuenta del Ledger asociada.
• metadata.
• bankingDetails.

El objeto bankingDetails puede contener branch, account, type, openingDate, closingDate, iban, countryCode y bankId. Sus campos individuales son opcionales. Una respuesta de Instrumento incluye su id, holderId, ledgerId, accountId, document, type, marcas de tiempo y cualquier dato bancario, regulatorio, de metadatos o de partes relacionadas configurado.

​

Campos regulatorios y partes relacionadas

Usa regulatoryFields.participantDocument para almacenar el documento del participante cuando aplique. Un Instrumento puede incluir partes relacionadas. Cada parte relacionada requiere document, name, role y startDate. Los campos id y endDate son opcionales.

​

Administrar Instrumentos

La API de Midaz te permite:

• Listar Instrumentos de una organización.
• Crear un Instrumento para un Titular.
• Consultar, actualizar o eliminar un Instrumento dentro del alcance de su Titular.
• Eliminar una parte relacionada de un Instrumento.

Usa la referencia de la API de Midaz para conocer el esquema actual de solicitud y respuesta.

​

Próximos pasos