Cadastro de Ativos - Emissões
Criação - Nota Comercial
Utilizando o endpoint a seguir, é possível cadastrar uma nova nota no orquestrador de ativos estruturados.
Os ativos cadastrados surgem no status pre_operational para que sejam submetidos os documentos relacionados ao ativo. Deste modo, é possível pré cadastrar um ativo e habilitá-lo para operação somente após as devidas formalizações estarem concluídas, como detalhado no próximo segmento.
A seguir consta uma listagem explicativa dos campos, e o detalhamento de suas obrigatoriedades e tipos.
Request
ENDPOINT
/security/securityMÉTODO
POSTRequest Body
{
"external_id": "string",
"asset_type": "commercial_paper",
"b3_code":"25M000000",
"isin_code":"BR00ABCDE000",
"contract_number": "SCR12345",
"ipoc_code": "string",
"maturity_date": "YYYY-MM-DD",
"allowed_managers": ["00.000.000/0000-00", "00.000.000/0000-00", "00.000.000/0000-00"],
"allowed_consultants": ["00.000.000/0000-00", "00.000.000/0000-00", "00.000.000/0000-00"],
"issuer_document_number": "00.000.000/0000-00",
"bookkeeper_document_number": "00.000.000/0000-00",
"number_of_units": 1,
"principal_value_unit_price": 1000000.00,
"issue_value": 1000000.00,
"issue_unit_price": 1000000.00,
"issue_date": "YYYY-MM-DD",
"amortization_type": "sac",
"installments": [
{
"installment_number": 1,
"maturity_date": "YYYY-MM-DD",
"principal_value_unit_price": 1000000.00,
"face_value_unit_price": 1010000.00,
"amortization_percentage": 1
}
],
"delay": {
"fine": {
"fine_type": "percentage",
"percentage_value": 0.0
},
"interest": {
"method": "compound",
"pre_fixed": {
"monthly_rate": 0.0,
"calendar_base": "calendar_360"
}
}
},
"pre_fixed": {
"monthly_rate": 0.01,
"calendar_base": "calendar_360"
},
"post_fixed": {
"lag": {
"amount": 1,
"reference": "daily"
},
"rate": 1,
"indexer": "di",
"calendar_base": "workdays"
}
}
Definições
Objeto Ativo (Request Body)
Campo | Tipo | Descrição | Obrigatório |
---|---|---|---|
asset_type | string | Enumerador que determina o Tipo de Ativo | Sim |
external_id | string | Identificador externo do ativo; Chave utilizada para acessar a entidade | Sim |
b3_code | string | Código cetip do ativo | Não |
isin_code | string | Código ISIN (International Securities Identification Number) | Não |
ipoc_code | string | Código IPOC do ativo | Não |
allowed_managers | list | Lista com CNPJ's de gestores com permissão de operar na emissão | Não |
allowed_consultants | list | Lista com CNPJ's de consultores com permissão de operar na emissão | Não |
issuer_document_number | string | Número do CNPJ ou CPF do emissor | Sim |
bookkeeper_document_number | string | Número do CNPJ do escriturador | Sim |
number_of_units | float | Número de unidades | Sim |
issue_unit_price | float | Preço unitário na emissão | Sim |
issue_value | float | Valor do ativo na emissão | Sim |
principal_value_unit_price | float | Valor unitário de princial do ativo na emissão | Sim |
issue_date | string | Data de emissão no formato YYYY-MM-DD | Sim |
disbursement_date | string | Data de emissão no formato YYYY-MM-DD | Sim |
amortization_type | string | Enumerador de Tipo de Amortização | Sim |
contract_number | string | Número do contrato | Sim |
maturity_date | string | Data de vencimento do ativo | Sim |
installments | dict | Objeto de parcelas | Sim |
delay | dict | Objeto de atraso | Sim |
pre_fixed | dict | Objeto de pré fixado | Sim |
post_fixed | dict | Objeto de pós fixado | Não |
Enumerador Tipo de Ativo
Enumerador | Descrição |
---|---|
commercial_paper | Ativo do tipo Nota Comercial |
debenture | Ativo do tipo Debênture |
cri | Ativo do tipo CRI |
cra | Ativo do tipo CRA |
Enumerador Tipo de Amortização
Enumerador | Descrição |
---|---|
sac | Amortização do tipo SAC |
price | Amortização do tipo Price |
Objeto de Parcela
Campo | Tipo | Descrição | Obrigatório |
---|---|---|---|
installment_number | int | Número da Parcela | Sim |
maturity_date | string | Data de Vencimento no formato YYYY-MM-DD | Sim |
principal_value_unit_price | float | Valor de principal unitário do ativo | Sim |
face_value_unit_price | float | Valor de face unitário do ativo | Sim |
amortization_percentage | float | Porcentagem de Amortização | Não |
Objeto Atraso
Campo | Tipo | Descrição | Obrigatório |
---|---|---|---|
fine | object | Objeto da multa no vencimento. Ver Objeto Multa de Atraso. | Sim |
interest | object | Objeto do juros de mora. Ver Objeto Juros de Mora. | Sim |
Objeto Multa de Atraso
Campo | Tipo | Descrição | Obrigatório |
---|---|---|---|
fine_type | string | Tipo de Multa. | Sim |
percentage_value | number | Valor da Multa, se tipo da multa for percentage . Unidade de medida: de 0 à 1, considerando 0 à 100% | Sim |
amount | number | Valor da Multa, se tipo de multa for fixed . | Sim |
Enumerador Tipo da Multa
Enumerador | Descrição |
---|---|
percentage | Multa percentual sobre o valor da parcela |
fixed | Valor fixo de Multa |
Objeto Juros de Mora
Campo | Tipo | Descrição | Obrigatório |
---|---|---|---|
method * | string | Ver Enumerador Método do Juros de Mora. | Sim |
pre_fixed * | object | Ver Objeto de Pré Fixado. | Sim |
Enumerador Método do Juros de Mora
Enumerador | Descrição |
---|---|
compound | Para juros de mora composto |
simple | Para juros de mora simples |
Objeto Pré Fixado
Campo | Tipo | Descrição | Obrigatório |
---|---|---|---|
calendar_base * | string | A base de cálculo utilizada. | enumerator |
monthly_rate * | number | A taxa mensal do contrato. Para 1% usar 0.01 | Até 8 casas decimais |
Objeto Pós Fixado
Campo | Tipo | Descrição | Obrigatório |
---|---|---|---|
rate | int | Taxa fixa aplicada | Sim |
indexer | string | Índice de referência da correção (di, ipca) | Sim |
calendar_base | string | Tipo de calendário considerado | Sim |
Objeto de Lag
Campo | Tipo | Descrição | Obrigatório |
---|---|---|---|
amount | int | Quantidade de unidades de defasagem | Sim |
reference | string | Unidade de tempo de defasagem | Sim |
Enumerador Base de Cálculo
Enumerador | Descrição |
---|---|
daily | Para valores diários de atraso |
monthly | Para valores mensais de atraso |
Enumerador Referência de Atraso
Enumerador | Descrição |
---|---|
workdays | Para base de cálculo dias úteis (252) |
calendar_365 | Para base de cálculos 365 |
calendar_360 | Para base de cálculos 360 |
Response
STATUS
201Response Body
{
"security_key": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
"status": "pre_operational",
}