Emissões - Integralização
Integralização
Utilizando o endpoint a seguir, é possível iniciar a integralização em uma emissão.
Request
ENDPOINT
/trade_security/fund_class/FUND_CLASS_KEY/integralizationMÉTODO
POSTRequest 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",
"pricing_type": "yield_curve",
"payment": {
"target_account": {
"account_branch": "0001",
"account_digit": "0",
"account_number": "12345",
"financial_institution_code": "329",
"financial_institution_ispb": "32402502"
}
}
}
Definições
Operação de Compra
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
security_external_id | string | Identificador externo do ativo | Sim* |
bookkeeper_document_number | string | Número do CNPJ do escriturador | Sim* |
security_key | string | Chave interna do ativo | Sim* |
unit_price | number | Valor unitário na integralização | Sim |
number_of_units | number | Número de unidades compradas | Sim |
external_id | string | Identificador externo da operação de compra | Sim |
integralization_date | string | Data da integralização | Sim |
pricing_type | string | Precificação do ativo na carteira: yield_curve ou mark_to_market. | Sim |
payment | dict | Objeto de pagamento para liquidação | Sim |
Importante ( * )
A identificação do ativo estruturado pode ser feita de duas formas:
- Informando o campo
security_key(chave interna); ou - Informando ambos os campos
security_external_idebookkeeper_document_number.
Pelo menos uma das formas de identificação deve estar presente no payload. Caso ambas estejam presentes, será considerada a chave interna como prioritária.
Pagamento
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
target_account | object | Objeto de conta bancária para liquidação | Sim |
Conta bancária
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
account_branch | string | Agência da conta bancária | Sim |
account_digit | string | Dígito verificador da conta | Sim |
account_number | string | Número da conta bancária | Sim |
financial_institution_code | string | Código da instituição financeira | Sim |
financial_institution_ispb | string | Código ISPB da instituição financeira | Não |
Response
STATUS
201Response Body
{
"integralization_key": "1568b67b-088e-43be-938b-0f817b805f7a",
"external_id": "90b679c0-2674-4cad-917a-5c786b0bf992",
"status": "pending_administrator_approval"
}
Erros
| Status | Código | Quando acontece |
|---|---|---|
| 400 | QIT000001 | Corpo da requisição inválido: o campo que falhou vem em description. |
Erros de autenticação, permissão e host: veja Erros da API.