Skip to main content

Issuances - Integralization


Integralization

Using the following endpoint, it is possible to initiate integralization on an issuance.

Request

ENDPOINT
/trade_security/fund_class/FUND_CLASS_KEY/integralization
METHOD
POST
Request Body
{
"security_external_id": "a23c006c-befd-40e0-bc3d-fbd2dfbbea5d",
"bookkeeper_document_number": "00.000.000/0000-00",
"security_key": "272a394a-e3d0-4484-b00e-e18a4e22bb5e",
"unit_price": "2.00",
"number_of_units": "100.00",
"external_id": "90b679c0-2674-4cad-917a-5c786b0bf992",
"integralization_date": "2025-05-27",
"payment": {
"target_account": {
"account_branch": "0001",
"account_digit": "0",
"account_number": "12345",
"financial_institution_code": "329",
"financial_institution_ispb": "32402502"
}
}
}

Definitions

Purchase Operation

FieldTypeDescriptionRequired
security_external_idstringExternal identifier of the assetYes*
bookkeeper_document_numberstringBookkeeper's CNPJ numberYes*
security_keystringInternal asset keyYes*
unit_pricefloatUnit price in integralizationYes
number_of_unitsfloatNumber of units purchasedYes
external_idstringExternal identifier of the purchase operationYes
integralization_datestringIntegralization dateYes
paymentdictPayment object for settlementYes
⚠️ Important ( * )

The structured asset identification can be done in two ways:

  1. By providing the security_key field (internal key); or
  2. By providing both the security_external_id and bookkeeper_document_number fields.

At least one of the identification methods must be present in the payload. If both are present, the internal key will be considered as priority.

Payment
FieldTypeDescriptionRequired
target_accountstringBank account object for settlementYes
Bank account
FieldTypeDescriptionRequired
account_branchstringBank account branchYes
account_digitstringAccount verification digitYes
account_numberstringBank account numberYes
financial_institution_codestringFinancial institution codeYes
financial_institution_ispbstringFinancial institution ISPB codeYes

Response

STATUS
201
Response Body
{
"integralization_key": "1568b67b-088e-43be-938b-0f817b805f7a",
"external_id": "90b679c0-2674-4cad-917a-5c786b0bf992",
"status": "pending_administrator_approval",
}