Asset Registration - Issuances
Creation - Commercial Paper
Using the following endpoint, it is possible to register a new note in the structured assets orchestrator.
Registered assets appear with pre_operational status so that documents related to the asset can be submitted. This way, it is possible to pre-register an asset and enable it for operation only after the proper formalizations are completed, as detailed in the next segment.
Below is an explanatory list of fields and details of their requirements and types.
Request
ENDPOINT
/security/securityMETHOD
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_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_unit_price": 1000000.00,
"face_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"
}
}
Definitions
Asset Object (Request Body)
| Field | Type | Description | Required |
|---|---|---|---|
asset_type | string | Enumerator that determines the Asset Type | Yes |
external_id | string | External identifier of the asset; Key used to access the entity | Yes |
b3_code | string | Cetip code of the asset | No |
isin_code | string | ISIN (International Securities Identification Number) code | No |
ipoc_code | string | IPOC code of the asset | No |
allowed_managers | list | List of manager CNPJs with permission to operate on the issuance | No |
allowed_consultants | list | List of consultant CNPJs with permission to operate on the issuance | No |
issuer_document_number | string | Issuer's CNPJ or CPF number | Yes |
bookkeeper_document_number | string | Bookkeeper's CNPJ number | Yes |
number_of_units | float | Number of units | Yes |
issue_unit_price | float | Unit price at issuance | Yes |
issue_value | float | Asset value at issuance | Yes |
principal_unit_price | float | Principal unit value of asset at issuance | Yes |
issue_date | string | Issuance date in YYYY-MM-DD format | Yes |
disbursement_date | string | Issuance date in YYYY-MM-DD format | Yes |
amortization_type | string | Amortization Type enumerator | Yes |
contract_number | string | Contract number | Yes |
maturity_date | string | Asset maturity date | Yes |
installments | dict | Installments object | Yes |
delay | dict | Delay object | Yes |
pre_fixed | dict | Pre-fixed object | Yes |
post_fixed | dict | Post-fixed object | No |
Asset Type Enumerator
| Enumerator | Description |
|---|---|
| commercial_paper | Commercial Paper asset type |
| debenture | Debenture asset type |
| cri | CRI asset type |
| cra | CRA asset type |
Amortization Type Enumerator
| Enumerator | Description |
|---|---|
| sac | SAC type amortization |
| price | Price type amortization |
Installment Object
| Field | Type | Description | Required |
|---|---|---|---|
installment_number | int | Installment Number | Yes |
maturity_date | string | Maturity Date in YYYY-MM-DD format | Yes |
principal_unit_price | float | Asset principal unit value | Yes |
face_unit_price | float | Asset face unit value | Yes |
amortization_percentage | float | Amortization Percentage | No |
Delay Object
| Field | Type | Description | Required |
|---|---|---|---|
fine | object | Fine object at maturity. See Delay Fine Object. | Yes |
interest | object | Late interest object. See Late Interest Object. | Yes |
Delay Fine Object
| Field | Type | Description | Required |
|---|---|---|---|
fine_type | string | Fine Type. | Yes |
percentage_value | number | Fine Value, if fine type is percentage. Unit of measure: from 0 to 1, considering 0 to 100% | Yes |
amount | number | Fine Value, if fine type is fixed. | Yes |
Fine Type Enumerator
| Enumerator | Description |
|---|---|
| percentage | Percentage fine on installment value |
| fixed | Fixed fine value |
Late Interest Object
| Field | Type | Description | Required |
|---|---|---|---|
method * | string | See Late Interest Method Enumerator. | Yes |
pre_fixed * | object | See Pre-fixed Object. | Yes |
Late Interest Method Enumerator
| Enumerator | Description |
|---|---|
| compound | For compound late interest |
| simple | For simple late interest |
Pre-fixed Object
| Field | Type | Description | Required |
|---|---|---|---|
calendar_base * | string | The calculation base used. | enumerator |
monthly_rate * | number | The contract monthly rate. For 1% use 0.01 | Up to 8 decimal places |
Post-fixed Object
| Field | Type | Description | Required |
|---|---|---|---|
| rate | int | Fixed rate applied | Yes |
| indexer | string | Reference index for correction (di, ipca) | Yes |
| calendar_base | string | Type of calendar considered | Yes |
Lag Object
| Field | Type | Description | Required |
|---|---|---|---|
| amount | int | Amount of lag units | Yes |
| reference | string | Time unit of lag | Yes |
Calculation Base Enumerator
| Enumerator | Description |
|---|---|
| daily | For daily delay values |
| monthly | For monthly delay values |
Delay Reference Enumerator
| Enumerator | Description |
|---|---|
| workdays | For business days calculation base (252) |
| calendar_365 | For 365 calculation base |
| calendar_360 | For 360 calculation base |
Response
STATUS
201Response Body
{
"security_key": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
"status": "pre_operational",
}