# QI Tech — Investment-as-a-Service › Passivo Documentação da QI Tech em texto corrido, para colar em um LLM. Fonte: https://docs.qitech.com.br 34 página(s). Índice: - Adicionar Conta Bancária (/documentation/iaas/investidor/compartilhado/contas_bancarias/adicionar_contas_bancarias) - Atualizar Conta Bancária (/documentation/iaas/investidor/compartilhado/contas_bancarias/atualizar_conta_bancaria) - Consultar Contas Bancárias (/documentation/iaas/investidor/compartilhado/contas_bancarias/buscar_contas_bancarias) - Recuperando Informações da Posição do Investidor (/documentation/iaas/investidor/informacoes_posicao_investidor) - Listagem de Solicitações de Amortização (/documentation/iaas/passivo/amortizacao/listagem) - Consulta paginada de Aplicação Financeira (/documentation/iaas/passivo/aplicacao_financeira/busca_paginada_aplicacoes_financeiras) - Consulta paginada de Fechamento das Aplicações Financeiras (/documentation/iaas/passivo/aplicacao_financeira/busca_paginada_fechamento_das_aplicacoes_financeiras) - Consultar Aplicação Financeira por chave (/documentation/iaas/passivo/aplicacao_financeira/buscar_aplicacao_financeira_por_chave) - Criar Aplicação Financeira (/documentation/iaas/passivo/aplicacao_financeira/criar_aplicacao_financeira) - Aprovação manual de bloqueio de cotas (/documentation/iaas/passivo/bloqueio_de_cotas/aprovar_bloqueio_pendente_aprovacao) - Consultar bloqueio de cotas (/documentation/iaas/passivo/bloqueio_de_cotas/consulta_de_bloqueio_de_cotas) - Consultar bloqueio de cotas de um investidor (/documentation/iaas/passivo/bloqueio_de_cotas/consulta_de_bloqueio_de_cotas_de_um_investidor) - Enviar Documento da Garantia (/documentation/iaas/passivo/bloqueio_de_cotas/enviar_documento_da_garantia) - Enviar Documento do Ativo (/documentation/iaas/passivo/bloqueio_de_cotas/enviar_documento_do_ativo) - Reduzir bloqueio de cotas (/documentation/iaas/passivo/bloqueio_de_cotas/reduzir_bloqueio_de_cotas) - Solicitar bloqueio de cotas (/documentation/iaas/passivo/bloqueio_de_cotas/solicitar_bloqueio_de_cotas) - Webhook de bloqueio de cotas (/documentation/iaas/passivo/bloqueio_de_cotas/webhooks_de_bloqueio_de_cota) - Consulta paginada de investidores por classe de fundo (/documentation/iaas/passivo/consultas/consulta_investidores_classe_fundo) - Consulta paginada de posições de cotistas por classe de fundo (/documentation/iaas/passivo/consultas/consulta_posicoes_cotistas_classe_fundo) - Consulta paginada do Mapa de Evolução de Cotas (/documentation/iaas/passivo/consultas/consultar_mapa_de_evolucao_de_cotas) - Consulta paginada de Séries de Emissão (/documentation/iaas/passivo/consultas/consultar_todas_series_de_emissao) - Consulta paginada de Fundos (/documentation/iaas/passivo/consultas/consultar_todos_fundos) - Enviar Boletim de Subscrição Assinado (/documentation/iaas/passivo/controle_de_oferta/enviar_boletim_de_subscricao_assinado) - Recuperando Informações sobre Boletim de Subscrição (/documentation/iaas/passivo/controle_de_oferta/informacoes_boletins_de_subscricao) - Recuperando Informações sobre as Ofertas (/documentation/iaas/passivo/controle_de_oferta/informacoes_das_ofertas) - Solicitar Boletim de Subscrição (/documentation/iaas/passivo/controle_de_oferta/solicitar_boletim_de_subscricao) - Recuperando Cotas Públicas (/documentation/iaas/passivo/fundos/cotas_publicas) - Introdução (/documentation/iaas/passivo/inicio) - Consultar Pedido de Resgate por chave (/documentation/iaas/passivo/pedido_de_resgate/buscar_pedido_de_resgate_por_chave) - Consulta paginada de pedidos de resgate por classe de fundo (/documentation/iaas/passivo/pedido_de_resgate/consulta_pedidos_resgate_classe_fundo) - Consulta paginada de pedidos de resgate por investidor (/documentation/iaas/passivo/pedido_de_resgate/consulta_pedidos_resgate_investidor) - Criar Pedido de Resgate (/documentation/iaas/passivo/pedido_de_resgate/criar_pedido_de_resgate) - Enviar Termo de Adesão Assinado (/documentation/iaas/passivo/termo_de_adesao/enviar_termo_de_adesao_assinado) - Solicitar Termo de Adesão (/documentation/iaas/passivo/termo_de_adesao/solicitar_termo_de_adesao) --- # Adicionar Conta Bancária URL: /documentation/iaas/investidor/compartilhado/contas_bancarias/adicionar_contas_bancarias --- ### Request ENDPOINT /investor_registry/investor/\{investor_key\}/bank_account MÉTODO POST STATUS 201 ### Request body ```json title='Request Body' { "financial_institution_code": "329", "account_number": "000000", "account_digit": "0", "account_branch": "000" } ``` ### Body params | Campo | Tipo | Descrição | Caracteres | Obrigatório | |-----------------------------------|----------|------------------------------------------------------------------------------|--------------|-------------| | `financial_institution_code` | string | Código da Instituição Financeira | 1 - 4 | Sim | | `account_number` | string | Número de Conta | 1 - 20 | Sim | | `account_digit` | string | Dígito de Conta | 1 | Sim | | `account_branch` | string | Agência | 1 - 4 | Sim | ### Response ```json title='Response Body' { "bank_account_key": "UUID" } ``` ### Erros Tratáveis | Código | Significado | |------------------------------------|-----------------| "IVR000077" | Essa conta já foi cadastrada para o investidor | --- # Atualizar Conta Bancária URL: /documentation/iaas/investidor/compartilhado/contas_bancarias/atualizar_conta_bancaria --- ### Request ENDPOINT /investor_registry/investor/\{investor_key\}/bank_account/\{bank_account_key\}/update MÉTODO PUT STATUS 204 ### Request body ```json title='Request Body' { "status": "str", "main_account": true, } ``` :::warning Atenção Existem três formas de atualizar a conta bancária: - Atualizar o *status* para inactive , desativando o uso da conta. - Atualizar o *status* para active , reativando o uso da conta. - Atualizar a definição de conta principal utilizando a propriedade *main_account* , tornando a conta em questão a principal do investidor. Caso sejam enviados ambos os parâmetros, um erro será retornado. ::: ### Body params | Campo | Tipo | Descrição | Caracteres | Obrigatório | |-----------------------------------|----------|------------------------------------------------------------------------------|--------------|-------------| | `status` | string | Novo Status da Conta | 1 - 20 | Não | | `main_account` | bool | Define se a conta é a principal do investidor | - | Não | --- # Consultar Contas Bancárias URL: /documentation/iaas/investidor/compartilhado/contas_bancarias/buscar_contas_bancarias --- ### Request ENDPOINT /investor/investor/INVESTOR_KEY/bank_accounts MÉTODO GET STATUS 200 ### Query params | Campo | Tipo | Descrição | Opções | Obrigatório | |-----------------------------------|----------|------------------------------------------------------------------------------|--------------|-------------| | `status` | string | Novo Status da Conta | "active" ou "inactive" | Não | | `main_account` | bool | Define se a conta é a principal do investidor | True ou False | Não | ### Responses ```json { "data": [ { "bank_account_key": "UUID4", "financial_institution_code": "329", "account_number": "00000000", "account_digit": "0", "account_branch": "0001", "main_account": true, "status": "active" }, { "bank_account_key": "UUID4", "financial_institution_code": "329", "account_number": "00000000", "account_digit": "0", "account_branch": "0001", "main_account": false, "status": "inactive" } ], "limit": 50, "page": 0, "is_last_page": true } ``` --- # Recuperando Informações da Posição do Investidor URL: /documentation/iaas/investidor/informacoes_posicao_investidor --- ### Request ENDPOINT /quota/investor/INVESTOR_KEY/investor_positions MÉTODO GET ### Query Params | Parâmetro | Descrição | |------------------------------|--------------------------------------------------------------------------------------| | `issuance_serie_key` | Chave única de identificação da série de emissão | | `only_above_zero` | Posições atuais com número de cotas maior que zero | | `fund_class_document_number` | CNPJ do Fundo | ### Responses STATUS 200 Caso 01: Investidor com Posição em somente uma série de COTA ÚNICA ```json { "data": [ { "investor_position_key":"UUID", "investor": { "distributor": { "distributor_key": "UUID", "document_number": "00.000.000/0000-00", "name": "SAMPLE DISTRIBUTOR NAME", "account_data": { "owner": { "name": "SAMPLE DISTRIBUTOR NAME", "document_number": "00.000.000/0000-00" }, "account_digit": "0", "account_branch": "0000", "account_number": "00000", "financial_institution_code": "000", "financial_institution_ispb": "00000000" } }, "investor_key": "UUID", "document_number": "00.000.000/0000-00", "name": "SAMPLE INVESTOR NAME", "person_type": "natural_person / legal_person / fund_class", "account_data": { "account_digit": "0", "account_branch": "0000", "account_number": "00000", "financial_institution_code": "000", "financial_institution_ispb": "00000000" }, "investor_sub_type": "person / financial_institution" }, "total_net_worth": 0.00, "total_number_of_quotas": 0.00000000000000, "issuance_serie": { "name": "1", "cetip_code": "0000000UN1", "start_date": "YYYY-MM-DD", "maturity_date": "YYYY-MM-DD", "original_quota_value": 0.00000000000000, "remuneration_type": "residual", "investment_category": "fidc / multi_market", "condominum_type": "open_ended / close_ended", "tax_classification": "short_term / long_term", "investment_restriction_type": "just_professional", "issuance_serie_key": "UUID", "minimum_share_capital": 0.0, "accounting_date": "YYYY-MM-DD", "sub_class": { "name": "COTA ÚNICA", "sub_class_key": "UUID", "subordination_level": 0, "fund_class": { "name": "SAMPLE FUND CLASS NAME", "fund_class_key": "UUID", "document_number": "00.000.000/0000-00" } } } }, ], "limit": 50, "page": 0, "is_last_page": true } ``` Caso 02: Investidor com Posição em somente uma série de COTA SÊNIOR ```json { "data": [ { "investor_position_key":"UUID", "investor": { "distributor": { "distributor_key": "UUID", "document_number": "00.000.000/0000-00", "name": "SAMPLE DISTRIBUTOR NAME", "account_data": { "owner": { "name": "SAMPLE DISTRIBUTOR NAME", "document_number": "00.000.000/0000-00" }, "account_digit": "0", "account_branch": "0000", "account_number": "00000", "financial_institution_code": "000", "financial_institution_ispb": "00000000" } }, "investor_key": "UUID", "document_number": "00.000.000/0000-00", "name": "SAMPLE INVESTOR NAME", "person_type": "natural_person / legal_person / fund_class", "account_data": { "account_digit": "0", "account_branch": "0000", "account_number": "00000", "financial_institution_code": "000", "financial_institution_ispb": "00000000" }, "investor_sub_type": "person / financial_institution" }, "total_net_worth": 0.00, "total_number_of_quotas": 0.00000000000000, "issuance_serie": { "name": "1", "cetip_code": "0000000SN1", "start_date": "YYYY-MM-DD", "maturity_date": "YYYY-MM-DD", "original_quota_value": 0.00000000000000, "remuneration_type": "yield_curve", "interest_rate_type": "post_fixed", "pre_fixed": { "calendar_base": "workdays / calendar_360 / calendar_365", "monthly_rate": 0.00000000000000 }, "post_fixed": { "calendar_base": "workdays / calendar_360 / calendar_365", "indexer": "di / ipca", "rate": 1, "lag": {"reference": "daily / monthly", "amount": 1}, }, "investment_category": "fidc / multi_market", "condominum_type": "open_ended / close_ended", "tax_classification": "short_term / long_term", "investment_restriction_type": "just_professional", "issuance_serie_key": "UUID", "minimum_share_capital": 0.0, "accounting_date": "YYYY-MM-DD", "sub_class": { "name": "COTA SÊNIOR", "sub_class_key": "UUID", "subordination_level": 1, "fund_class": { "name": "SAMPLE FUND CLASS NAME", "fund_class_key": "UUID", "document_number": "00.000.000/0000-00" } } } }, ], "limit": 50, "page": 0, "is_last_page": true } ``` Caso 03: Investidor com Posição em duas uma séries, uma COTA SÊNIOR e uma COTA SUBORDINADA ```json { "data":[ { "investor_position_key":"UUID", "investor":{ "distributor":{ "distributor_key":"UUID", "document_number":"00.000.000/0000-00", "name":"SAMPLE DISTRIBUTOR NAME", "account_data":{ "owner":{ "name":"SAMPLE DISTRIBUTOR NAME", "document_number":"00.000.000/0000-00" }, "account_digit":"0", "account_branch":"0000", "account_number":"00000", "financial_institution_code":"000", "financial_institution_ispb":"00000000" } }, "investor_key":"UUID", "document_number":"00.000.000/0000-00", "name":"SAMPLE INVESTOR NAME", "person_type":"natural_person / legal_person / fund_class", "account_data":{ "account_digit":"0", "account_branch":"0000", "account_number":"00000", "financial_institution_code":"000", "financial_institution_ispb":"00000000" }, "investor_sub_type":"person / financial_institution" }, "total_net_worth":0.00, "total_number_of_quotas":0.00000000000000, "issuance_serie":{ "name":"1", "cetip_code":"0000000SN1", "start_date":"YYYY-MM-DD", "maturity_date":"YYYY-MM-DD", "original_quota_value":0.00000000000000, "remuneration_type":"yield_curve", "interest_rate_type":"post_fixed", "pre_fixed":{ "calendar_base":"workdays / calendar_360 / calendar_365", "monthly_rate":0.00000000000000 }, "post_fixed":{ "calendar_base":"workdays / calendar_360 / calendar_365", "indexer":"di / ipca", "rate":1, "lag":{ "reference":"daily / monthly", "amount":1 } }, "investment_category":"fidc / multi_market", "condominum_type":"open_ended / close_ended", "tax_classification":"short_term / long_term", "investment_restriction_type":"just_professional", "issuance_serie_key":"UUID", "minimum_share_capital":0.0, "accounting_date":"YYYY-MM-DD", "sub_class":{ "name":"COTA SÊNIOR", "sub_class_key":"UUID", "subordination_level":1, "fund_class":{ "name":"SAMPLE FUND CLASS NAME", "fund_class_key":"UUID", "document_number":"00.000.000/0000-00" } } } }, { "investor_position_key":"UUID", "investor":{ "distributor":{ "distributor_key":"UUID", "document_number":"00.000.000/0000-00", "name":"SAMPLE DISTRIBUTOR NAME", "account_data":{ "owner":{ "name":"SAMPLE DISTRIBUTOR NAME", "document_number":"00.000.000/0000-00" }, "account_digit":"0", "account_branch":"0000", "account_number":"00000", "financial_institution_code":"000", "financial_institution_ispb":"00000000" } }, "investor_key":"UUID", "document_number":"00.000.000/0000-00", "name":"SAMPLE INVESTOR NAME", "person_type":"natural_person / legal_person / fund_class", "account_data":{ "account_digit":"0", "account_branch":"0000", "account_number":"00000", "financial_institution_code":"000", "financial_institution_ispb":"00000000" }, "investor_sub_type":"person / financial_institution" }, "total_net_worth":0.00, "total_number_of_quotas":0.00000000000000, "issuance_serie":{ "name":"1", "cetip_code":"0000000JR1", "start_date":"YYYY-MM-DD", "maturity_date":"YYYY-MM-DD", "original_quota_value":0.00000000000000, "remuneration_type":"residual", "investment_category":"fidc / multi_market", "condominum_type":"open_ended / close_ended", "tax_classification":"short_term / long_term", "investment_restriction_type":"just_professional", "issuance_serie_key":"UUID", "minimum_share_capital":0.0, "accounting_date":"YYYY-MM-DD", "sub_class":{ "name":"COTA SUBORDINADA", "sub_class_key":"UUID", "subordination_level":0, "fund_class":{ "name":"SAMPLE FUND CLASS NAME", "fund_class_key":"UUID", "document_number":"00.000.000/0000-00" } } } } ], "limit":50, "page":0, "is_last_page":true } ``` ### Response Fields | Campo | Tipo | Descrição | |---------------|--------|----------------------------------------------------------------| | `data` | array | Lista de objetos de **[Investor Position](#investor_position)**| | `limit` | int | Limite de objetos recuperados por página | | `page` | int | Número da página recuperada | | `is_last_page`| boolean| Informação que indica se a página recuperada é a última | ### Investor Position | Campo | Tipo | Descrição | |--------------------------|--------|-------------------------------------------------------| | `investor` | JSON | Objeto de **[Investor](#investor)** | | `total_net_worth` | float | Patrimônio Líquido da posição do investidor | | `total_number_of_quotas` | float | Número de cotas da posição do investidor | | `issuance_serie` | JSON | Objeto de **[Issuance Serie](#issuance_serie)** | | `investor_position_key` | JSON | Chave única de identificação da posição do investidor | ### Investor | Campo | Tipo | Descrição | Caracteres | |--------------------------|----------|---------------------------------------------------|------------| | `name` | string | Nome do investidor | até 255 | | `investor_key` | string | Chave única de identificação do investidor | 36 | | `document_number` | string | CPF/CNPJ do investidor | 14 ou 18 | | `person_type` | string | Pessoa Física / Pessoa Jurídica / Classe de Fundo | até 50 | | `investor_sub_type` | string | Default / Instituição Financeira | até 50 | | `distributor` | JSON | Objeto de **[Distributor](#distributor)** | - | | `account_data` | JSON | Objeto de **[Account Data](#account_data)** | - | ### Distributor | Campo | Tipo | Descrição | Caracteres | |--------------------------|----------|---------------------------------------------------|------------| | `name` | string | Nome do distribuidor | até 255 | | `distributor_key` | string | Chave única de identificação do distribuidor | - | | `document_number` | string | CPF/CNPJ do distribuidor | 14 ou 18 | | `account_data` | JSON | Objeto de **[Account Data](#account_data)** | - | ### Account Data | Campo | Tipo | Descrição | |------------------------------|----------|-----------------------------------------------------------------------------| | `account_digit` | string | Dígito da conta bancária | | `account_branch` | string | N° da agência da conta bancária | | `account_number` | string | N° da conta bancária | | `financial_institution_code` | string | Código da instituição financeira | | `financial_institution_ispb` | string | Identificador no Sistema de Pagamento Brasileiro da instituição financeira | ### Issuance Serie | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|---------------------------------------------------|------------| | `name` | string | Nome da série de emissão | até 255 | | `issuance_serie_key` | string | Chave única de identificação da série de emissão | 36 | | `cetip_code` | string | Código da série de emissão como ativo na CETIP | 10 | | `start_date` | string | Data de início da série de emissão | 10 | | `maturity_date` | string | Data de vencimento da série de emissão | 10 | | `original_quota_value` | float | Valor de cota original | - | | `remuneration_type` | string | Curva de rendimento / Residual | até 50 | | `investment_category` | string | FIDC / Multimercado | até 50 | | `condominum_type` | string | Aberto / Fechado | até 50 | | `tax_classification` | string | Curto prazo / Longo prazo | até 50 | | `investment_restriction_type` | string | Sem restrição / Qualificado / Profissional | até 50 | | `minimum_share_capital` | float | Valor mínimo para aplicação | - | | `accounting_date` | string | Data contábil da série de emissão | 10 | | `sub_class` | JSON | Objeto de **[Sub Class](#sub_class)** | - | ### Sub Class | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|---------------------------------------------------|------------| | `name` | string | Nome da sub classe | até 255 | | `sub_class_key` | string | Chave única de identificação da sub classe | 36 | | `subordination_level` | int | Nível de subordinação da sub classe | - | | `fund_class` | JSON | Objeto de **[Fund Class](#fund_class)** | - | ### Fund Class | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|---------------------------------------------------|------------| | `name` | string | Nome da classe de fundo | até 255 | | `fund_class_key` | string | Chave única de identificação da classe de fundo | 36 | | `document_number` | string | CNPJ da classe de fundo | - | --- # Listagem de Solicitações de Amortização URL: /documentation/iaas/passivo/amortizacao/listagem Endpoint de consulta paginada que retorna as solicitações de amortização de uma determinada classe de fundo. A resposta inclui, para cada solicitação, os dados financeiros calculados, o histórico de status, as amortizações por investidor e os dados da série de emissão vinculada. :::info Filtros de retorno Por padrão, todos os sub-objetos (`issuance_serie`, `investor_amortizations` e `status_events`) são retornados. Utilize os query params `dto_filters_*` para omitir campos e reduzir o tamanho da resposta. ::: ## Request ENDPOINT /quota/fund_class/{fund_class_key}/amortization_requests MÉTODO GET ### Path params | Parâmetro | Tipo | Descrição | |---|---|---| | `fund_class_key` | string | Chave única da classe de fundo (UUID). | ### Query params | Parâmetro | Tipo | Obrigatoriedade | Descrição | |---|---|---|---| | `page` | integer | opcional | Número da página (começa em 0). Padrão: `0`. | | `limit` | integer | opcional | Quantidade de registros por página. Padrão: `20`. Máximo: `100`. | | `dto_filters_issuance_serie` | boolean | opcional | Quando `true`, omite o objeto `issuance_serie` de cada item. Padrão: `false`. | | `dto_filters_investor_amortizations` | boolean | opcional | Quando `true`, omite o array `investor_amortizations` de cada item. Padrão: `false`. | | `dto_filters_status_events` | boolean | opcional | Quando `true`, omite o array `status_events` de cada item. Padrão: `false`. | ```python title="Exemplo de chamada" GET /quota/fund_class/{fund_class_key}/amortization_requests?page=0&limit=20 ``` ## Response STATUS 200 ```json title="Response Body" { "data": [ { "amortization_request_key": "3571e292-3a83-4011-904d-20ee963022ef", "type": "scheduled_amortization", "regime_type": "issuance_serie_principal_percentage", "quotation_date": "2026-06-05", "principal_percentage": 0.5, "financial_application_yield_percentage": 0.12, "gross_value": 10000.0, "result_quota_value": 1.05, "amortization_value": 5000.0, "net_value": 4750.0, "quota_percentage": 0.5, "status": "done", "status_events": [ { "status": "created", "event_datetime": "2026-06-01T10:00:00.000Z" }, { "status": "done", "event_datetime": "2026-06-05T14:30:00.000Z" } ], "investor_amortizations": [ { "investor_amortization_key": "f1e2d3c4-b5a6-7890-fedc-ba9876543210", "investor": { "investor_key": "aaaa1111-bbbb-2222-cccc-dddd33334444", "name": "Investidor Exemplo S.A.", "person_type": "legal", "document_number": "12.345.678/0001-99", "distributor": { "distributor_key": "dddd4444-eeee-5555-ffff-aaaa66667777", "name": "Distribuidora Exemplo", "document_number": "98.765.432/0001-11", "account_data": { "bank": "341", "agency": "1234", "account": "56789-0" } } }, "status": "done", "net_value": 4750.0, "ir_value": 200.0, "iof_value": 50.0, "ir_compensation": 0.0, "iof_compensation": 0.0, "total_value": 5000.0, "payment_method": "regular", "payment_date": "2026-06-06", "status_events": [ { "status": "created", "event_datetime": "2026-06-01T10:00:00.000Z" }, { "status": "done", "event_datetime": "2026-06-06T09:00:00.000Z" } ], "amortizations": [ { "financial_application_key": "fa111111-2222-3333-4444-555566667777", "amortization_key": "am888888-9999-aaaa-bbbb-ccccddddeeee", "status": "settled", "principal_reduction": 2500.0, "acquisition_cost_reduction": 0.0, "yield_value": 300.0, "total_value": 2800.0, "ir_value": 100.0, "iof_value": 25.0, "taxable_yield_value": 300.0 } ], "payments": [ { "payment_key": "pp000000-1111-2222-3333-444455556666", "origin_key": "f1e2d3c4-b5a6-7890-fedc-ba9876543210", "total_value": 4750.0, "target_account": { "bank": "341", "agency": "1234", "account": "56789-0" }, "payment_type": "amortization_payment.investor", "payment_date": "2026-06-06", "status": "paid", "status_events": [ { "status": "paid", "event_datetime": "2026-06-06T09:15:00.000Z" } ] } ] } ], "issuance_serie": { "issuance_serie_key": "is111111-2222-3333-4444-555566667777", "name": "Série A - Cota Sênior", "serie": 1, "original_quota_value": 1.0, "current_quota_value": 1.05, "current_number_of_quotas": 1000000.0, "current_net_worth": 1050000.0, "current_principal_value": 1000000.0, "performance_fee_current_value": 0.0, "remuneration_type": "cdi_plus", "minimum_share_capital": 1000.0, "status": "active", "internal_code": "SR-001", "processing_method": "pro_rata", "operation_period_configuration": { "subscription_days": [1, 2, 3, 4, 5], "redemption_days": [1, 2, 3, 4, 5] }, "sub_class": { "sub_class_key": "sc222222-3333-4444-5555-666677778888", "name": "Classe Sênior", "subordination_level": 1, "fund_class": { "fund_class_key": "fc333333-4444-5555-6666-777788889999", "name": "Fundo de Investimento em Direitos Creditórios Exemplo", "short_name": "FIDC Exemplo", "document_number": "11.222.333/0001-44", "accounting_date": "2026-06-09", "sub_type": "exclusive", "tax_classification": "long_term", "condominum_type": "closed", "investment_category": "credit_rights", "prevent_payment": false, "manager": { "manager_key": "mg444444-5555-6666-7777-888899990000", "name": "Gestora Exemplo DTVM", "document_number": "55.666.777/0001-88" } } } } } ], "limit": 20, "page": 0, "is_last_page": true } ``` ### Atributos da resposta | Campo | Tipo | Descrição | |---|---|---| | `data` | array | Lista de solicitações de amortização. Veja tabela abaixo. | | `page` | integer | Número da página atual. | | `limit` | integer | Quantidade de registros por página. | | `is_last_page` | boolean | Indica se esta é a última página de resultados. | #### Atributos de cada solicitação (objetos dentro de `data`) | Campo | Tipo | Descrição | |---|---|---| | `amortization_request_key` | string | Identificador único da solicitação (UUID). | | `type` | string | Tipo da amortização. Consulte os [enumeradores de tipo](#enumeradores-de-type) abaixo. | | `regime_type` | string | Regime de cálculo da amortização. Consulte os [enumeradores de regime](#enumeradores-de-regime_type) abaixo. | | `quotation_date` | string | Data de cotação no formato `YYYY-MM-DD`. | | `principal_percentage` | number | Percentual do principal a ser amortizado. Presente conforme o `regime_type`. | | `financial_application_yield_percentage` | number | Percentual de rendimento da aplicação financeira. Presente conforme o `regime_type`. | | `gross_value` | number | Valor bruto total da amortização em reais. | | `result_quota_value` | number | Valor da cota resultante após a amortização. | | `amortization_value` | number | Valor total a ser amortizado em reais. | | `net_value` | number | Valor líquido total após impostos em reais. | | `quota_percentage` | number | Percentual de cotas resgatadas. Presente conforme o `regime_type`. | | `status` | string | Status atual da solicitação. Consulte os [enumeradores de status](#enumeradores-de-status) abaixo. | | `status_events` | array | Histórico de transições de status. Omitido se `dto_filters_status_events=true`. Veja tabela abaixo. | | `investor_amortizations` | array | Lista de amortizações individuais por investidor. Omitido se `dto_filters_investor_amortizations=true`. Veja tabela abaixo. | | `issuance_serie` | object | Dados da série de emissão vinculada. Omitido se `dto_filters_issuance_serie=true`. Veja tabela abaixo. | #### Atributos de `status_events` | Campo | Tipo | Descrição | |---|---|---| | `status` | string | Status do evento. | | `event_datetime` | string | Data e hora do evento no formato ISO 8601 (ex: `2026-06-01T10:00:00.000Z`). | #### Atributos de `investor_amortizations` | Campo | Tipo | Descrição | |---|---|---| | `investor_amortization_key` | string | Identificador único da amortização do investidor (UUID). | | `investor` | object | Dados do investidor. Veja tabela abaixo. | | `status` | string | Status da amortização do investidor. Consulte os [enumeradores de status do investidor](#enumeradores-de-status-do-investor_amortization) abaixo. | | `net_value` | number | Valor líquido a pagar ao investidor em reais. | | `ir_value` | number | Valor de IR retido em reais. | | `iof_value` | number | Valor de IOF retido em reais. | | `ir_compensation` | number | Compensação de IR em reais. | | `iof_compensation` | number | Compensação de IOF em reais. | | `total_value` | number | Valor total bruto em reais. Presente após o cálculo. | | `payment_method` | string | Método de pagamento. Consulte os [enumeradores de método de pagamento](#enumeradores-de-payment_method) abaixo. | | `payment_date` | string | Data prevista do pagamento no formato `YYYY-MM-DD`. | | `status_events` | array | Histórico de transições de status do investidor. Mesma estrutura de `status_events` da solicitação. | | `amortizations` | array | Detalhamento por aplicação financeira. Veja tabela abaixo. | | `payments` | array | Lista de pagamentos gerados. Veja tabela abaixo. | #### Atributos de `investor` | Campo | Tipo | Descrição | |---|---|---| | `investor_key` | string | Chave única do investidor (UUID). | | `name` | string | Nome do investidor. | | `person_type` | string | Tipo de pessoa (`natural` ou `legal`). | | `document_number` | string | CPF ou CNPJ do investidor. Presente quando disponível. | | `external_id` | string | Identificador externo do investidor. Presente quando informado. | | `external_distribution_key` | string | Chave de distribuição externa. Presente quando informada. | | `short_name` | string | Nome abreviado. Presente quando informado. | | `sub_type` | string | Subtipo do investidor. Presente quando informado. | | `distributor` | object | Dados da distribuidora vinculada. Veja tabela abaixo. | #### Atributos de `distributor` | Campo | Tipo | Descrição | |---|---|---| | `distributor_key` | string | Chave única da distribuidora (UUID). | | `name` | string | Nome da distribuidora. | | `document_number` | string | CNPJ da distribuidora. | | `account_data` | object | Dados bancários da distribuidora. | #### Atributos de `amortizations` | Campo | Tipo | Descrição | |---|---|---| | `financial_application_key` | string | Chave da aplicação financeira (UUID). | | `amortization_key` | string | Chave única da amortização (UUID). | | `status` | string | Status da amortização. | | `principal_reduction` | number | Redução de principal em reais. | | `acquisition_cost_reduction` | number | Redução de custo de aquisição em reais. | | `yield_value` | number | Valor de rendimento em reais. Presente quando calculado. | | `total_value` | number | Valor total em reais. Presente quando calculado. | | `ir_value` | number | Valor de IR em reais. Presente quando calculado. | | `iof_value` | number | Valor de IOF em reais. Presente quando calculado. | | `taxable_yield_value` | number | Valor de rendimento tributável em reais. Presente quando calculado. | #### Atributos de `payments` | Campo | Tipo | Descrição | |---|---|---| | `payment_key` | string | Chave única do pagamento (UUID). | | `origin_key` | string | Chave da origem do pagamento (UUID). | | `total_value` | number | Valor total do pagamento em reais. | | `target_account` | object | Dados da conta de destino. | | `description` | string | Descrição do pagamento. Presente quando informada. | | `payment_type` | string | Tipo do pagamento. Consulte os [enumeradores de tipo de pagamento](#enumeradores-de-payment_type) abaixo. | | `payment_date` | string | Data do pagamento no formato `YYYY-MM-DD`. | | `status` | string | Status do pagamento. Consulte os [enumeradores de status do pagamento](#enumeradores-de-status-do-payment) abaixo. | | `deleted_at` | string | Data e hora de exclusão no formato ISO 8601. Presente apenas quando o pagamento foi cancelado. | | `status_events` | array | Histórico de transições de status do pagamento. Mesma estrutura de `status_events` da solicitação. | #### Atributos de `issuance_serie` | Campo | Tipo | Descrição | |---|---|---| | `issuance_serie_key` | string | Chave única da série de emissão (UUID). | | `name` | string | Nome da série de emissão. | | `serie` | integer | Número da série. | | `original_quota_value` | number | Valor original da cota em reais. | | `current_quota_value` | number | Valor atual da cota em reais (calculado como `current_net_worth / current_number_of_quotas`). | | `current_number_of_quotas` | number | Quantidade atual de cotas em circulação. | | `current_net_worth` | number | Patrimônio líquido atual em reais. | | `current_principal_value` | number | Valor de principal atual em reais. | | `performance_fee_current_value` | number | Valor atual de taxa de performance em reais. | | `remuneration_type` | string | Tipo de remuneração da série. | | `minimum_share_capital` | number | Capital mínimo em reais. | | `status` | string | Status da série de emissão. | | `internal_code` | string | Código interno da série. | | `processing_method` | string | Método de processamento (ex: `pro_rata`). | | `operation_period_configuration` | object | Configuração de períodos operacionais da série. | | `pre_fixed` | number | Taxa pré-fixada. Presente quando aplicável. | | `post_fixed` | object | Dados do indexador pós-fixado. Presente quando aplicável. | | `interest_rate_type` | string | Tipo de taxa de juros. Presente quando aplicável. | | `isin_code` | string | Código ISIN da série. Presente quando informado. | | `external_id` | string | Identificador externo. Presente quando informado. | | `specific_interest_rate_data` | object | Dados específicos de taxa de juros. Presente quando aplicável. | | `fixed_principal_value` | number | Valor de principal fixo. Presente quando aplicável. | | `sub_class` | object | Dados da subclasse vinculada. Veja tabela abaixo. | #### Atributos de `sub_class` | Campo | Tipo | Descrição | |---|---|---| | `sub_class_key` | string | Chave única da subclasse (UUID). | | `name` | string | Nome da subclasse. | | `subordination_level` | integer | Nível de subordinação da subclasse. | | `fund_class` | object | Dados da classe de fundo. Veja tabela abaixo. | #### Atributos de `fund_class` | Campo | Tipo | Descrição | |---|---|---| | `fund_class_key` | string | Chave única da classe de fundo (UUID). | | `name` | string | Nome do fundo. | | `short_name` | string | Nome abreviado do fundo. | | `document_number` | string | CNPJ do fundo. | | `accounting_date` | string | Data contábil vigente no formato `YYYY-MM-DD`. | | `sub_type` | string | Subtipo do fundo. | | `tax_classification` | string | Classificação tributária do fundo. | | `condominum_type` | string | Tipo de condomínio do fundo. | | `investment_category` | string | Categoria de investimento. | | `prevent_payment` | boolean | Indica se pagamentos estão bloqueados para o fundo. | | `manager` | object | Dados do gestor do fundo. | | `administrator` | object | Dados do administrador. Presente quando informado. | | `integralization_account_key` | string | Chave da conta de integralização (UUID). Presente quando informada. | ## Enumeradores de `type` | Valor | Descrição | |---|---| | `scheduled_amortization` | Amortização programada/agendada | | `extraordinary_amortization` | Amortização extraordinária | ## Enumeradores de `regime_type` | Valor | Descrição | |---|---| | `cash_availability` | Baseado na disponibilidade de caixa | | `issuance_serie_principal_percentage` | Percentual do principal da série de emissão | | `quota_percentage` | Percentual de cotas | | `financial_application_principal_percentage` | Percentual do principal da aplicação financeira | | `net_value` | Valor líquido fixo | | `gross_value` | Valor bruto fixo | | `financial_application_yield_percentage` | Percentual de rendimento da aplicação financeira | ## Enumeradores de `status` | Status | Descrição | |---|---| | `created` | Solicitação criada | | `waiting_quotation_date` | Aguardando data de cotação | | `pending_inputs` | Aguardando dados de entrada | | `processing_calculation` | Cálculo em processamento | | `processing_investor_amortizations` | Processando amortizações dos investidores | | `pending_manual_approval` | Aguardando aprovação manual | | `processing_approval` | Aprovação em processamento | | `processing_issuance_serie_impacts` | Processando impactos na série de emissão | | `reprocessed` | Reprocessada | | `reproved` | Reprovada | | `done` | Concluída | ## Enumeradores de status do `investor_amortization` | Status | Descrição | |---|---| | `created` | Amortização do investidor criada | | `pending_quote` | Aguardando cotação | | `processing_approval` | Aprovação em processamento | | `pending_manual_approval` | Aguardando aprovação manual | | `done` | Concluída | | `reproved` | Reprovada | ## Enumeradores de `payment_method` | Valor | Descrição | |---|---| | `regular` | Pagamento padrão (TED/PIX) | | `b3` | Pagamento via B3 | ## Enumeradores de `payment_type` | Valor | Descrição | |---|---| | `amortization_payment.investor` | Pagamento de amortização ao investidor | | `amortization_payment.ir` | Recolhimento de IR da amortização | | `amortization_payment.iof` | Recolhimento de IOF da amortização | | `amortization_payment.collateral` | Pagamento de garantia da amortização | | `redemption.investor` | Pagamento de resgate ao investidor | | `redemption.ir` | Recolhimento de IR do resgate | | `redemption.iof` | Recolhimento de IOF do resgate | | `redemption.integralization_iof` | Recolhimento de IOF de integralização do resgate | | `redemption.tax_anticipation` | Antecipação de tributos do resgate | ## Enumeradores de status do `payment` | Status | Descrição | |---|---| | `created` | Pagamento criado | | `pending_payment` | Aguardando pagamento | | `pending_manual_approval` | Aguardando aprovação manual | | `pending_confirmation` | Aguardando confirmação | | `pending_accounting_date` | Aguardando data contábil | | `paid` | Pago | | `canceled` | Cancelado | --- # Consulta paginada de Aplicação Financeira URL: /documentation/iaas/passivo/aplicacao_financeira/busca_paginada_aplicacoes_financeiras --- ### Requests Requisição por cotista: este endpoint retornará todas as aplicações financeiras de um cotista ENDPOINT /quota/investor/INVESTOR_KEY/financial_applications MÉTODO GET STATUS 200 Requisição por fundo: este endpoint retornará todas as aplicações financeiras de um fundo ENDPOINT /quota/fund_class/FUND_CLASS_KEY/financial_applications MÉTODO GET STATUS 200 ### Query Params | Parâmetro | Descrição | |------------------|--------------------------------------------------------------------------------------| | `quotation_date` | Data de cotização das aplicações | | `status` | Lista de **[Financial Application Status](#financial_application_status)** desejados | | `application_from_datetime` | Retorna apenas as aplicações com data/hora de aplicação maior ou igual ao valor informado. | | `application_to_datetime` | Retorna apenas as aplicações com data/hora de aplicação menor ou igual ao valor informado. | | `issuance_serie_key` | Filtra as aplicações por série de emissão | | `types` | Lista de tipos de aplicação desejados (ex.: primary_market, secondary_market) | | `fund_class_document_number` | Filtra por CNPJ da classe de fundo _(somente na consulta por cotista)_ | | `manager_key` | Filtra pelo gestor _(somente na consulta por cotista)_ | | `investor_name` | Filtra pelo nome do investidor _(somente na consulta por fundo)_ | | `investor_document_number` | Filtra pelo CPF/CNPJ do investidor _(somente na consulta por fundo)_ | ### Responses Caso 01: Consulta bem-sucedida ```json { "data": [ { "external_id": "", "financial_application_key": "UUID", "share_capital": 0.00, "investor_position": { "investor": { "investor_key": "UUID", "document_number": "999.999.999-99" | "99.999.999/9999-99", "name": "", "person_type": "natural_person" | "legal_person", "account_data": { "owner": { "name": "", "document_number": "99.999.999/9999-99" }, "account_digit": "0", "account_branch": "0000", "account_number": "00000", "financial_institution_code": "000", "financial_institution_ispb": "00000000" }, "distributor": { "distributor_key": "UUID", "document_number": "99.999.999/9999-99", "name": "", "account_data": { "owner": { "name": "", "document_number": "99.999.999/9999-99" }, "account_digit": "0", "account_branch": "0000", "account_number": "00000", "financial_institution_code": "000", "financial_institution_ispb": "00000000" }, } }, "total_net_worth": 0.00, "total_number_of_quotas": 0.00000000, "issuance_serie": {}, "investor_position_key":"UUID" }, "original_principal_value": 0.00000000, "current_principal_value": 0.00000000, "original_number_of_units": 0.00000000, "current_number_of_units": 0.00000000, "quotation_date": "yyyy-mm-dd", "application_datetime": "YYYY-MM-DDTHH:MM:SSZ", "status": "pending_payment" | "pending_quote" | "quoted" | "settled" | "redeemed" | "canceled", "status_events": [ { "event_datetime": "yyyy-mm-dd HH:MM:SS:ms", "status": "pending_payment" | "pending_quote" | "quoted" | "settled" | "redeemed" | "canceled", } ], "capital_returns": [ { "capital_return_key": "UUID", "origin_key": "UUID", "net_value": 0.00, "iof_value": 0.00, "ir_value": 0.00, "payment_date": "yyyy-mm-dd", "capital_return_date": "yyyy-mm-dd", "status": "", "capital_return_type": "", "number_of_units": "", } ], } ], "limit": 50, "page": 0, "is_last_page": true } ``` ### Page | Campo | Tipo | Descrição | |---------------|--------|------------------------------------------------------------------------------| | `data` | array | Lista de objetos de **[Financial Application](#financial_application)** | | `limit` | int | Limite de objetos recuperados por página | | `page` | int | Número da página recuperada | | `is_last_page`| boolean| Informação que indica se a página recuperada é a última | ### Financial Application | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|---------------------------------------------------------------------------------|------------| | `external_id` | string | Identificador externo | até 100 | | `financial_application_key` | string | Chave única de identificação da aplicação financeira | 36 | | `share_capital` | float | Valor do aporte | - | | `investor_position` | JSON | Objeto de **[Investor Position](#investor_position)** | - | | `original_principal_value` | float | Valor original de principal por cota | - | | `current_principal_value` | float | Valor atual de principal por cota | - | | `original_number_of_units` | float | Quantidade original de cotas | - | | `current_number_of_units` | float | Quantidade atual de cotas | - | | `quotation_date` | string | Data da cotização | - | | `application_datetime` | string | Data da criação da aplicação financeira | - | | `status` | string | Enumerador de **[Financial Application Status](#financial_application_status)** | - | | `status_events` | array | Lista de objetos de **[Status Event](#status_event)** | - | | `capital_returns` | array | Lista de objetos de **[Capital Return](#capital_return)** | - | ### Financial Application Status | Enumerador | Descrição | |--------------------------|-------------------------------------------------| | `pending_payment` | Pendente pagamento | | `pending_quote` | Pendente cotização | | `quoted` | Cotizado | | `settled` | Totalmente amortizado | | `redeemed` | Totalmente resgatado | | `canceled` | cancelado | ### Investor Position | Campo | Tipo | Descrição | |--------------------------|--------|-------------------------------------------------------| | `investor` | JSON | Objeto de **[Investor](#investor)** | | `total_net_worth` | float | Patrimônio Líquido da posição do investidor | | `total_number_of_quotas` | float | Número de cotas da posição do investidor | | `issuance_serie` | JSON | Objeto de **[Issuance Serie](#issuance_serie)** | | `investor_position_key` | JSON | Chave única de identificação da posição do investidor | ### Investor | Campo | Tipo | Descrição | Caracteres | |--------------------------|----------|---------------------------------------------------|------------| | `name` | string | Nome do investidor | até 255 | | `investor_key` | string | Chave única de identificação do investidor | 36 | | `document_number` | string | CPF/CNPJ do investidor | 14 ou 18 | | `person_type` | string | Pessoa Física / Pessoa Jurídica / Classe de Fundo | até 50 | | `distributor` | JSON | Objeto de **[Distributor](#distributor)** | - | | `account_data` | JSON | Objeto de **[Account Data](#account_data)** | - | ### Distributor | Campo | Tipo | Descrição | Caracteres | |--------------------------|----------|---------------------------------------------------|------------| | `name` | string | Nome do distribuidor | até 255 | | `distributor_key` | string | Chave única de identificação do distribuidor | - | | `document_number` | string | CPF/CNPJ do distribuidor | 14 ou 18 | | `account_data` | JSON | Objeto de **[Account Data](#account_data)** | - | ### Account Data | Campo | Tipo | Descrição | |------------------------------|----------|-----------------------------------------------------------------------------| | `account_digit` | string | Dígito da conta bancária | | `account_branch` | string | N° da agência da conta bancária | | `account_number` | string | N° da conta bancária | | `financial_institution_code` | string | Código da instituição financeira | | `financial_institution_ispb` | string | Identificador no Sistema de Pagamento Brasileiro da instituição financeira | ### Issuance Serie | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|---------------------------------------------------|------------| | `name` | string | Nome da série de emissão | até 255 | | `issuance_serie_key` | string | Chave única de identificação da série de emissão | 36 | | `cetip_code` | string | Código da série de emissão como ativo na CETIP | 10 | | `start_date` | string | Data de início da série de emissão | 10 | | `maturity_date` | string | Data de vencimento da série de emissão | 10 | | `original_quota_value` | float | Valor de cota original | - | | `remuneration_type` | string | Curva de rendimento / Residual | até 50 | | `investment_category` | string | FIDC / Multimercado | até 50 | | `condominum_type` | string | Aberto / Fechado | até 50 | | `tax_classification` | string | Curto prazo / Longo prazo | até 50 | | `investment_restriction_type` | string | Sem restrição / Qualificado / Profissional | até 50 | | `minimum_share_capital` | float | Valor mínimo para aplicação | - | | `accounting_date` | string | Data contábil da série de emissão | 10 | | `sub_class` | JSON | Objeto de **[Sub Class](#sub_class)** | - | ### Sub Class | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|---------------------------------------------------|------------| | `name` | string | Nome da sub classe | até 255 | | `sub_class_key` | string | Chave única de identificação da sub classe | 36 | | `subordination_level` | int | Nível de subordinação da sub classe | - | | `fund_class` | JSON | Objeto de **[Fund Class](#fund_class)** | - | ### Fund Class | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|---------------------------------------------------|------------| | `name` | string | Nome da classe de fundo | até 255 | | `fund_class_key` | string | Chave única de identificação da classe de fundo | 36 | | `document_number` | string | CNPJ da classe de fundo | - | ### Capital Return | Campo | Tipo | Descrição | |---------------------------|----------|----------------------------------------------------------------| | `capital_return_key` | string | Chave única de identificação do retorno de capital | | `origin_key` | string | Chave única de identificação da origem do retorno de capital | | `net_value` | float | Valor líquido do retorno de capital | | `iof_value` | float | Valor de IOF do retorno de capital | | `ir_value` | float | Valor de IR do retorno de capital | | `payment_date` | string | Data de pagamento do retorno de capital | | `capital_return_date` | string | Data de criação do retorno de capital | | `status` | string | Enviando para o Administrador / Pendente Pagamento / Pago | | `capital_return_type` | string | Amortização / Pedido de Resgate / Come-cotas | | `number_of_units` | float | N° de quotas do retorno de capital | --- # Consulta paginada de Fechamento das Aplicações Financeiras URL: /documentation/iaas/passivo/aplicacao_financeira/busca_paginada_fechamento_das_aplicacoes_financeiras --- ### Requests Requisição por classe de fundo ENDPOINT /quota/fund_class/FUND_CLASS_KEY/financial_application_closings MÉTODO GET STATUS 200 #### Query Params | Parâmetro | Descrição | |--------------------|--------------------------------------------------------------------------------------| | `accounting_date` | Data contábil específica de fechamento (formato `yyyy-mm-dd`) | | `from_date` | Data de início do período (formato `yyyy-mm-dd`) | | `to_date` | Data de fim do período (formato `yyyy-mm-dd`) | | `limit` | Limite de objetos recuperados por página (mínimo `0`, máximo `75`, padrão `75`) | | `page` | Número da página recuperada (mínimo `0`, padrão `0`) | :::warning Atenção É obrigatório enviar `accounting_date` **ou** a combinação de `from_date` e `to_date`. Caso nenhum desses parâmetros seja enviado, o recurso retornará erro de parâmetros obrigatórios ausentes. ::: Requisição por investidor e aplicação financeira ENDPOINT /quota/investor/INVESTOR_KEY/financial_application/FINANCIAL_APPLICATION_KEY/financial_application_closings MÉTODO GET STATUS 200 #### Query Params | Parâmetro | Descrição | |--------------------------------------|--------------------------------------------------------------------------------------| | `last_financial_application_closing` | Booleano. Quando `true`, retorna apenas o último fechamento da aplicação. Padrão: `false`. | | `limit` | Limite de objetos recuperados por página (mínimo `0`, máximo `500`, padrão `50`) | | `page` | Número da página recuperada (mínimo `0`, padrão `0`) | ### Responses Caso 01: Consulta bem-sucedida ```json { "data": [ { "financial_application": { "financial_application_key": "UUID", "share_capital": 0.00, "status": "pending_payment" | "pending_quote" | "quoted" | "settled" | "redeemed" | "canceled", "investor": { "investor_key": "UUID", "name": "", "person_type": "natural_person" | "legal_person", "document_number": "999.999.999-99" | "99.999.999/9999-99", "distributor": { "distributor_key": "UUID", "name": "", "document_number": "99.999.999/9999-99", "account_data": {} } }, "issuance_serie": {}, "financial_application_type": "regular", "payment_method": "regular" | "cetip" | "b3", "quotation_date": "yyyy-mm-dd", "current_principal_value": 0.00000000, "current_number_of_quotas": 0.00000000, "original_number_of_quotas": 0.00000000, "original_number_of_quotas_str": "0.00000000", "acquisition_cost": 0.00, "external_id": "", "redemptions": [], "amortizations": [], "status_events": [], "reserved_taxable_yields": [] }, "total_value": 0.00, "number_of_quotas": 0.00000000, "principal_value": 0.00, "acquisition_cost": 0.00, "yield_value": 0.00, "ir_value": 0.00, "iof_value": 0.00, "taxable_yield_value": 0.00, "accounting_date": "yyyy-mm-dd" } ], "limit": 75, "page": 0, "is_last_page": true } ``` :::caution **Atenção** Os campos abaixo do objeto `financial_application` são **condicionais** — só são retornados quando o dado existe no recurso: - `redemptions[]`, `amortizations[]`, `status_events[]`, `reserved_taxable_yields[]`: listas omitidas quando vazias. - `original_number_of_quotas` (e o sibling `original_number_of_quotas_str`), `current_principal_value`, `acquisition_cost`, `current_number_of_quotas`, `quotation_date`: preenchidos após o processamento de cotização da aplicação. - `payment_method`, `financial_application_type`, `external_id`: opcionais por aplicação — retornados quando informados na criação ou em atualização posterior. O envelope (`data`, `limit`, `page`, `is_last_page`) e os campos do objeto **[Financial Application Closing](#financial-application-closing)** estão sempre presentes na resposta. ::: ### Page | Campo | Tipo | Descrição | |---------------|--------|-----------------------------------------------------------------------------------------| | `data` | array | Lista de objetos de **[Financial Application Closing](#financial-application-closing)** | | `limit` | int | Limite de objetos recuperados por página | | `page` | int | Número da página recuperada | | `is_last_page`| boolean| Informação que indica se a página recuperada é a última | ### Financial Application Closing | Campo | Tipo | Descrição | |-------------------------|----------|---------------------------------------------------------------| | `financial_application` | JSON | Objeto de **[Financial Application](#financial-application)** | | `total_value` | float | Valor total de fechamento da aplicação | | `number_of_quotas` | float | Número de cotas referente ao fechamento | | `principal_value` | float | Valor principal referente ao fechamento | | `acquisition_cost` | float | Custo de aquisição das cotas relacionadas ao fechamento | | `yield_value` | float | Valor do rendimento bruto | | `ir_value` | float | Valor de IR | | `iof_value` | float | Valor de IOF | | `taxable_yield_value` | float | Valor do rendimento tributável | | `accounting_date` | string | Data contábil referente ao fechamento da aplicação | ### Financial Application | Campo | Tipo | Descrição | |------------------------------------|----------|---------------------------------------------------------------------------------| | `financial_application_key` | string | Chave única de identificação da aplicação financeira | | `share_capital` | float | Valor do aporte | | `status` | string | Enumerador de **[Financial Application Status](#financial-application-status)** | | `investor` | JSON | Objeto de **[Investor](#investor)** | | `issuance_serie` | JSON | Objeto de **[Issuance Serie](#issuance-serie)** | | `redemptions` | array | Lista de objetos de **[Redemption](#redemption)** *(condicional)* | | `amortizations` | array | Lista de objetos de **[Amortization](#amortization)** *(condicional)* | | `status_events` | array | Lista de objetos de **[Status Event](#status-event)** *(condicional)* | | `reserved_taxable_yields` | array | Lista de objetos de **[Reserved Taxable Yield](#reserved-taxable-yield)** *(condicional)* | | `financial_application_type` | string | Tipo da aplicação financeira *(condicional)* | | `original_number_of_quotas` | float | Quantidade original de cotas *(condicional)* | | `original_number_of_quotas_str` | string | Versão string com precisão da quantidade original de cotas *(condicional)* | | `current_principal_value` | float | Valor atual de principal por cota *(condicional)* | | `acquisition_cost` | float | Custo de aquisição das cotas da aplicação *(condicional)* | | `current_number_of_quotas` | float | Quantidade atual de cotas *(condicional)* | | `payment_method` | string | Método de pagamento (`regular`, `cetip`, `b3`) *(condicional)* | | `quotation_date` | string | Data de cotização *(condicional)* | | `external_id` | string | Identificador externo *(condicional)* | ### Financial Application Status | Enumerador | Descrição | |-------------------|----------------------------| | `pending_payment` | Pendente pagamento | | `pending_quote` | Pendente cotização | | `quoted` | Cotizado | | `settled` | Totalmente amortizado | | `redeemed` | Totalmente resgatado | | `canceled` | Cancelado | ### Investor | Campo | Tipo | Descrição | |-----------------------------|----------|------------------------------------------------------| | `investor_key` | string | Chave única de identificação do investidor | | `name` | string | Nome do investidor | | `person_type` | string | `natural_person` / `legal_person` / `fund_class` | | `distributor` | JSON | Objeto de **[Distributor](#distributor)** | | `document_number` | string | CPF/CNPJ do investidor *(condicional)* | | `external_id` | string | Identificador externo do investidor *(condicional)* | | `external_distribution_key` | string | Chave externa de distribuição *(condicional)* | ### Distributor | Campo | Tipo | Descrição | |--------------------------|----------|---------------------------------------------------| | `distributor_key` | string | Chave única de identificação do distribuidor | | `name` | string | Nome do distribuidor | | `document_number` | string | CNPJ do distribuidor | | `account_data` | JSON | Objeto com dados bancários do distribuidor | ### Issuance Serie | Campo | Tipo | Descrição | |----------------------------------|----------|----------------------------------------------------------------------------------------------| | `issuance_serie_key` | string | Chave única de identificação da série de emissão | | `name` | string | Nome da série de emissão | | `serie` | string | Identificador da série | | `internal_code` | string | Código interno da série | | `status` | string | Enumerador de status da série de emissão | | `original_quota_value` | float | Valor de cota original | | `current_quota_value` | float | Valor de cota atual (calculado a partir de `current_net_worth` / `current_number_of_quotas`) | | `current_number_of_quotas` | float | Quantidade atual de cotas em circulação | | `current_net_worth` | float | Patrimônio líquido atual | | `current_principal_value` | float | Valor de principal atual | | `performance_fee_current_value` | float | Taxa de performance atual | | `minimum_share_capital` | float | Valor mínimo para aplicação | | `remuneration_type` | string | Tipo de remuneração (enumerador) | | `interest_rate_type` | string | Tipo de taxa de juros (enumerador) | | `processing_method` | string | Método de processamento da série (enumerador) | | `operation_period_configuration` | JSON | Configuração do período de operação | | `sub_class` | JSON | Objeto de **[Sub Class](#sub-class)** | | `pre_fixed` | JSON | Configuração pré-fixada *(condicional)* | | `post_fixed` | JSON | Configuração pós-fixada *(condicional)* | | `isin_code` | string | Código ISIN *(condicional)* | | `external_id` | string | Identificador externo da série de emissão *(condicional)* | | `specific_interest_rate_data` | JSON | Dados específicos da taxa de juros *(condicional)* | ### Sub Class | Campo | Tipo | Descrição | |------------------------|----------|---------------------------------------------------| | `sub_class_key` | string | Chave única de identificação da sub classe | | `name` | string | Nome da sub classe | | `subordination_level` | int | Nível de subordinação da sub classe | | `fund_class` | JSON | Objeto de **[Fund Class](#fund-class)** | ### Fund Class | Campo | Tipo | Descrição | |--------------------------------|----------|---------------------------------------------------| | `fund_class_key` | string | Chave única de identificação da classe de fundo | | `name` | string | Nome da classe de fundo | | `short_name` | string | Nome curto da classe de fundo | | `document_number` | string | CNPJ da classe de fundo | | `accounting_date` | string | Data contábil da classe de fundo | | `sub_type` | string | Subtipo da classe de fundo (enumerador) | | `tax_classification_id` | string | Classificação tributária (enumerador) | | `condominum_type_id` | string | Tipo de condomínio (enumerador) | | `investment_category_id` | string | Categoria de investimento (enumerador) | | `prevent_payment` | boolean | Flag de prevenção de pagamento | | `integralization_account_key` | string | Chave da conta de integralização | | `manager` | JSON | Objeto de **[Manager](#manager)** | ### Manager | Campo | Tipo | Descrição | |---------------------|----------|---------------------------------------------| | `manager_key` | string | Chave única de identificação do gestor | | `manager_name` | string | Nome do gestor | | `document_number` | string | CNPJ do gestor | --- # Consultar Aplicação Financeira por chave URL: /documentation/iaas/passivo/aplicacao_financeira/buscar_aplicacao_financeira_por_chave --- ### Request ENDPOINT /quota/investor/INVESTOR_KEY/financial_application/FINANCIAL_APPLICATION_KEY MÉTODO GET STATUS 200 ### Responses Caso 01: Consulta bem-sucedida ```json { "external_id": "", "financial_application_key": "UUID", "share_capital": 0.00, "investor_position": { "investor": { "investor_key": "UUID", "document_number": "999.999.999-99" | "99.999.999/9999-99", "name": "", "person_type": "natural_person" | "legal_person", "account_data": { "owner": { "name": "", "document_number": "99.999.999/9999-99" },"issuance_serie": {}, "account_digit": "0", "account_branch": "0000", "account_number": "00000", "financial_institution_code": "000", "financial_institution_ispb": "00000000" }, "distributor": { "distributor_key": "UUID", "document_number": "99.999.999/9999-99", "name": "", "account_data": { "owner": { "name": "", "document_number": "99.999.999/9999-99" }, "account_digit": "0", "account_branch": "0000", "account_number": "00000", "financial_institution_code": "000", "financial_institution_ispb": "00000000" }, } }, "total_net_worth": 0.00, "total_number_of_quotas": 0.00000000, "investor_position_key": "UUID", "issuance_serie":{ "name":"1", "cetip_code":"0000000SN1", "start_date":"YYYY-MM-DD", "maturity_date":"YYYY-MM-DD", "original_quota_value":0.00000000000000, "remuneration_type":"yield_curve", "interest_rate_type":"post_fixed", "pre_fixed":{ "calendar_base":"workdays / calendar_360 / calendar_365", "monthly_rate":0.00000000000000 }, "post_fixed":{ "calendar_base":"workdays / calendar_360 / calendar_365", "indexer":"di / ipca", "rate":1, "lag":{ "reference":"daily / monthly", "amount":1 } }, "investment_category":"fidc / multi_market", "condominum_type":"open_ended / close_ended", "tax_classification":"short_term / long_term", "investment_restriction_type":"just_professional", "issuance_serie_key":"UUID", "minimum_share_capital":0.0, "accounting_date":"YYYY-MM-DD", "sub_class":{ "name":"COTA SÊNIOR", "sub_class_key":"UUID", "subordination_level":1, "fund_class":{ "name":"SAMPLE FUND CLASS NAME", "fund_class_key":"UUID", "document_number":"00.000.000/0000-00" } } } }, "original_principal_value": 0.00000000, "current_principal_value": 0.00000000, "original_number_of_units": 0.00000000, "current_number_of_units": 0.00000000, "quotation_date": "yyyy-mm-dd", "status": "pending_payment" | "pending_quote" | "quoted" | "settled" | "redeemed" | "canceled", "status_events": [ { "event_datetime": "yyyy-mm-dd HH:MM:SS:ms", "status": "pending_payment" | "pending_quote" | "quoted" | "settled" | "redeemed" | "canceled", } ], "capital_returns": [ { "capital_return_key": "UUID", "origin_key": "UUID", "net_value": 0.00, "iof_value": 0.00, "ir_value": 0.00, "payment_date": "yyyy-mm-dd", "capital_return_date": "yyyy-mm-dd", "status": "", "capital_return_type": "", "number_of_units": "", } ], } ``` ### Financial Application | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|---------------------------------------------------------------------------------|------------| | `external_id` | string | Identificador externo | até 100 | | `financial_application_key` | string | Chave única de identificação da aplicação financeira | 36 | | `share_capital` | float | Valor do aporte | - | | `investor_position` | JSON | Objeto de **[Investor Position](#investor_position)** | - | | `original_principal_value` | float | Valor original de principal por cota | - | | `current_principal_value` | float | Valor atual de principal por cota | - | | `original_number_of_units` | float | Quantidade original de cotas | - | | `current_number_of_units` | float | Quantidade atual de cotas | - | | `quotation_date` | string | Data da cotização | - | | `status` | string | Enumerador de **[Financial Application Status](#financial_application_status)** | - | | `status_events` | array | Lista de objetos de **[Status Event](#status_event)** | - | | `capital_returns` | array | Lista de objetos de **[Capital Return](#capital_return)** | - | ### Financial Application Status | Enumerador | Descrição | |--------------------------|-------------------------------------------------| | `pending_payment` | Pendente pagamento | | `pending_quote` | Pendente cotização | | `quoted` | Cotizado | | `settled` | Totalmente amortizado | | `redeemed` | Totalmente resgatado | | `canceled` | cancelado | ### Investor Position | Campo | Tipo | Descrição | |--------------------------|--------|-------------------------------------------------------| | `investor` | JSON | Objeto de **[Investor](#investor)** | | `total_net_worth` | float | Patrimônio Líquido da posição do investidor | | `total_number_of_quotas` | float | Número de cotas da posição do investidor | | `issuance_serie` | JSON | Objeto de **[Issuance Serie](#issuance_serie)** | | `investor_position_key` | JSON | Chave única de identificação da posição do investidor | ### Investor | Campo | Tipo | Descrição | Caracteres | |--------------------------|----------|---------------------------------------------------|------------| | `name` | string | Nome do investidor | até 255 | | `investor_key` | string | Chave única de identificação do investidor | 36 | | `document_number` | string | CPF/CNPJ do investidor | 14 ou 18 | | `person_type` | string | Pessoa Física / Pessoa Jurídica / Classe de Fundo | até 50 | | `distributor` | JSON | Objeto de **[Distributor](#distributor)** | - | | `account_data` | JSON | Objeto de **[Account Data](#account_data)** | - | ### Distributor | Campo | Tipo | Descrição | Caracteres | |--------------------------|----------|---------------------------------------------------|------------| | `name` | string | Nome do distribuidor | até 255 | | `distributor_key` | string | Chave única de identificação do distribuidor | - | | `document_number` | string | CPF/CNPJ do distribuidor | 14 ou 18 | | `account_data` | JSON | Objeto de **[Account Data](#account_data)** | - | ### Account Data | Campo | Tipo | Descrição | |------------------------------|----------|-----------------------------------------------------------------------------| | `account_digit` | string | Dígito da conta bancária | | `account_branch` | string | N° da agência da conta bancária | | `account_number` | string | N° da conta bancária | | `financial_institution_code` | string | Código da instituição financeira | | `financial_institution_ispb` | string | Identificador no Sistema de Pagamento Brasileiro da instituição financeira | ### Issuance Serie | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|---------------------------------------------------|------------| | `name` | string | Nome da série de emissão | até 255 | | `issuance_serie_key` | string | Chave única de identificação da série de emissão | 36 | | `cetip_code` | string | Código da série de emissão como ativo na CETIP | 10 | | `start_date` | string | Data de início da série de emissão | 10 | | `maturity_date` | string | Data de vencimento da série de emissão | 10 | | `original_quota_value` | float | Valor de cota original | - | | `remuneration_type` | string | Curva de rendimento / Residual | até 50 | | `investment_category` | string | FIDC / Multimercado | até 50 | | `condominum_type` | string | Aberto / Fechado | até 50 | | `tax_classification` | string | Curto prazo / Longo prazo | até 50 | | `investment_restriction_type` | string | Sem restrição / Qualificado / Profissional | até 50 | | `minimum_share_capital` | float | Valor mínimo para aplicação | - | | `accounting_date` | string | Data contábil da série de emissão | 10 | | `sub_class` | JSON | Objeto de **[Sub Class](#sub_class)** | - | ### Sub Class | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|---------------------------------------------------|------------| | `name` | string | Nome da sub classe | até 255 | | `sub_class_key` | string | Chave única de identificação da sub classe | 36 | | `subordination_level` | int | Nível de subordinação da sub classe | - | | `fund_class` | JSON | Objeto de **[Fund Class](#fund_class)** | - | ### Fund Class | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|---------------------------------------------------|------------| | `name` | string | Nome da classe de fundo | até 255 | | `fund_class_key` | string | Chave única de identificação da classe de fundo | 36 | | `document_number` | string | CNPJ da classe de fundo | - | ### Capital Return | Campo | Tipo | Descrição | |---------------------------|----------|----------------------------------------------------------------| | `capital_return_key` | string | Chave única de identificação do retorno de capital | | `origin_key` | string | Chave única de identificação da origem do retorno de capital | | `net_value` | float | Valor líquido do retorno de capital | | `iof_value` | float | Valor de IOF do retorno de capital | | `ir_value` | float | Valor de IR do retorno de capital | | `payment_date` | string | Data de pagamento do retorno de capital | | `capital_return_date` | string | Data de criação do retorno de capital | | `status` | string | Enviando para o Administrador / Pendente Pagamento / Pago | | `capital_return_type` | string | Amortização / Pedido de Resgate / Come-cotas | | `number_of_units` | float | N° de quotas do retorno de capital | --- # Criar Aplicação Financeira URL: /documentation/iaas/passivo/aplicacao_financeira/criar_aplicacao_financeira --- ### Request ENDPOINT /quota/investor/INVESTOR_KEY/financial_application MÉTODO POST STATUS 201 ```json title='Request Body' { "issuance_serie_key": "UUID", "share_capital": 0.00, "payment_method": "b3 / regular", "central_depositary": "unregistered / cetip", "quotation_date": "yyyy-mm-dd" } ``` :::note **Campos Obrigatórios**. - issuance_serie_key - share_capital ::: :::caution **Atenção** **payment_method** e **central_depositary** são campos opcionais, de modo que caso não sejam enviado seram considerados a opção marcada de default. - Isso será depreciado em próximas versões, tornando-se obrigatório o envio dos campos - Com **central_depositary** `cetip`, o **payment_method** pode ser `regular` ou `b3`. Com `unregistered`, apenas `regular` (`b3` não é permitido). ::: ### Body params | Campo | Tipo | Descrição | |-----------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------| | `issuance_serie_key` | string | Chave única de identificação da Série de emissão | | `share_capital` | float | Valor da aplicação financeira | | `payment_method` | string | Método de Pagamento. Valores esperados:
• regular: Pix ou TED **(default)**
• b3: Via B3 | | `central_depositary` | string | Tipo de depositárias. Valores esperados:
• unregistered: Sem registradora
• cetip: Registado na Cetip **(default)** | | `quotation_date` | string | Data de cotização da aplicação, no formato yyyy-mm-dd (opcional) | ### Response ```json title='Response Body' { "financial_application_key": "UUID" } ``` --- # Aprovação manual de bloqueio de cotas URL: /documentation/iaas/passivo/bloqueio_de_cotas/aprovar_bloqueio_pendente_aprovacao --- ### Introdução Este recurso tem como objetivo detalhar o fluxo de aprovação manual de um bloqueio. :::warning Atenção O Bloqueio de cotas somente irá para pendente aprovação manual caso o valor do bloqueio ultrapasse o valor total do patrimônio em até **3.8%** ::: ### Aprovação ENDPOINT quota_lock/investor/INVESTOR_KEY/quota_lock/QUOTA_LOCk_KEY/pending_manual_approval/approve MÉTODO PUT STATUS 204 ### Reprovação ENDPOINT quota_lock/investor/INVESTOR_KEY/quota_lock/QUOTA_LOCk_KEY/pending_manual_approval/reprove MÉTODO PUT STATUS 204 --- # Consultar bloqueio de cotas URL: /documentation/iaas/passivo/bloqueio_de_cotas/consulta_de_bloqueio_de_cotas --- ### Introdução Este recurso tem como objetivo detalhar as informações de uma solicitação de **bloqueio de cotas** de um **investidor**. ### Request ENDPOINT /quota_lock/investor/INVESTOR_KEY/quota_lock/QUOTA_LOCK_KEY MÉTODO GET STATUS 200 ### Response ```json { "quota_lock_key": "UUID", "status": "pending_documents", "original_locked_quotas": 0.0, "current_locked_quotas": 0.0, "original_locked_value": 0.0, "current_locked_value": 0.0, "type": "collateral", "collateral": { "recipient": { "name": "Sample Recipient Name", "document_number": "000.000.000-00", "person_type": "natural_person", "natural_person": { "birthdate": "YYYY-MM-DD", "mother_name": "Sample Recipient Mother Name" } }, "borrower": { "name": "Sample Borrower Name", "document_number": "000.000.000-00", "person_type": "natural_person", "natural_person": { "birthdate": "YYYY-MM-DD", "mother_name": "Sample Borrower Mother Name" } }, "assets": [ { "asset_key": "UUID", "asset_type": "cce", "credit_operation": { "contract_number": "1000000001", "principal_value": 0.0, "interest_rate_type": "post_fixed", "pre_fixed": { "monthly_rate": 0.0, "calendar_base": "calendar_360" }, "post_fixed": { "calendar_base": "workdays", "indexer": "di", "rate": 1, "lag": { "reference": "daily", "amount": 1 } } }, "documents": [ { "document_key": "UUID", "document_type": "asset_document" } ] } ], "issuance_series": [ { "issuance_serie_key": "UUID", "number_of_quotas": 0.0, "financial_value": 0.0 }, { "issuance_serie_key": "UUID", "number_of_quotas": 0.0, "financial_value": 0.0 } ], "documents": [ { "document_key": "UUID", "document_type": "collateral_contract" } ] }, "investor_positions_locks": [ { "investor_position_lock_key": "UUID", "investor_position_key": "UUID", "original_locked_quotas": 0.0, "current_locked_quotas": 0.0, "original_locked_value": 0.0, "current_locked_value": 0.0 } ] } ``` ### Quota Lock | Campo | Tipo | Descrição | Caracteres | |-----------------------------|------- |------------------------------------------------------------------------|------------| | `quota_lock_key` | string | Identificador único do bloqueio de cotas | 36 | | `status` | string | Enumerador de tipo de bloqueio de cotas | até 255 | | `type` | string | Enumerador de tipo de bloqueio de cotas | até 255 | | `original_locked_quotas` | float | Quantidade original de cotas bloqueadas | - | | `current_locked_quotas` | float | Quantidade atual de cotas bloqueadas | - | | `original_locked_value` | float | Valor original do bloqueio | - | | `current_locked_value` | float | Valor atual do bloqueio | - | | `collateral` | JSON | Objeto de **[Garantia](#collateral)** | - | | `investor_positions_locks` | Array | Lista de objetos de **[Bloqueio de posição do investidor](#locked-investor-positions)** | - | ### Quota Lock Status | Enumerador | Descrição | |--------------------------|-----------------------| | `pending_documents` | Pendente documentos | | `pending_approval` | Pendente aprovação | | `denied` | Negado | | `approved` | Aprovado | ### Quota Lock Type | Enumerador | Descrição | |--------------------------|-----------------------| | `collateral` | Garantia | ### Collateral | Campo | Tipo | Descrição | Caracteres | |-----------------------------|------- |-----------------------------------------------------------------------|------------| | `recipient` | JSON | Objeto de **[Beneficiário](#recipient)** | - | | `borrower` | JSON | Objeto de **[Tomador](#borrower)** | - | | `assets` | Array | Lista de objetos de **[Ativo](#asset)** | - | | `issuance_series` | Array | Lista de objetos de **[Série de emissão](#issuance_serie)** | - | | `documents` | Array | Lista de objetos de **[Documento da garantia](#collateral_document)** | - | ### Recipient | Campo | Tipo | Descrição | Caracteres | |-----------------------------|------- |-----------------------------------------------------|------------| | `name` | string | Nome do beneficiário | até 255 | | `document_number` | string | CPF / CNPJ do beneficiário | 14 ou 18 | | `person_type` | string | Enumerador de pessoa física ou jurídica | até 255 | | `natural_person` | JSON | Objeto de **[Pessoa Física](#natural_person)** | - | | `legal_person` | JSON | Objeto de **[Pessoa Jurídica](#legal_person)** | - | ### Borrower | Campo | Tipo | Descrição | Caracteres | |-----------------------------|------- |-----------------------------------------------------|------------| | `name` | string | Nome do tomador | até 255 | | `document_number` | string | CPF / CNPJ do tomador | 14 ou 18 | | `person_type` | string | Enumerador de pessoa física ou jurídica | até 255 | | `natural_person` | JSON | Objeto de **[Pessoa Física](#natural_person)** | - | | `legal_person` | JSON | Objeto de **[Pessoa Jurídica](#legal_person)** | - | ### Person Type | Enumerador | Descrição | |--------------------------|-----------------------| | `natural_person` | Pessoa física | | `legal_person` | Pessoa jurídica | ### Natural Person | Campo | Tipo | Descrição | Caracteres | |-----------------------------|------- |-----------------------------------------------------|------------| | `birthdate` | string | Data de nascimento | 10 | | `mother_name` | string | Nome da mãe | até 255 | ### Legal Person | Campo | Tipo | Descrição | Caracteres | |------------------|----------|----------------------------------------------------------|--------------| | `activity_code` | string | Classificação Nacional das Atividades Econômicas (CNAE) | 10 | | `representatives`| array | Lista de objetos de **[Representative](#representative)**| - | ### Representative | Campo | Tipo | Descrição | Caracteres | |-----------------------------------|----------|------------------------------------------------|--------------| | `name` | string | Nome do representante | até 255 | | `document_number` | string | CPF do representante | 14 | ### Asset | Campo | Tipo | Descrição | Caracteres | |-----------------------------------|----------|---------------------------------------------------------------|--------------| | `asset_key` | string | Identificador único do ativo | até 255 | | `asset_type` | string | Enumerador de tipo de ativo | até 255 | | `status` | string | Enumerador de status de ativo | até 255 | | `credit_operation` | JSON | Objeto de **[Operação de Crédito](#credit_operation)** | - | | `documents` | Array | Lista de objetos de **[Documento do ativo](#asset_document)** | - | ### Asset Status | Enumerador | Descrição | |--------------------------|-----------------------| | `pending_approval` | Pendente aprovação | | `done` | concluído | ### Document | Campo | Tipo | Descrição | Caracteres | |-----------------------------------|----------|---------------------------------------------------------------|--------------| | `document_key` | string | Identificador único do ativo | até 255 | | `document_type` | string | Enumerador de tipo de ativo | até 255 | ### Asset Type | Enumerador | Descrição | |--------------------------|-----------| | `ccb` | CCB | | `cce` | CCE | ### Credit Operation | Campo | Tipo | Descrição | Caracteres | |-----------------------------------|----------|-------------------------------------------------------|--------------| | `contract_number` | string | N° do contrato | até 255 | | `principal_value` | string | Valor de principal da operação | - | | `interest_rate_type` | string | Enumerador de pós-fixada / pré-fixada | até 255 | | `pre_fixed` | JSON | Objeto de **[Pré-fixada](#pre_fixed)** | - | | `post_fixed` | JSON | Objeto de **[Pós-fixada](#pós_fixed)** | - | ### Interest Rate Type | Enumerador | Descrição | |--------------------------|-----------------------| | `pre_fixed` | Pré-fixada | | `post_fixed` | Pós-fixada | ### Pre fixed | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|--------------------------------------------------------------|------------| | `calendar_base` | string | Enumerador de Dias úteis / calendário 360 / calendário 365 | até 255 | | `monthly_rate` | float | Taxa mensal | - | ### Post fixed | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|-----------------------------------------------------------------|------------| | `calendar_base` | string | Enumerador de Dias úteis / calendário 360 / calendário 365 | até 255 | | `indexer` | string | Enumerador de DI / IPCA | até 255 | | `rate` | float | Taxa | - | | `lag` | JSON | Objeto de **[Lag](#lag)** | - | ### calendar_base | Enumerador | Descrição | |--------------------------|-----------------------| | `workdays` | Dias úteis | | `calendar_360` | Calendário 360 dias | | `calendar_365` | Calendário 365 dias | ### Indexer | Enumerador | Descrição | |--------------------------|-----------------------| | `di` | DI | | `ipca` | IPCA | ### Lag | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|---------------------------------------------------|------------| | `reference` | string | Enumerador de Diário / Mensal | até 255 | | `amount` | integer | Quantidade de lag | - | ### Reference | Enumerador | Descrição | |--------------------------|-----------------------| | `daily` | Diário | | `monthly` | Mensal | ### Locked Investor Positions | Campo | Tipo | Descrição | Caracteres | |---------------------------------|------- |-----------------------------------------------------------------------|------------| | `investor_position_lock_key` | string | Identificador único do bloqueio da posição do investor | 36 | | `investor_position_key` | string | Identificador único da posição do investidor | 36 | | `original_locked_quotas` | float | Quantidade original de cotas bloqueadas | - | | `current_locked_quotas` | float | Quantidade atual de cotas bloqueadas | - | | `original_locked_value` | float | Valor original do bloqueio | - | | `current_locked_value` | float | Valor atual do bloqueio | - | --- # Consultar bloqueio de cotas de um investidor URL: /documentation/iaas/passivo/bloqueio_de_cotas/consulta_de_bloqueio_de_cotas_de_um_investidor --- ### Introdução Este recurso tem como objetivo detalhar as informações de todas as solicitação de **bloqueio de cotas** de um **investidor**. ### Request ENDPOINT /quota_lock/investor/INVESTOR_KEY/quota_locks MÉTODO GET STATUS 200 ### Response ```json { "data": [ { "quota_lock_key": "UUID", "status": "pending_documents", "original_locked_quotas": 0.0, "current_locked_quotas": 0.0, "original_locked_value": 0.0, "current_locked_value": 0.0, "type": "collateral", "collateral": { "recipient": { "name": "Sample Recipient Name", "document_number": "000.000.000-00", "person_type": "natural_person", "natural_person": { "birthdate": "YYYY-MM-DD", "mother_name": "Sample Recipient Mother Name" } }, "borrower": { "name": "Sample Borrower Name", "document_number": "000.000.000-00", "person_type": "natural_person", "natural_person": { "birthdate": "YYYY-MM-DD", "mother_name": "Sample Borrower Mother Name" } }, "assets": [ { "asset_key": "UUID", "asset_type": "cce", "credit_operation": { "contract_number": "1000000001", "principal_value": 0.0, "interest_rate_type": "post_fixed", "pre_fixed": { "monthly_rate": 0.0, "calendar_base": "calendar_360" }, "post_fixed": { "calendar_base": "workdays", "indexer": "di", "rate": 1, "lag": { "reference": "daily", "amount": 1 } } }, "documents": [ { "document_key": "UUID", "document_type": "asset_document" } ] } ], "issuance_series": [ { "issuance_serie_key": "UUID", "number_of_quotas": 0.0, "financial_value": 0.0 }, { "issuance_serie_key": "UUID", "number_of_quotas": 0.0, "financial_value": 0.0 } ], "documents": [ { "document_key": "UUID", "document_type": "collateral_contract" } ] }, "investor_positions_locks": [ { "investor_position_lock_key": "UUID", "investor_position_key": "UUID", "original_locked_quotas": 0.0, "current_locked_quotas": 0.0, "original_locked_value": 0.0, "current_locked_value": 0.0 } ] }, { "quota_lock_key":"04eeaabc-cb40-484a-b730-85ed5aed7bbf", "status":"approved", "type":"lawsuit", "original_locked_value":"50000.00", "current_locked_value":"50000.00", "lawsuit":{ "protocol":"20250037746822", "lock_date":"2024-01-15", "unlock_date":"2024-01-16", "process_number":"13289520258250000", "document_number":"236.682.501-38", "requested_amount":50000.0 } } ], "page": 0, "is_last_page": true } ``` ### Quota Lock | Campo | Tipo | Descrição | Caracteres | |-----------------------------|------- |------------------------------------------------------------------------|------------| | `quota_lock_key` | string | Identificador único do bloqueio de cotas | 36 | | `status` | string | Enumerador de tipo de bloqueio de cotas | até 255 | | `type` | string | Enumerador de tipo de bloqueio de cotas | até 255 | | `original_locked_quotas` | float | Quantidade original de cotas bloqueadas | - | | `current_locked_quotas` | float | Quantidade atual de cotas bloqueadas | - | | `original_locked_value` | float | Valor original do bloqueio | - | | `current_locked_value` | float | Valor atual do bloqueio | - | | `collateral` | JSON | Objeto de **[Garantia](#collateral)** | - | | `investor_positions_locks` | Array | Lista de objetos de **[Bloqueio de posição do investidor](#locked-investor-positions)** | - | ### Quota Lock Status | Enumerador | Descrição | |--------------------------|-----------------------| | `pending_documents` | Pendente documentos | | `pending_approval` | Pendente aprovação | | `denied` | Negado | | `approved` | Aprovado | ### Quota Lock Type | Enumerador | Descrição | |--------------------------|-----------------------| | `collateral` | Garantia | ### Collateral | Campo | Tipo | Descrição | Caracteres | |-----------------------------|------- |-----------------------------------------------------------------------|------------| | `recipient` | JSON | Objeto de **[Beneficiário](#recipient)** | - | | `borrower` | JSON | Objeto de **[Tomador](#borrower)** | - | | `assets` | Array | Lista de objetos de **[Ativo](#asset)** | - | | `issuance_series` | Array | Lista de objetos de **[Série de emissão](#issuance_serie)** | - | | `documents` | Array | Lista de objetos de **[Documento da garantia](#collateral_document)** | - | ### Recipient | Campo | Tipo | Descrição | Caracteres | |-----------------------------|------- |-----------------------------------------------------|------------| | `name` | string | Nome do beneficiário | até 255 | | `document_number` | string | CPF / CNPJ do beneficiário | 14 ou 18 | | `person_type` | string | Enumerador de pessoa física ou jurídica | até 255 | | `natural_person` | JSON | Objeto de **[Pessoa Física](#natural_person)** | - | | `legal_person` | JSON | Objeto de **[Pessoa Jurídica](#legal_person)** | - | ### Borrower | Campo | Tipo | Descrição | Caracteres | |-----------------------------|------- |-----------------------------------------------------|------------| | `name` | string | Nome do tomador | até 255 | | `document_number` | string | CPF / CNPJ do tomador | 14 ou 18 | | `person_type` | string | Enumerador de pessoa física ou jurídica | até 255 | | `natural_person` | JSON | Objeto de **[Pessoa Física](#natural_person)** | - | | `legal_person` | JSON | Objeto de **[Pessoa Jurídica](#legal_person)** | - | ### Person Type | Enumerador | Descrição | |--------------------------|-----------------------| | `natural_person` | Pessoa física | | `legal_person` | Pessoa jurídica | ### Natural Person | Campo | Tipo | Descrição | Caracteres | |-----------------------------|------- |-----------------------------------------------------|------------| | `birthdate` | string | Data de nascimento | 10 | | `mother_name` | string | Nome da mãe | até 255 | ### Legal Person | Campo | Tipo | Descrição | Caracteres | |------------------|----------|----------------------------------------------------------|--------------| | `activity_code` | string | Classificação Nacional das Atividades Econômicas (CNAE) | 10 | | `representatives`| array | Lista de objetos de **[Representative](#representative)**| - | ### Representative | Campo | Tipo | Descrição | Caracteres | |-----------------------------------|----------|------------------------------------------------|--------------| | `name` | string | Nome do representante | até 255 | | `document_number` | string | CPF do representante | 14 | ### Asset | Campo | Tipo | Descrição | Caracteres | |-----------------------------------|----------|---------------------------------------------------------------|--------------| | `asset_key` | string | Identificador único do ativo | até 255 | | `asset_type` | string | Enumerador de tipo de ativo | até 255 | | `status` | string | Enumerador de status de ativo | até 255 | | `credit_operation` | JSON | Objeto de **[Operação de Crédito](#credit_operation)** | - | | `documents` | Array | Lista de objetos de **[Documento do ativo](#asset_document)** | - | ### Asset Status | Enumerador | Descrição | |--------------------------|-----------------------| | `pending_approval` | Pendente aprovação | | `done` | concluído | ### Document | Campo | Tipo | Descrição | Caracteres | |-----------------------------------|----------|---------------------------------------------------------------|--------------| | `document_key` | string | Identificador único do ativo | até 255 | | `document_type` | string | Enumerador de tipo de ativo | até 255 | ### Asset Type | Enumerador | Descrição | |--------------------------|-----------| | `ccb` | CCB | | `cce` | CCE | ### Credit Operation | Campo | Tipo | Descrição | Caracteres | |-----------------------------------|----------|-------------------------------------------------------|--------------| | `contract_number` | string | N° do contrato | até 255 | | `principal_value` | string | Valor de principal da operação | - | | `interest_rate_type` | string | Enumerador de pós-fixada / pré-fixada | até 255 | | `pre_fixed` | JSON | Objeto de **[Pré-fixada](#pre_fixed)** | - | | `post_fixed` | JSON | Objeto de **[Pós-fixada](#pós_fixed)** | - | ### Interest Rate Type | Enumerador | Descrição | |--------------------------|-----------------------| | `pre_fixed` | Pré-fixada | | `post_fixed` | Pós-fixada | ### Pre fixed | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|--------------------------------------------------------------|------------| | `calendar_base` | string | Enumerador de Dias úteis / calendário 360 / calendário 365 | até 255 | | `monthly_rate` | float | Taxa mensal | - | ### Post fixed | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|-----------------------------------------------------------------|------------| | `calendar_base` | string | Enumerador de Dias úteis / calendário 360 / calendário 365 | até 255 | | `indexer` | string | Enumerador de DI / IPCA | até 255 | | `rate` | float | Taxa | - | | `lag` | JSON | Objeto de **[Lag](#lag)** | - | ### calendar_base | Enumerador | Descrição | |--------------------------|-----------------------| | `workdays` | Dias úteis | | `calendar_360` | Calendário 360 dias | | `calendar_365` | Calendário 365 dias | ### Indexer | Enumerador | Descrição | |--------------------------|-----------------------| | `di` | DI | | `ipca` | IPCA | ### Lag | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|---------------------------------------------------|------------| | `reference` | string | Enumerador de Diário / Mensal | até 255 | | `amount` | integer | Quantidade de lag | - | ### Reference | Enumerador | Descrição | |--------------------------|-----------------------| | `daily` | Diário | | `monthly` | Mensal | ### Locked Investor Positions | Campo | Tipo | Descrição | Caracteres | |---------------------------------|------- |-----------------------------------------------------------------------|------------| | `investor_position_lock_key` | string | Identificador único do bloqueio da posição do investor | 36 | | `investor_position_key` | string | Identificador único da posição do investidor | 36 | | `original_locked_quotas` | float | Quantidade original de cotas bloqueadas | - | | `current_locked_quotas` | float | Quantidade atual de cotas bloqueadas | - | | `original_locked_value` | float | Valor original do bloqueio | - | | `current_locked_value` | float | Valor atual do bloqueio | - | --- # Enviar Documento da Garantia URL: /documentation/iaas/passivo/bloqueio_de_cotas/enviar_documento_da_garantia --- ### Introdução Este recurso tem como objetivo nos enviar o **documento** relacionado a formalização da **garantia** ao qual se está solicitando o **bloqueio de cotas** ### Input / Output: Como ***input*** deve ser enviado o **tipo do documento** e o **base 64** do documento. Segue abaixo exemplo. Como ***output*** será entregue uma ***collateral_document_key***. A ***collateral_document_key*** é utilizada para identificar o **documento da garantia** enviado. ### Request ENDPOINT /quota_lock/investor/INVESTOR_KEY/quota_lock/QUOTA_LOCK_KEY/collateral/COLLATERAL_KEY/document MÉTODO POST STATUS 201 ### Request body ```json title='Request Body' { "document_type": "collateral_contract", "document_b64" : "B64" } ``` ### Collateral Document | Campo | Tipo | Descrição | Caracteres | Obrigatório | |------------------|--------|------------------------------------------------------------|------------|-------------| | `document_type` | string | Enumerador de tipo de documento da garantia | até 255 | Sim | | `document_b64` | string | Conteúdo do documento codificado em base64 | - | Sim | ### Document Type | Enumerador | Descrição | |------------------------|------------------------| | `collateral_contract` | Contrato de garantia | | `rental_contract` | Contrato de aluguel | ### Response ```json title='Response Body' { "collateral_document_key": "UUID" } ``` --- # Enviar Documento do Ativo URL: /documentation/iaas/passivo/bloqueio_de_cotas/enviar_documento_do_ativo --- ### Introdução Este recurso tem como objetivo nos enviar o **documento** do **ativo** que é objeto da **garantia** ao qual se está solicitando o **bloqueio de cotas** ### Input / Output: Como ***input*** deve ser enviado o **tipo do documento** e o **base 64** do documento. Segue abaixo exemplo. Como ***output*** será entregue uma ***asset_document_key***. A ***asset_document_key*** é utilizada para identificar o **documento do ativo** enviado. ### Request ENDPOINT /quota_lock/investor/INVESTOR_KEY/quota_lock/QUOTA_LOCK_KEY/collateral/COLLATERAL_KEY/asset/ASSET_KEY/document MÉTODO POST STATUS 201 ### Request body ```json title='Request Body' { "document_type": "asset_document", "document_b64" : "B64" } ``` ### Response ```json title='Response Body' { "asset_document_key": "UUID" } ``` --- # Reduzir bloqueio de cotas URL: /documentation/iaas/passivo/bloqueio_de_cotas/reduzir_bloqueio_de_cotas --- ### Introdução Este recurso tem como objetivo reduzir o valor de **bloqueio de cotas** de um **investidor**. ### Request ENDPOINT /quota_lock/investor/INVESTOR_KEY/quota_lock/QUOTA_LOCK_KEY/investor_position_lock/INVESTOR_POSITION_LOCK_KEY/event MÉTODO POST STATUS 201 Redução de valor bloqueado ```json { "type": "decrease_locked_value", "new_locked_value": 0.00 } ``` Redução de quantidade de cotas bloqueadas ```json { "type": "decrease_locked_quotas", "new_locked_quotas": 0.00 } ``` Aumento de valor bloqueado ```json { "type": "increase_locked_value", "new_locked_value": 0.00 } ``` Aumento de quantidade de cotas bloqueadas ```json { "type": "increase_locked_quotas", "new_locked_quotas": 0.00 } ``` Execução de garantia ```json { "type": "collateral_execution", "net_value": 0.00 } ``` ### Locked Investor Position Event | Campo | Tipo | Descrição | Caracteres | Obrigatório | |-----------------------------|------- |-----------------------------------------------------------|------------|-------------| | `type` | string | Enumerador de tipo de evento | até 255 | Sim | | `new_locked_value` | float | Novo valor financeiro bloqueado | - | Não | | `new_locked_quotas` | float | Nova quantidade de cotas bloqueadas | - | Não | | `net_value` | float | Valor líquido apurado na execução de garantia | - | Não | Obrigatoriamente um — e apenas um — entre `new_locked_value`, `new_locked_quotas` e `net_value` deve ser enviado. ### Event Type | Enumerador | Descrição | |---------------------------|--------------------------------------------------| | `decrease_locked_quotas` | Diminuir quantidade de cotas bloqueadas | | `decrease_locked_value` | Diminuir valor financeiro bloqueado | | `increase_locked_quotas` | Aumentar quantidade de cotas bloqueadas | | `increase_locked_value` | Aumentar valor financeiro bloqueado | | `collateral_execution` | Execução de garantia | --- # Solicitar bloqueio de cotas URL: /documentation/iaas/passivo/bloqueio_de_cotas/solicitar_bloqueio_de_cotas --- ### Introdução Este recurso tem como objetivo criar uma solicitação de **bloqueio de cotas** de um **investidor**. ### Input / Output: Deve ser enviado o **tipo de bloqueio** e a informação específica do tipo de bloqueio. Como ***output*** será entregue a ***quota_lock_key*** que representa o **bloqueio de cota**. ### Request ENDPOINT /quota_lock/investor/INVESTOR_KEY/quota_lock MÉTODO POST STATUS 201 Bloqueio de cotas por garantia - CCE - pessoa física ```json { "type": "collateral", "collateral": { "recipient": { "name": "Sample Recipient Name", "document_number": "000.000.000-00", "person_type": "natural_person", "natural_person": { "birthdate": "YYYY-MM-DD", "mother_name": "Sample Recipient Mother Name", } }, "borrower": { "name": "Sample Borrower Name", "document_number": "000.000.000-00", "person_type": "natural_person", "natural_person": { "birthdate": "YYYY-MM-DD", "mother_name": "Sample Borrower Mother Name", } }, "assets": [ { "asset_type": "cce", "credit_operation": { "contract_number": "1000000001", "principal_value": 0.0, "interest_rate_type": "post_fixed", "pre_fixed": { "monthly_rate": 0.0, "calendar_base": "calendar_360", }, "post_fixed": { "calendar_base": "workdays", "indexer": "di", "rate": 1, "lag": { "reference": "daily", "amount": 1 }, }, }, }, ], "issuance_series": [ { "issuance_serie_key": "UUID", "number_of_quotas": 0.00, "financial_value": 0.00, }, { "issuance_serie_key": "UUID", "number_of_quotas": 0.00, "financial_value": 0.00, }, ], "bank_account_key": "UUID" }, } ``` Bloqueio de cotas por garantia - CCE - pessoa jurídica ```json { "type": "collateral", "collateral": { "recipient": { "name": "Sample Recipient Name", "document_number": "000.000.000-00", "person_type": "legal_person", "legal_person": { "activity_code": "00.00-0-00", "representatives": [ { "name": "Sample Recipient Representative Name", "document_number": "000.000.000-00", } ], } }, "borrower": { "name": "Sample Borrower Name", "document_number": "000.000.000-00", "person_type": "legal_person", "legal_person": { "activity_code": "00.00-0-00", "representatives": [ { "name": "Sample Borrower Representative Name", "document_number": "000.000.000-00", } ], } }, "assets": [ { "asset_type": "cce", "credit_operation": { "contract_number": "1000000001", "principal_value": 0.0, "interest_rate_type": "post_fixed", "pre_fixed": { "monthly_rate": 0.0, "calendar_base": "calendar_360", }, "post_fixed": { "calendar_base": "workdays", "indexer": "di", "rate": 1, "lag": { "reference": "daily", "amount": 1 }, }, }, }, ], "issuance_series": [ { "issuance_serie_key": "UUID", "number_of_quotas": 0.00, "financial_value": 0.00, }, { "issuance_serie_key": "UUID", "number_of_quotas": 0.00, "financial_value": 0.00, }, ], "bank_account_key": "UUID" }, } ``` Bloqueio de cotas por garantia - contrato de aluguel - pessoa física ```json { "type": "collateral", "collateral": { "recipient": { "name": "Sample Recipient Name", "document_number": "000.000.000-00", "person_type": "natural_person", "natural_person": { "birthdate": "YYYY-MM-DD", "mother_name": "Sample Recipient Mother Name", } }, "borrower": { "name": "Sample Borrower Name", "document_number": "000.000.000-00", "person_type": "natural_person", "natural_person": { "birthdate": "YYYY-MM-DD", "mother_name": "Sample Borrower Mother Name", } }, "assets": [ { "asset_type": "rental_contract", "rental_contract": { "monthly_value": 0.0, "property_address": { "street": "Sample Street", "number": "123", "neighborhood": "Sample Neighborhood", "city": "Sample City", "uf": "SP", "complement": "Sample Complement", "postal_code": "00000-000", "country": "BRA" }, "start_date": "YYYY-MM-DD", "end_date": "YYYY-MM-DD", "readjustment_index": 0.0 } } ], "issuance_series": [ { "issuance_serie_key": "UUID", "number_of_quotas": 0.00, "financial_value": 0.00, } ], "bank_account_key": "UUID" }, } ``` Bloqueio de cotas por garantia - contrato de aluguel - pessoa jurídica ```json { "type": "collateral", "collateral": { "recipient": { "name": "Sample Recipient Name", "document_number": "00.000.000/0000-00", "person_type": "legal_person", "legal_person": { "activity_code": "00.00-0-00", "representatives": [ { "name": "Sample Recipient Representative Name", "document_number": "000.000.000-00", } ], } }, "borrower": { "name": "Sample Borrower Name", "document_number": "00.000.000/0000-00", "person_type": "legal_person", "legal_person": { "activity_code": "00.00-0-00", "representatives": [ { "name": "Sample Borrower Representative Name", "document_number": "000.000.000-00", } ], } }, "assets": [ { "asset_type": "rental_contract", "rental_contract": { "monthly_value": 0.0, "property_address": { "street": "Sample Street", "number": "123", "neighborhood": "Sample Neighborhood", "city": "Sample City", "uf": "SP", "complement": "Sample Complement", "postal_code": "00000-000", "country": "BRA" }, "start_date": "YYYY-MM-DD", "end_date": "YYYY-MM-DD", "readjustment_index": 0.0 } } ], "issuance_series": [ { "issuance_serie_key": "UUID", "financial_application_keys": [ "UUID", "UUID" ] } ], "bank_account_key": "UUID" }, } ``` ### Quota Lock | Campo | Tipo | Descrição | Caracteres | |-----------------------------|------- |------------------------------------------------------------------|------------| | `type` | string | Enumerador de tipo de bloqueio de cotas | até 255 | | `collateral` | string | Objeto de **[Garantia](#collateral)** | - | ### Quota Lock Type | Enumerador | Descrição | |--------------------------|-----------------------| | `collateral` | Garantia | ### Collateral | Campo | Tipo | Descrição | Caracteres | Obrigatório | |-----------------------------|------- |------------------------------------------------------------------|------------|-------------| | `recipient` | JSON | Objeto de **[Beneficiário](#recipient)** | - | Sim | | `borrower` | JSON | Objeto de **[Tomador](#borrower)** | - | Sim | | `assets` | Array | Lista de objetos de **[Ativo](#asset)** | - | Sim | | `issuance_series` | Array | Lista de objetos de **[Série de emissão](#issuance_serie)** | - | Sim | | `bank_account_key` | string | UUID da conta bancária associada à garantia | - | Não | ### Recipient | Campo | Tipo | Descrição | Caracteres | Obrigatório | |-----------------------------|------- |-----------------------------------------------------|------------|-------------| | `name` | string | Nome do beneficiário | até 255 | Sim | | `document_number` | string | CPF / CNPJ do beneficiário | 14 ou 18 | Sim | | `person_type` | string | Enumerador de pessoa física ou jurídica | até 255 | Sim | | `natural_person` | JSON | Objeto de **[Pessoa Física](#natural_person)** | - | Não | | `legal_person` | JSON | Objeto de **[Pessoa Jurídica](#legal_person)** | - | Não | ### Borrower | Campo | Tipo | Descrição | Caracteres | Obrigatório | |-----------------------------|------- |-----------------------------------------------------|------------|------------ | | `name` | string | Nome do tomador | até 255 | Sim | | `document_number` | string | CPF / CNPJ do tomador | 14 ou 18 | Sim | | `person_type` | string | Enumerador de pessoa física ou jurídica | até 255 | Sim | | `natural_person` | JSON | Objeto de **[Pessoa Física](#natural_person)** | - | Não | | `legal_person` | JSON | Objeto de **[Pessoa Jurídica](#legal_person)** | - | Não | ### Person Type | Enumerador | Descrição | |--------------------------|-----------------------| | `natural_person` | Pessoa física | | `legal_person` | Pessoa jurídica | ### Natural Person | Campo | Tipo | Descrição | Caracteres | Obrigatório | |-----------------------------|------- |-----------------------------------------------------|------------|-------------| | `birthdate` | string | Data de nascimento | 10 | Sim | | `mother_name` | string | Nome da mãe | até 255 | Sim | ### Legal Person | Campo | Tipo | Descrição | Caracteres | Obrigatório | |------------------|----------|----------------------------------------------------------|--------------|-------------| | `activity_code` | string | Classificação Nacional das Atividades Econômicas (CNAE) | 10 | Sim | | `representatives`| array | Lista de objetos de **[Representative](#representative)**| - | Sim | ### Representative | Campo | Tipo | Descrição | Caracteres | Obrigatório | |-----------------------------------|----------|------------------------------------------------|--------------|-------------| | `name` | string | Nome do representante | até 255 | Sim | | `document_number` | string | CPF do representante | 14 | Sim | ### Asset | Campo | Tipo | Descrição | Caracteres | Obrigatório | |-----------------------------------|----------|--------------------------------------------------------|--------------|-------------| | `asset_type` | string | Enumerador de tipo de ativo | até 255 | Sim | | `credit_operation` | JSON | Objeto de **[Operação de Crédito](#credit_operation)** | - | Não | | `rental_contract` | JSON | Objeto de **[Contrato de Aluguel](#rental_contract)** | - | Não | ### Asset Type | Enumerador | Descrição | |--------------------------|-----------------------| | `ccb` | CCB | | `cce` | CCE | | `rental_contract` | Contrato de aluguel | ### Credit Operation | Campo | Tipo | Descrição | Caracteres | Obrigatório | |-----------------------------------|----------|-------------------------------------------------------|--------------|-------------| | `contract_number` | string | N° do contrato | até 255 | Sim | | `principal_value` | string | Valor de principal da operação | - | Sim | | `interest_rate_type` | string | Enumerador de Pós-fixada / pré-fixada | até 255 | Sim | | `pre_fixed` | JSON | Objeto de **[Pré-fixada](#pre_fixed)** | - | Não | | `post_fixed` | JSON | Objeto de **[Pós-fixada](#pós_fixed)** | - | Não | ### Interest Rate Type | Enumerador | Descrição | |--------------------------|-----------------------| | `pre_fixed` | Pré-fixada | | `post_fixed` | Pós-fixada | ### Pre fixed | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|--------------------------------------------------------------|------------| | `calendar_base` | string | Enumerador de Dias úteis / calendário 360 / calendário 365 | até 255 | | `monthly_rate` | float | Taxa mensal | - | ### Post fixed | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|-----------------------------------------------------------------|------------| | `calendar_base` | string | Enumerador de Dias úteis / calendário 360 / calendário 365 | até 255 | | `indexer` | string | Enumerador de DI / IPCA | até 255 | | `rate` | float | Taxa | - | | `lag` | JSON | Objeto de **[Lag](#lag)** | - | ### calendar_base | Enumerador | Descrição | |--------------------------|-----------------------| | `workdays` | Dias úteis | | `calendar_360` | Calendário 360 dias | | `calendar_365` | Calendário 365 dias | ### Indexer | Enumerador | Descrição | |--------------------------|-----------------------| | `di` | DI | | `ipca` | IPCA | ### Lag | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|---------------------------------------------------|------------| | `reference` | string | Enumerador de Diário / Mensal | até 255 | | `amount` | integer | Quantidade de lag | - | ### Reference | Enumerador | Descrição | |--------------------------|-----------------------| | `daily` | Diário | | `monthly` | Mensal | ### Rental Contract | Campo | Tipo | Descrição | Caracteres | Obrigatório | |----------------------|----------|-------------------------------------------------------|--------------|-------------| | `monthly_value` | float | Valor mensal do aluguel | - | Sim | | `property_address` | JSON | Objeto de **[Endereço](#address)** do imóvel | - | Sim | | `start_date` | string | Data de início do contrato (YYYY-MM-DD) | 10 | Sim | | `end_date` | string | Data de término do contrato (YYYY-MM-DD) | 10 | Sim | | `readjustment_index` | float | Índice de reajuste do contrato | - | Não | ### Address | Campo | Tipo | Descrição | Caracteres | Obrigatório | |----------------|----------|--------------------------------------------------|--------------|-------------| | `street` | string | Logradouro | até 255 | Não | | `number` | string | Número | - | Não | | `neighborhood` | string | Bairro | até 255 | Não | | `city` | string | Cidade | até 255 | Não | | `uf` | string | Unidade federativa (sigla de 2 letras) | 2 | Não | | `complement` | string | Complemento | até 255 | Não | | `postal_code` | string | CEP no formato `00000-000` | 9 | Não | | `country` | string | Código do país (3 letras) | 3 | Não | ### Issuance Serie | Campo | Tipo | Descrição | Caracteres | Obrigatório | |-----------------------------------|----------|-------------------------------------------------------|--------------|-------------| | `issuance_serie_key` | string | Chave da série de emissão | 36 | Sim | | `number_of_quotas` | float | Número de cotas a serem bloqueadas | - | Não | | `financial_value` | float | Valor financeiro a ser bloqueador | - | Não | ### Responses ```json title='Response Body' { "quota_lock_key": "UUID" } ``` --- # Webhook de bloqueio de cotas URL: /documentation/iaas/passivo/bloqueio_de_cotas/webhooks_de_bloqueio_de_cota --- ### Introdução Abaixo estão os detalhes sobre os webhooks enviados durante o processo de **bloqueio de cotas**. Bloqueio aprovado ```json { "webhook_type": "quota_lock.quota_lock_status_change", "webhook_datetime": "2024-12-05T00:00:00Z", "data": { "status": "approved", "quota_lock_key": "UUID" } } ``` Bloqueio reprovado ```json { "webhook_type": "quota_lock.quota_lock_status_change", "webhook_datetime": "2024-12-05T00:00:00Z", "data": { "status": "denied", "quota_lock_key": "UUID" } } ``` --- # Consulta paginada de investidores por classe de fundo URL: /documentation/iaas/passivo/consultas/consulta_investidores_classe_fundo Retorna **investidores que possuem aplicação financeira** vinculada à classe de fundo informada (via séries de emissão e subclasses), de forma paginada. Permite filtrar por documento, nome e **data contábil** do fundo. ## Request ENDPOINT /quota/fund_class/{fund_class_key}/investors MÉTODO GET ### Query params | Parâmetro | Tipo | Obrigatoriedade | Descrição | |---|---|---|---| | `page` | integer | opcional | Número da página (começa em `0`).| | `limit` | integer | opcional | Registros por página. Padrão: `20`. Máximo: `500`. | | `document_number` | string | opcional | Filtra pelo documento do investidor com pontuação. | | `reference_date` | string (data) | opcional | Restringe a registros em que a **data contábil da classe de fundo** (`accounting_date`) é igual à data informada (formato aceito pelo servidor para parâmetros de data, tipicamente `YYYY-MM-DD`). | ```python title="Exemplo de chamada" GET /quota/fund_class/{fund_class_key}/investors?page=0&limit=25&reference_date=2024-04-01 ``` ## Response STATUS 200 ```json title="Response Body" { "data": [ { "distributor": { "distributor_key": "3571e292-3a83-4011-904d-20ee963022ef", "document_number": "12.345.678/0001-90", "name": "Distribuidora Exemplo S.A.", "account_data": { "owner": { "name": "Distribuidora Exemplo S.A.", "document_number": "12.345.678/0001-90" }, "account_digit": "1", "account_branch": "0001", "account_number": "12345", "financial_institution_code": "341", "financial_institution_ispb": "60746948" } }, "investor_key": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "name": "Maria Cotista Silva", "person_type": "natural_person", "document_number": "123.456.789-00", "external_id": "ext-inv-001", "external_distribution_key": null }, { "distributor": { "distributor_key": "3571e292-3a83-4011-904d-20ee963022ef", "document_number": "12.345.678/0001-90", "name": "Distribuidora Exemplo S.A.", "account_data": { "owner": { "name": "Distribuidora Exemplo S.A.", "document_number": "12.345.678/0001-90" }, "account_digit": "1", "account_branch": "0001", "account_number": "12345", "financial_institution_code": "341", "financial_institution_ispb": "60746948" } }, "investor_key": "c3d4e5f6-a7b8-9012-cdef-123456789012", "name": "Investimentos PJ Ltda", "person_type": "legal_person", "document_number": "98.765.432/0001-10", "external_id": null, "external_distribution_key": "dist-key-7721" } ], "limit": 20, "page": 0, "is_last_page": true } ``` ### Atributos da resposta | Campo | Tipo | Descrição | |---|---|---| | `data` | array | Lista de investidores. | | `page` | integer | Página atual. | | `limit` | integer | Tamanho da página. | | `is_last_page` | boolean | Indica fim da paginação. | #### Campos de cada investidor em `data` | Campo | Tipo | Descrição | |---|---|---| | `investor_key` | string | Identificador único do investidor (UUID). | | `name` | string | Nome. | | `person_type` | string | Tipo de pessoa (enumerador, ex.: `natural_person`, `legal_person`). | | `document_number` | string | Documento, quando houver. | | `distributor` | object | Dados da distribuidora (`distributor_key`, `document_number`, `name`, `account_data`). | | `external_id` | string | Opcional — identificador externo. | | `external_distribution_key` | string | Opcional — chave de distribuição externa. | ## Possíveis erros STATUS 404 **Classe de fundo não encontrada** ```json { "title": " Fund Class not Found", "description": "Fund Class with key {fund_class_key} was not found.", "translation": "A classe com chave {fund_class_key} não foi encontrado.", "code": "QTA000002" } ``` --- # Consulta paginada de posições de cotistas por classe de fundo URL: /documentation/iaas/passivo/consultas/consulta_posicoes_cotistas_classe_fundo Endpoint de consulta paginada que retorna as **posições por investidor e série de emissão** em uma classe de fundo: cotistas com saldo de cotas na aplicação financeira, com valor de cota obtido do fechamento mais recente da série. Utilize `document_number` para filtrar um cotista específico. ## Request ENDPOINT /quota/fund_class/{fund_class_key}/investor_positions MÉTODO GET ### Query params | Parâmetro | Tipo | Obrigatoriedade | Descrição | |---|---|---|---| | `page` | integer | opcional | Número da página (começa em `0`). Padrão: `0`. | | `limit` | integer | opcional | Quantidade de registros por página. Padrão: `20`. Máximo: `100`. | | `document_number` | string | opcional | Filtra pelo documento do investidor (com pontuação). | ```python title="Exemplo de chamada" GET /quota/fund_class/{fund_class_key}/investor_positions?page=0&limit=20&document_number=123.456.789-00 ``` ## Response STATUS 200 ```json title="Response Body" { "data": [ { "investor": { "distributor": { "distributor_key": "3571e292-3a83-4011-904d-20ee963022ef", "document_number": "12.345.678/0001-90", "name": "Distribuidora Exemplo S.A.", "account_data": { "owner": { "name": "Distribuidora Exemplo S.A.", "document_number": "12.345.678/0001-90" }, "account_digit": "1", "account_branch": "0001", "account_number": "12345", "financial_institution_code": "341", "financial_institution_ispb": "60746948" } }, "investor_key": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "name": "Maria Cotista Silva", "person_type": "natural_person", "document_number": "123.456.789-00", "external_id": "ext-inv-001", "external_distribution_key": null }, "issuance_serie": { "issuance_serie_key": "c3d4e5f6-a7b8-9012-cdef-123456789012", "original_quota_value": 1.0, "current_number_of_quotas": 500000.0, "current_net_worth": 525000.75, "current_principal_value": 500000.0, "performance_fee_current_value": 0.0, "remuneration_type": "yield_curve", "minimum_share_capital": 1000.0, "interest_rate_type": "post_fixed", "name": "Série Única", "serie": 1, "sub_class": { "name": "Cota Sênior", "sub_class_key": "d4e5f6a7-b8c9-0123-def0-234567890123", "subordination_level": 1, "fund_class": { "name": "Fundo Exemplo FIDC", "short_name": "FEX", "document_number": "12.345.678/0001-90", "fund_class_key": "e5f6a7b8-c9d0-1234-ef01-345678901234", "accounting_date": "2024-06-01", "sub_type": "fidc", "tax_classification_id": "long_term", "condominum_type_id": "open_ended", "investment_category_id": "fidc", "prevent_payment": false, "integralization_account_key": null, "manager": { "manager_key": "f6a7b8c9-d0e1-2345-f012-456789012345", "document_number": "98.765.432/0001-10", "manager_name": "Gestora Exemplo S.A." } } }, "status": "active", "internal_code": "INT-FEX-01", "processing_method": "standard", "operation_period_configuration": { "subscription": {}, "redemption": {} }, "current_quota_value": 1.0500015, "post_fixed": { "calendar_base": "calendar_252", "indexer": "cdi", "rate": 1.0, "lag": { "reference": "daily", "amount": 1 } }, "isin_code": "BRSTREXTFID6", "external_id": null, "specific_interest_rate_data": null }, "number_of_quotas": 10000.0, "quota_value": 1.05234567 } ], "limit": 20, "page": 0, "is_last_page": true } ``` ### Atributos da resposta | Campo | Tipo | Descrição | |---|---|---| | `data` | array | Lista de posições. Cada item agrega **investidor**, **série de emissão**, **quantidade de cotas** e **valor de cota** (`quota_value` quando existir fechamento). | | `page` | integer | Página atual. | | `limit` | integer | Tamanho da página solicitado. | | `is_last_page` | boolean | Indica se não há mais registros após esta página. | #### Objeto em `data` | Campo | Tipo | Descrição | |---|---|---| | `investor` | object | Dados do cotista e da distribuidora . | | `issuance_serie` | object | Série de emissão da posição, incluindo `sub_class` e `fund_class` aninhados. | | `number_of_quotas` | number | Soma das cotas da aplicação financeira para aquele investidor e série. | | `quota_value` | number | Valor de cota do fechamento mais recente da série; omitido se não houver fechamento disponível. | Campos opcionais ou nulos em `issuance_serie` (como `pre_fixed`, `external_id`, `integralization_account_key`) podem variar conforme o cadastro da série. Para mais contexto sobre séries, consulte [Consulta paginada de séries de emissão](/documentation/iaas/cotas_de_fundo/consulta_paginada_series_de_emissao). ## Possíveis erros STATUS 404 **Classe de fundo não encontrada** ```json { "title": " Fund Class not Found", "description": "Fund Class with key {fund_class_key} was not found.", "translation": "A classe com chave {fund_class_key} não foi encontrado.", "code": "QTA000002" } ``` STATUS 404 **Gestor não encontrado** ```json { "title": "Manager not Found", "description": "Manager with Key {manager_key} was not found", "translation": "O gestor com chave {manager_key} nao foi encontrado", "code": "QTA00053" } ``` --- # Consulta paginada do Mapa de Evolução de Cotas URL: /documentation/iaas/passivo/consultas/consultar_mapa_de_evolucao_de_cotas ### Request ENDPOINT /composition/fund_class/FUND-CLASS-KEY/issuance_serie/ISSUANCE-SERIE-KEY/quota_evolution_map MÉTODO GET STATUS 200 ### Params | Parâmetro | Tipo | Obrigatório | Descrição | | -------------------- | ------ | ----------- | ------------------------- | | `fund_class_key` | `UUID` | Sim | Chave do fundo | | `issuance_serie_key` | `UUID` | Sim | Chave da série de emissão | ### Query Params | Parâmetro | Tipo | Obrigatório | Descrição | | ---------------- | ------------ | ----------- | ------------------------------------------------ | | `reference_date` | `YYYY-MM-DD` | Condicional | Data única de referência para consulta | | `start_date` | `YYYY-MM-DD` | Condicional | Data inicial do intervalo | | `end_date` | `YYYY-MM-DD` | Condicional | Data final do intervalo | | `limit` | `int` | Não | Quantidade de registros por página (default: 10) | | `page` | `int` | Não | Página atual (default: 0) | :::warning Atenção É obrigatório passar um dos filtros de data, reference_date trás o mec de uma data especifica, o conjunto de start_date e end_date vai trazer o mec em um range de datas. Caso nenhum dos dois filtros seja enviado, você receberá um erro: CMP000018 ::: Caso 01: Retorno com uma data ```json { "data": [ { "gross_net_worth": 10867777.38, "net_net_worth": 10867777.38, "gross_quota_value": 1.855893979904, "net_quota_value": 1.855893979904, "number_of_quotas": 5855818.003441199, "composition_date": "2025-05-04", "applied_value": 0.0, "applied_quotas": 0.0, "redeemed_value": 0.0, "redeemed_quotas": 0.0, "amortized_value": 0.0, "tax_anticipated_value": 0.0, "tax_anticipated_quotas": 0.0, "daily_rentability": 0.0006, "monthly_rentability": 0.0072, "yearly_rentability": 0.0898 }, ], "is_last_page": true, "page": 0, "limit": 10 } ``` ### Quota Evolution Map | Campo | Tipo | Descrição | | ------------------------ | ------ | --------------------------------------------------------------- | | `gross_net_worth` | number | Patrimônio bruto no dia da composição | | `net_net_worth` | number | Patrimônio líquido no dia da composição | | `gross_quota_value` | number | Valor bruto da cota | | `net_quota_value` | number | Valor líquido da cota | | `number_of_quotas` | number | Quantidade total de cotas no dia | | `composition_date` | string | Data da composição (formato: `YYYY-MM-DD`) | | `applied_value` | number | Valor aplicado no dia | | `applied_quotas` | number | Quantidade de cotas aplicadas no dia | | `redeemed_value` | number | Valor resgatado no dia | | `redeemed_quotas` | number | Quantidade de cotas resgatadas no dia | | `amortized_value` | number | Valor amortizado no dia | | `tax_anticipated_value` | number | Valor de imposto antecipado no dia | | `tax_anticipated_quotas` | number | Quantidade de cotas com imposto antecipado no dia | | `daily_rentability` | number | Rentabilidade diária (formato decimal, ex: `0.0007` para 0.07%) | | `monthly_rentability` | number | Rentabilidade mensal (formato decimal, ex: `0.0060` para 0.60%) | | `yearly_rentability` | number | Rentabilidade anual (formato decimal, ex: `0.096` para 9.6%) | --- # Consulta paginada de Séries de Emissão URL: /documentation/iaas/passivo/consultas/consultar_todas_series_de_emissao ### Request ENDPOINT /quota/issuance_series MÉTODO GET STATUS 200 ### Query Params | Parâmetro | Descrição | |-------------------------------|---------------------------------------------------------------------------| | `issuance_serie_key` | Chave única de identificação da série de emissão | | `fund_class_document_number` | CNPJ do fundo relacionado à série de emissão | :::warning Atenção Durante o processo de integração será exigido um meio de autenticação da hash enviada. ::: Caso 01: Retorno com uma série de emissão ```json { "data": [ { "name": "Sample Issuance Serie Name", "investment_category": "fidc", "condominum_type": "open_ended", "tax_classification": "long_term", "investment_restriction_type": "professional", "remuneration_type": "residual", "issuance_serie_key": "UUID", "minimum_share_capital": 0.0, "accounting_date": "YYYY-MM-DD", "start_date": "YYYY-MM-DD", "original_quota_value": 1.0, "serie": 1, "maturity_date": "YYYY-MM-DD", "sub_class": { "name": "Sample Sub Class Name", "sub_class_key": "UUID", "subordination_level": 0, "fund_class": { "name": "Sample Fund Name", "fund_class_key": "UUID", "document_number": "00.000.000/0000-00", "administrator": { "name": "Sample Administrator Name", "administrator_key": "UUID", "document_number": "00.000.000/0000-00" } } } } ], "limit": 50, "page": 0, "is_last_page": true } ``` ### Issuance Serie | Campo | Tipo | Descrição | |-------------------------------|--------|---------------------------------------------------------------------------| | `name` | string | Nome da série de emissão | | `investment_category` | string | Categoria de investimento (ex: fidc) | | `condominium_type` | string | Tipo de condomínio (`open_ended` ou `closed_ended`) | | `tax_classification` | string | Classificação fiscal (ex: `long_term`) | | `investment_restriction_type` | string | Tipo de restrição ao investimento (ex: `professional`) | | `remuneration_type` | string | Tipo de remuneração (ex: `residual`) | | `issuance_serie_key` | string | Chave única de identificação da série | | `minimum_share_capital` | number | Capital mínimo da série | | `accounting_date` | string | Data contábil da série | | `start_date` | string | Data de início da série | | `original_quota_value` | number | Valor original da cota | | `serie` | number | Número da série | | `maturity_date` | string | Data de vencimento da série | | `sub_class` | JSON | Objeto de **[Sub Class](#sub-class)** com informações da subclasse | ### Sub Class | Campo | Tipo | Descrição | |--------------------|--------|---------------------------------------------------------------------| | `name` | string | Nome da subclasse | | `sub_class_key` | string | Chave única da subclasse | | `subordination_level` | number | Nível de subordinação | | `fund_class` | JSON | Objeto de **[Fund Class](#fund-class)** com informações do fundo | ### Fund Class | Campo | Tipo | Descrição | |-------------------|--------|---------------------------------------------------------------------------------------| | `fund_class_key` | string | Chave única de identificação do fundo | | `document_number` | string | CNPJ do fundo | | `name` | string | Nome do fundo | | `administrator` | JSON | Objeto de **[Administrator](#administrator)** com informações do administrador | ### Administrator | Campo | Tipo | Descrição | |---------------------|--------|------------------------------------------------| | `administrator_key` | string | Chave única de identificação do administrador | | `name` | string | Nome do administrador | | `document_number` | string | CNPJ do administrador | --- # Consulta paginada de Fundos URL: /documentation/iaas/passivo/consultas/consultar_todos_fundos --- :::warning Atenção Este recurso está disponível apenas para integrações que exercem o papel de **Distribuidor**. ::: ### Request ENDPOINT /quota/fund_classes MÉTODO GET STATUS 200 ### Query Params | Parâmetro | Descrição | |------------------------------|--------------------------------------------------------------------------------------| | `document_number` | Documento do fundo | | `fund_class_key` | Chave única de identificação do fundo | :::warning Atenção Durante o processo de integração será exigido um meio de autenticação da hash enviada. ::: Caso 01: Retorno com apenas um fundo ```json { "data": [ { "name":"SAMPLE FUND CLASS NAME", "fund_class_key":"UUID", "document_number":"00.000.000/0000-00", "administrator":{ "name":"SAMPLE ADMINISTRATOR NAME", "administrator_key":"UUID", "document_number":"00.000.000/0000-00" } } ], "limit": 50, "page": 0, "is_last_page": true } ``` ### Fund Class | Campo | Tipo | Descrição | | ----------------- | ------ | ------------------------------------------------------------------------------------- | | `fund_class_key` | string | Chave única de identificação do fundo | | `document_number` | string | CNPJ do fundo | | `name` | string | Nome do fundo | | `administrator` | JSON | Objeto de **[Administrator](#administrator)** com informações do administrador | ### Administrator | Campo | Tipo | Descrição | | ------------------- | ------ | ---------------------------------------------- | | `administrator_key` | string | Chave única de identificação do administrador | | `name` | string | Nome do administrador | | `document_number` | string | CNPJ do administrador | --- # Enviar Boletim de Subscrição Assinado URL: /documentation/iaas/passivo/controle_de_oferta/enviar_boletim_de_subscricao_assinado --- ### Introdução Este recurso tem como objetivo nos enviar a comprovação de assinatura do **boletim de subscrição** de um **investidor** a uma **oferta de cotas** de um fundo. :::warning Atenção Este recurso está disponível apenas para integrações que exercem o papel de **Distribuidor**. ::: ### Input / Output: Como ***input*** deve ser enviada as informações relacionadas a subscrição, UUID da **oferta de cotas** do fundo que o investidor subscreveu e, **tipo de assinatura** e dependendo da assinatura o conteúdo necessário para validação. Segue abaixo exemplo. Como ***output*** será entregue uma ***subscription_note_key***. A ***subscription_note_key*** é utilizada para identificar o **boletim de subscrição**. ### Request ENDPOINT /quota_offering_control/investor/INVESTOR_KEY/signed_subscription_note MÉTODO POST STATUS 201 ### Request body ```json title='Request Body' { "number_of_quotas": 0.0, "original_subscription_note_value": 0.0, "start_date": "YYYY-MM-DD", "maturity_date": "YYYY-MM-DD", "quota_offering_key": "UUID", "transaction_type": "ted | b3", "signature_method": "opt_in", "opt_in_hash" : "OPT_IN_HASH" } ``` :::warning Atenção Durante o processo de integração será exigido um meio de autenticação da hash enviada. ::: ### Response ```json title='Response Body' { "subscription_note_key": "UUID" } ``` --- # Recuperando Informações sobre Boletim de Subscrição URL: /documentation/iaas/passivo/controle_de_oferta/informacoes_boletins_de_subscricao --- ### Request ENDPOINT /quota_offering_control/investor/INVESTOR_KEY/subscription_notes MÉTODO GET :::warning Atenção O endpoint acima está disponível apenas para integrações que exercem o papel de **Distribuidor**. ::: ENDPOINT /quota_offering_control/fund_class/FUND_CLASS_KEY/subscription_notes MÉTODO GET :::warning Atenção O endpoint acima está disponível apenas para integrações que exercem o papel de **Gestor**. ::: ### Responses STATUS 200 Caso 01: Investidor com um Boletim de Subscrição ```json { "data":[ { "subscription_note_key":"UUID", "quota_offering":{ "quota_offering_key":"UUID", "status":"active / closed", "original_quota_offering_value":0.00, "issued_number_of_quotas":0.00000000, "remaining_quota_offering_value":0.00, "start_date":"YYYY-MM-DD", "issuance_serie":{ "name":"1", "issuance_serie_key":"UUID", "sub_class":{ "name":"SÊNIOR", "sub_class_key":"UUID", "subordination_level":1, "fund_class":{ "fund_class_key":"UUID", "name":"SAMPLE FUND CLASS NAME", "document_number":"00.000.000/0000-00", "short_name":"SAMPLE FUND CLASS SHORT NAME" } }, "classification":"general / qualified / professional", "market_type":"primary / secondary" }, "type":"public / private", "data":{ "type":"public / private", "cvm_registration":{ "date":"YYYY-MM-DD", "number":"AAA/BBB/CCC/DDD/EEE/YYYY/000" }, "lead_coordinator":{ "name":"SAMPLE LEAD COORDINATOR NAME", "address":{ "uf":"SP", "city":"São Paulo", "number":"0000", "street":"Sample street name", "complement":"Sample complement" }, "document_number":"00.000.000/0000-00" }, "original_quota_offering_value":0.00 } }, "investor":{ "distributor":{ "distributor_key":"UUID", "document_number":"00.000.000/0000-00", "name":"Sample Distributor Name" }, "investor_key":"UUID", "document_number":"00.000.000/0000-00", "name":"SAMPLE INVESTOR NAME", "person_type":"natural_person / legal_person" }, "status":"send_to_generate_document / pending_document / pending_signature / canceled / active / sold_off", "transaction_type":"b3 / ted", "original_subscription_note_value":0.00, "issued_number_of_quotas":0.00000000, "remaining_subscription_note_value":0.00, "start_date":"YYYY-MM-DD", "financial_application_events":[ { "financial_application_event_key":"UUID", "financial_application_key":"UUID", "type":"consume_value", "share_capital":0.00, "event_datetime":"YYYY-MM-DD HH:MM:SS" }, { "financial_application_event_key":"UUID", "financial_application_key":"UUID", "type":"update_quotas", "number_of_quotas":0.00, "event_datetime":"YYYY-MM-DD HH:MM:SS" }, { "financial_application_event_key":"UUID", "financial_application_key":"UUID", "type":"cancel", "event_datetime":"YYYY-MM-DD HH:MM:SS" } ] } ], "limit":50, "page":0, "is_last_page":true } ``` Caso 02: Investidor sem Boletim de Subscrição ```json { "data":[], "limit":50, "page":0, "is_last_page":true } ``` ### Response Fields | Campo | Tipo | Descrição | |---------------|--------|----------------------------------------------------------------| | `data` | array | Lista de objetos de **[Subscription Note](#subscription-note)**| | `limit` | int | Limite de objetos recuperados por página | | `page` | int | Número da página recuperada | | `is_last_page`| boolean| Informação que indica se a página recuperada é a última | ### Observação TIPO * significa que o campo pode ser nulo, como no exemplo abaixo: | Tipo | |----------| | string * | ### Subscription Note | Campo | Tipo | Descrição | |---------------------------|----------|-------------------------------------------------------------------------------------------------------| | `subscription_note_key` | string | Chave única de identificação do boletim de subscrição | | `quota_offering` | JSON | Objeto de **[Quota Offering](#quota-offering)** | | `investor` | JSON | Objeto de **[Investor](#investor)** | | `status` | string | Enviar para gerar documento / Pendente documento / Pendente assinatura / Cancelado / Ativo / Esgotado | | `transaction_type` | string | B3 / TED | | `original_subscription_note_value` | float | Valor original do boletim de subscrição | | `issued_number_of_quotas` | float | Quantidade de cotas emitidas | | `remaining_subscription_note_value` | float | Valor restante do boletim de subscrição | | `start_date` | string | Data inicial do boletim de subscrição | | `financial_application_events`| array | Lista de objetos de **[Financial Application Event](#financial-application-event)** | | `maturity_date` | string* | Data de vencimento | | `original_number_of_quotas`| string* | Número do cotas emitidas | ### Quota Offering | Campo | Tipo | Descrição | |-----------------------------------|----------|-----------------------------------------------------------------------------------------| | `quota_offering_key` | string | Chave única de identificação da oferta | | `status` | string | Ativa / Fechada | | `original_quota_offering_value` | float | Valor original da oferta | | `issued_number_of_quotas` | float | Quantidade de cotas subscritas | | `remaining_quota_offering_value` | float | Valor restante da oferta | | `start_date` | string | Data inicial da oferta | | `issuance_serie` | string | Objeto de **[Issuance Serie](#issuance-serie)** | | `type` | string | Tipo da oferta pública/privada | | `cvm_registration` | JSON *| Dados do registro CVM | | `lead_coordinator` | JSON *| Dados do coordenador líder | | `maturity_date` | string *| Data de vencimento | | `original_number_of_quotas` | string *| Número do cotas emitidas | cvm_registration ```json { "date":"YYYY-MM-DD", "number":"AAA/BBB/CCC/DDD/EEE/YYYY/000" } ``` lead_coordinator ```json { "name":"SAMPLE LEAD COORDINATOR NAME", "address":{ "uf":"SP", "city":"São Paulo", "number":"0000", "street":"Sample street name", "complement":"Sample complement" }, "document_number":"00.000.000/0000-00" } ``` ### Financial Application Event | Campo | Tipo | Descrição | |-----------------------------------|----------|-----------------------------------------------------------------------------------------| | `financial_application_key` | string | Chave única de identificação da aplicação financeira | | `financial_application_event_key` | string | Chave única de identificação do evento da aplicação financeira | | `type` | string | Consumir valor / Atualizar cotas / Cancelar | | `event_datetime` | string | Data e hora do evento | | `share_capital` | float *| Valor do aporte da aplicação financeira *SOMENTE APARECE QUANDO FOR 'consume_value' | | `number_of_quotas` | float *| Número de cotas da aplicação financeira *SOMENTE APARECE QUANDO FOR 'update_quotas' | ### Issuance Serie | Campo | Tipo | Descrição | |-------------------------------|----------|---------------------------------------------------| | `name` | string | Nome da série de emissão | | `issuance_serie_key` | string | Chave única de identificação da série de emissão | | `sub_class` | JSON | Objeto de **[Sub Class](#sub-class)** | | `classification` | string | Profissional / Qualificado / Geral | | `market_type` | string | Primário / Secundário | | `serie` | integer | Curva de rendimento / Residual | ### Sub Class | Campo | Tipo | Descrição | |-------------------------------|----------|---------------------------------------------------| | `name` | string | Nome da sub classe | | `sub_class_key` | string | Chave única de identificação da sub classe | | `subordination_level` | int | Nível de subordinação da sub classe | | `fund_class` | JSON | Objeto de **[Fund Class](#fund-class)** | ### Fund Class | Campo | Tipo | Descrição | |-------------------------------|----------|---------------------------------------------------| | `name` | string | Nome da classe de fundo | | `fund_class_key` | string | Chave única de identificação da classe de fundo | | `document_number` | string | CNPJ da classe de fundo | | `short_name` | string | Nome reduzido da classe de fundo | ### Investor | Campo | Tipo | Descrição | |--------------------------|----------|---------------------------------------------------| | `name` | string | Nome do investidor | | `investor_key` | string | Chave única de identificação do investidor | | `document_number` | string | CPF/CNPJ do investidor | | `person_type` | string | Pessoa Física / Pessoa Jurídica / Classe de Fundo | | `distributor` | JSON | Objeto de **[Distributor](#distributor)** | ### Distributor | Campo | Tipo | Descrição | |--------------------------|----------|---------------------------------------------------| | `name` | string | Nome do distribuidor | | `distributor_key` | string | Chave única de identificação do distribuidor | | `document_number` | string | CPF/CNPJ do distribuidor | --- # Recuperando Informações sobre as Ofertas URL: /documentation/iaas/passivo/controle_de_oferta/informacoes_das_ofertas --- ### Request ENDPOINT /quota_offering_control/fund_class/FUND_CLASS_KEY/quota_offerings MÉTODO GET :::warning Atenção Este recurso está disponível apenas para integrações que exercem o papel de **Gestor**. ::: ### Responses STATUS 200 ### Query Params | Parâmetro | Descrição | |------------------------------|--------------------------------------------------------------------------------------| | `sub_class_key` | Chave única de identificação da sub classe | | `issuance_serie_key` | Chave única de identificação da série de emissão | Caso 01: Fundo com uma Oferta ```json { "data":[{ "quota_offering":{ "quota_offering_key":"UUID", "status":"active / closed", "original_quota_offering_value":0.00, "issued_number_of_quotas":0.00000000, "remaining_quota_offering_value":0.00, "start_date":"YYYY-MM-DD", "issuance_serie":{ "name":"1", "issuance_serie_key":"UUID", "sub_class":{ "name":"SÊNIOR", "sub_class_key":"UUID", "subordination_level":1, "fund_class":{ "fund_class_key":"UUID", "name":"SAMPLE FUND CLASS NAME", "document_number":"00.000.000/0000-00", "short_name":"SAMPLE FUND CLASS SHORT NAME" } }, "classification":"general / qualified / professional", "market_type":"primary / secondary" }, "type":"public / private", "data":{ "type":"public / private", "cvm_registration":{ "date":"YYYY-MM-DD", "number":"AAA/BBB/CCC/DDD/EEE/YYYY/000" }, "lead_coordinator":{ "name":"SAMPLE LEAD COORDINATOR NAME", "address":{ "uf":"SP", "city":"São Paulo", "number":"0000", "street":"Sample street name", "complement":"Sample complement" }, "document_number":"00.000.000/0000-00" }, "original_quota_offering_value":0.00 } } } ], "limit":50, "page":0, "is_last_page":true } ``` Caso 02: Fundo sem uma Oferta ```json { "data":[], "limit":50, "page":0, "is_last_page":true } ``` ### Response Fields | Campo | Tipo | Descrição | |---------------|--------|----------------------------------------------------------------| | `data` | array | Lista de objetos de **[Quota Offering](#quota-offering)**| | `limit` | int | Limite de objetos recuperados por página | | `page` | int | Número da página recuperada | | `is_last_page`| boolean| Informação que indica se a página recuperada é a última | ### Observação TIPO * significa que o campo pode ser nulo, como no exemplo abaixo: | Tipo | |----------| | string * | ### Quota Offering | Campo | Tipo | Descrição | |-----------------------------------|----------|-----------------------------------------------------------------------------------------| | `quota_offering_key` | string | Chave única de identificação da oferta | | `status` | string | Ativa / Fechada | | `original_quota_offering_value` | float | Valor original da oferta | | `issued_number_of_quotas` | float | Quantidade de cotas subscritas | | `remaining_quota_offering_value` | float | Valor restante da oferta | | `start_date` | string | Data inicial da oferta | | `issuance_serie` | string | Objeto de **[Issuance Serie](#issuance-serie)** | | `type` | string | Tipo da oferta pública/privada | | `cvm_registration` | JSON *| Dados do registro CVM | | `lead_coordinator` | JSON *| Dados do coordenador líder | | `maturity_date` | string *| Data de vencimento | | `original_number_of_quotas` | string *| Número do cotas emitidas | cvm_registration ```json { "date":"YYYY-MM-DD", "number":"AAA/BBB/CCC/DDD/EEE/YYYY/000" } ``` lead_coordinator ```json { "name":"SAMPLE LEAD COORDINATOR NAME", "address":{ "uf":"SP", "city":"São Paulo", "number":"0000", "street":"Sample street name", "complement":"Sample complement" }, "document_number":"00.000.000/0000-00" } ``` ### Issuance Serie | Campo | Tipo | Descrição | |-------------------------------|----------|---------------------------------------------------| | `name` | string | Nome da série de emissão | | `issuance_serie_key` | string | Chave única de identificação da série de emissão | | `sub_class` | JSON | Objeto de **[Sub Class](#sub-class)** | | `classification` | string | Profissional / Qualificado / Geral | | `market_type` | string | Primário / Secundário | | `serie` | integer | Curva de rendimento / Residual | ### Sub Class | Campo | Tipo | Descrição | |-------------------------------|----------|---------------------------------------------------| | `name` | string | Nome da sub classe | | `sub_class_key` | string | Chave única de identificação da sub classe | | `subordination_level` | int | Nível de subordinação da sub classe | | `fund_class` | JSON | Objeto de **[Fund Class](#fund-class)** | ### Fund Class | Campo | Tipo | Descrição | |-------------------------------|----------|---------------------------------------------------| | `name` | string | Nome da classe de fundo | | `fund_class_key` | string | Chave única de identificação da classe de fundo | | `document_number` | string | CNPJ da classe de fundo | | `short_name` | string | Nome reduzido da classe de fundo | --- # Solicitar Boletim de Subscrição URL: /documentation/iaas/passivo/controle_de_oferta/solicitar_boletim_de_subscricao --- ### Introdução Este recurso tem como objetivo criar uma solicitação de **boletim de subscrição** de um **investidor** a uma **oferta de cotas** de um fundo. A partir desta solicitação, o documento do boletim é gerado de acordo com o tipo de geração configurado na oferta. ### Input / Output: Como ***input*** deve ser enviado o UUID da **oferta de cotas** em que o investidor está subscrevendo, o **valor do boletim**, o **tipo de transação** e, opcionalmente, o método de assinatura e o grupo de signatários. Segue abaixo exemplo. Como ***output*** será entregue o objeto completo do **boletim de subscrição** criado, incluindo a ***subscription_note_key***. A ***subscription_note_key*** é utilizada para identificar o **boletim de subscrição**. ### Request ENDPOINT /quota_offering_control/investor/INVESTOR_KEY/subscription_note MÉTODO POST STATUS 201 ### Path Params | Parâmetro | Descrição | |-------------------|-----------------------| | `INVESTOR_KEY` | UUID do investidor | ### Request body ```json title='Request Body' { "original_subscription_note_value": 50000.00, "quota_offering_key": "UUID", "transaction_type": "ted", "signature_method": "certifiqi", "signer_group_key": "UUID" } ``` ### Subscription Note | Campo | Tipo | Descrição | Obrigatório | |------------------------------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------|-------------| | `original_subscription_note_value` | number | Valor do boletim de subscrição. Mínimo 0. Não pode exceder o valor restante da oferta | Sim | | `quota_offering_key` | string | UUID (36 caracteres) da oferta de cotas. A oferta deve existir e estar com status `active` | Sim | | `transaction_type` | string | `ted` ou `b3`. Para `b3`, a classe de fundo precisa ter conta B3 cadastrada | Sim | | `signature_method` | string | Enumerador do método de assinatura. Se omitido, o serviço define pelo tipo de pessoa: `natural_person` → `qi_sign`, `legal_person` → `certifiqi` | Não | | `signer_group_key` | string | UUID (36 caracteres) do grupo de signatários. Se omitido, usa o grupo de signatários default do investidor | Não | ### Signature Method | Enumerador | Descrição | |---------------|--------------------------------------------------------------| | `certifiqi` | Assinatura via CertifiQi (Certificado Digital) | | `qi_sign` | Assinatura via QI Sign (Assinatura Eletrônica) | ### Response ```json title='Response Body' { "subscription_note_key": "UUID", "status": "created", "original_number_of_quotas": 500, "original_subscription_note_value": 50000.00, "issued_number_of_quotas": 0, "remaining_subscription_note_value": 50000.00, "start_date": "YYYY-MM-DD", "transaction_type": "ted", "signature_method": "certifiqi", "investor": { "distributor": { "distributor_key": "UUID", "document_number": "00.000.000/0000-00", "name": "SAMPLE DISTRIBUTOR NAME" }, "investor_key": "UUID", "name": "SAMPLE INVESTOR NAME", "person_type": "natural_person / legal_person", "document_number": "00.000.000/0000-00" }, "quota_offering": { "quota_offering_key": "UUID", "status": "active", "original_quota_offering_value": 10000000.00, "issued_number_of_quotas": 25000.00, "remaining_quota_offering_value": 7500000.00, "start_date": "YYYY-MM-DD", "issuance_serie": { "name": "1", "issuance_serie_key": "UUID", "external_id": "SERIE-001", "sub_class": { "name": "SÊNIOR", "sub_class_key": "UUID", "subordination_level": 1, "fund_class": { "fund_class_key": "UUID", "document_number": "00.000.000/0000-00", "name": "SAMPLE FUND CLASS NAME", "short_name": "SAMPLE FUND CLASS SHORT NAME", "manager": { "name": "SAMPLE MANAGER NAME", "manager_key": "UUID", "document_number": "00.000.000/0000-00" }, "administrator": { "name": "SAMPLE ADMINISTRATOR NAME", "administrator_key": "UUID", "document_number": "00.000.000/0000-00", "data": {} }, "b3_account": "123456" } }, "classification": "general / qualified / professional", "market_type": "primary / secondary", "serie": 1, "issuance_serie_configuration": {} }, "type": "public / private", "subscription_note_template_key": "UUID", "subscription_note_generation_type": "internal / external", "regulatory_type": "exclusive_fund", "maturity_date": "YYYY-MM-DD", "status_events": [ { "status": "created", "event_datetime": "YYYY-MM-DD HH:MM:SS" }, { "status": "active", "event_datetime": "YYYY-MM-DD HH:MM:SS" } ] }, "financial_application_events": [], "status_events": [ { "status": "created", "event_datetime": "YYYY-MM-DD HH:MM:SS", "selected_agent": "distributor" } ] } ``` A descrição detalhada dos objetos **[Quota Offering](/documentation/iaas/passivo/controle_de_oferta/informacoes_boletins_de_subscricao#quota-offering)**, **[Investor](/documentation/iaas/passivo/controle_de_oferta/informacoes_boletins_de_subscricao#investor)** e **[Financial Application Event](/documentation/iaas/passivo/controle_de_oferta/informacoes_boletins_de_subscricao#financial-application-event)** pode ser consultada na página **[Informações sobre Boletim de Subscrição](/documentation/iaas/passivo/controle_de_oferta/informacoes_boletins_de_subscricao)**. --- # Recuperando Cotas Públicas URL: /documentation/iaas/passivo/fundos/cotas_publicas --- ### Request ENDPOINT /public_dash/mark_to_market/fund_quota/mark_to_markets METHOD GET STATUS 200 ### Query Params | Parâmetro | Tipo | Descrição | |-----------------------------|----------|---------------------------------------------------------------------------------------| | `internal_codes` | list | Lista de códigos internos da série de emissão para filtro exato dos registros. | | `from_reference_date` | string | Data de início do período a ser consultado (YYYY-MM-DD) | | `to_reference_date` | string | Data do fim do período a ser consultado (YYYY-MM-DD) | | `internal_code` | string | Código único da série de emissão a ser consultada | | `fund_class_document_number`| string | CNPJ (com pontuação) do fundo a ser consultado | | `limit` | int | Limite de objetos recuperados por página | | `page` | int | Número da página recuperada | :::warning Atenção O valor de cota se encontra a nível de **série de emissão (issuance_serie)** e portanto o uso do parâmetro **fund_class_document_number** implica no retorno de todas as séries. Recomenda-se o uso desse filtro apenas para o mapeamento de identificadores únicos das séries de emissão (**internal_code** e **issuance_serie_key**). ::: ### Response ```json title='Response Body' { "data": [ { "issuance_serie_key": "1de4125b-48c7-40ca-b97b-0b65fb356468", "internal_code": "INTERNAL-CODE-2", "fund_class_document_number": "12.345.678/0001-95", "fund_class_name": "FUNDO DE INVESTIMENTO DE TESTES", "marks_to_market": [ { "reference_date": "2025-09-05", "before_amortization_unit_price": 1000, "unit_price": 1000 } ] }, { "issuance_serie_key": "71f7ee44-388d-4916-b068-647e82fd67c8", "internal_code": "INTERNAL-CODE-1", "fund_class_document_number": "12.345.678/0001-95", "fund_class_name": "FUNDO DE INVESTIMENTO DE TESTES", "marks_to_market": [ { "reference_date": "2025-09-04", "before_amortization_unit_price": 1000, "unit_price": 1000 } ] } ], "limit": 5, "page": 0, "is_last_page": true } ``` ### Issuance Serie | Campo | Tipo | Descrição | |-----------------------------------|--------|--------------------------------------------------------------| | `issuance_serie_key` | string | Chave que identifica a série de emissão | | `internal_code` | string | Código que identifica a série de emissão internamente | | `fund_class_document_number` | string | CNPJ do fundo de investimento consultado | | `fund_class_name` | string | Nome do fundo de investimento consultado | | `marks_to_market` | array | Lista de objetos de **[Marks To Market](#marks-to-market)** | ### Marks To Market | Campo | Tipo | Descrição | |-----------------------------------|--------|--------------------------------------------------------------| | `reference_date` | string | Data do valor de cota da série de emissão (YYYY-MM-DD) | | `before_amortization_unit_price` | float | O valor da cota da série de emissão antes de uma amortização | | `unit_price` | float | O valor da cota da série de emissão após o fechamento | --- # Introdução URL: /documentation/iaas/passivo/inicio Bem-vindo à documentação de integração para operações relacionadas ao **Passivo**. Nesta seção, apresentamos todas as ferramentas e recursos necessários para interagir com os serviços oferecidos, desde o cadastro de investidores até a execução de operações financeiras. ## Visão Geral A API de Passivo oferece um conjunto de funcionalidades para facilitar a gestão e execução de operações financeiras para fundos de investimento. Com ela, é possível realizar o cadastro de investidores, aplicações financeiras, pedidos de resgate, bloqueio de cotas e outras operações essenciais para o gerenciamento de ativos. Os serviços são disponibilizados por meio de endpoints que permitem a comunicação segura e eficiente entre as aplicações dos clientes e a plataforma. ### Acesso aos Serviços Para obter acesso aos serviços, é necessário realizar as liberações necessárias em nossos ambientes de Homologação (Sandbox) e Produção. Entre em contato com o time de integração pelo e-mail [integracao.dtvm@qitech.com.br](mailto:integracao.dtvm@qitech.com.br) para solicitar as credenciais de acesso e receber orientações sobre o processo de ativação. ## Recursos Disponíveis ### Cadastro do Investidor - **Criar investidor / análise do investidor**: Permite o cadastro de um investidor e a análise cadastral inicial. Descrito em: [5.9.2.1 Criar investidor](/documentation/iaas/investidor/cadastro/criar_investidor) - **Buscar informações do investidor**: Consulta informações cadastrais de um investidor. Descrito em: [5.9.2.2 Buscar informações do investidor](/documentation/iaas/investidor/cadastro/busca_informacoes_do_investidor) - **Buscar informações de uma análise cadastral do investidor**: Permite consultar o status da análise cadastral de um investidor. Descrito em: [5.9.2.3 Buscar análise cadastral](/documentation/iaas/investidor/cadastro/busca_informacoes_de_uma_analise_cadastral_do_investidor) - **Enviar dados cadastrais**: Envia dados cadastrais complementares para análise. Descrito em: [5.9.2.4 Enviar dados cadastrais](/documentation/iaas/investidor/cadastro/enviar_dados_cadastrais) ### Aplicação Financeira - **Criar Aplicação Financeira**: Permite criar uma aplicação financeira em uma série de emissão. Descrito em: [5.9.5.1 Criar Aplicação Financeira](/documentation/iaas/passivo/aplicacao_financeira/criar_aplicacao_financeira) - **Consultar Aplicação Financeira**: Permite consultar aplicações financeiras por chave ou através de busca paginada. Descrito em: [5.9.5.2 Consulta por chave](/documentation/iaas/passivo/aplicacao_financeira/buscar_aplicacao_financeira_por_chave) e [5.9.5.3 Consulta paginada](/documentation/iaas/passivo/aplicacao_financeira/busca_paginada_aplicacoes_financeiras) ### Pedido de Resgate - **Criar Pedido de Resgate**: Permite criar um pedido de resgate para um investidor. Descrito em: [5.9.6.1 Criar Pedido de Resgate](/documentation/iaas/passivo/pedido_de_resgate/criar_pedido_de_resgate) - **Consultar Pedido de Resgate**: Consulta pedidos de resgate por chave ou através de busca paginada. Descrito em: [5.9.6.2 Consulta por chave](/documentation/iaas/passivo/pedido_de_resgate/buscar_pedido_de_resgate_por_chave), [5.9.6.3 Consulta paginada por investidor](/documentation/iaas/passivo/pedido_de_resgate/consulta_pedidos_resgate_investidor) e [5.9.6.4 Consulta paginada por classe de fundo](/documentation/iaas/passivo/pedido_de_resgate/consulta_pedidos_resgate_classe_fundo) ### Bloqueio de Cotas - **Solicitar Bloqueio de Cotas**: Permite solicitar o bloqueio de cotas para garantia. Descrito em: [5.9.8.1 Solicitar Bloqueio de Cotas](/documentation/iaas/passivo/bloqueio_de_cotas/solicitar_bloqueio_de_cotas) - **Consultar Bloqueios de Cotas**: Consulta bloqueios de cotas por investidor ou de forma paginada. Descrito em: [5.9.8.2 Consultar bloqueios de cotas](/documentation/iaas/passivo/bloqueio_de_cotas/consulta_de_bloqueio_de_cotas) ## Conclusão Essa documentação serve como guia completo para integração e utilização dos serviços de Passivo. Em caso de dúvidas, entre em contato com nossa equipe de suporte pelo e-mail [integracao.dtvm@qitech.com.br](mailto:integracao.dtvm@qitech.com.br). --- # Consultar Pedido de Resgate por chave URL: /documentation/iaas/passivo/pedido_de_resgate/buscar_pedido_de_resgate_por_chave --- ### Request ENDPOINT /quota/investor/INVESTOR_KEY/redemption_request/REDEMPTION_REQUEST_KEY MÉTODO GET STATUS 200 ### Responses Caso 01: Consulta bem-sucedida ```json { "redemption_request_key": "UUID", "redemption_request_type": "gross_redemption_value" | "number_of_quotas" | "remaining_application_value", "status": "pending_quote" | "processing_quote" | "canceled" | "quoted", "quotation_date": "yyyy-mm-dd", "payment_date":"yyyy-mm-dd", "request_datetime":"yyyy-mm-dd HH:MM:SS:MS", "processed_value": 0.00, "investor_position": { "investor": { "investor_key": "UUID", "document_number": "999.999.999-99" | "99.999.999/9999-99", "name": "", "person_type": "natural_person" | "legal_person", "account_data": { "owner": { "name": "", "document_number": "99.999.999/9999-99" }, "account_digit": "0", "account_branch": "0000", "account_number": "00000", "financial_institution_code": "000", "financial_institution_ispb": "00000000" }, "distributor": { "distributor_key": "UUID", "document_number": "99.999.999/9999-99", "name": "", "account_data": { "owner": { "name": "", "document_number": "99.999.999/9999-99" }, "account_digit": "0", "account_branch": "0000", "account_number": "00000", "financial_institution_code": "000", "financial_institution_ispb": "00000000" }, } }, "total_net_worth": 0.00, "total_number_of_quotas": 0.00000000, "investor_position_key":"UUID", "issuance_serie":{ "name":"1", "cetip_code":"0000000SN1", "start_date":"YYYY-MM-DD", "maturity_date":"YYYY-MM-DD", "original_quota_value":0.00000000000000, "remuneration_type":"yield_curve", "interest_rate_type":"post_fixed", "pre_fixed":{ "calendar_base":"workdays / calendar_360 / calendar_365", "monthly_rate":0.00000000000000 }, "post_fixed":{ "calendar_base":"workdays / calendar_360 / calendar_365", "indexer":"di / ipca", "rate":1, "lag":{ "reference":"daily / monthly", "amount":1 } }, "investment_category":"fidc / multi_market", "condominum_type":"open_ended / close_ended", "tax_classification":"short_term / long_term", "investment_restriction_type":"just_professional", "issuance_serie_key":"UUID", "minimum_share_capital":0.0, "accounting_date":"YYYY-MM-DD", "sub_class":{ "name":"COTA SÊNIOR", "sub_class_key":"UUID", "subordination_level":1, "fund_class":{ "name":"SAMPLE FUND CLASS NAME", "fund_class_key":"UUID", "document_number":"00.000.000/0000-00" } } } }, "status_events": [ { "event_datetime": "yyyy-mm-dd HH:MM:SS:ms", "status": "pending_quote" | "processing_quote" | "canceled" | "quoted", } ], } ``` ### Redemption Request | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|---------------------------------------------------------------------------------|------------| | `redemption_request_key` | string | Chave única de identificação do pedido de resgate | 36 | | `redemption_request_type` | string | Enumerador de **[Redemption Request Type](#redemption_request_type)** | - | | `status` | string | Enumerador de **[Redemption Request Status](#redemption_request_status)** | - | | `quotation_date` | string | Data da cotização | - | | `payment_date` | string | Data do pagamento | - | | `request_datetime` | string | Data da criação do pedido do resgate | - | | `processed_value` | float | Valor processado do resgate | - | | `investor_position` | JSON | Objeto de **[Investor Position](#investor_position)** | - | | `status_events` | array | Lista de objetos de **[Status Event](#status_event)** | - | ### Redemption Request Type | Enumerador | Descrição | |--------------------------------|-------------------------------------------------| | `gross_redemption_value` | Resgate por valor bruto | | `number_of_quotas` | Resgate por número de cotas | | `remaining_application_value` | Resgate por valor restate | ### Redemption Request Status | Enumerador | Descrição | |--------------------------|-------------------------------------------------| | `pending_quote` | Pendente pagamento | | `processing_quote` | Pendente cotização | | `quoted` | Cotizado | | `canceled` | Totalmente amortizado | ### Investor Position | Campo | Tipo | Descrição | |--------------------------|--------|-------------------------------------------------------| | `investor` | JSON | Objeto de **[Investor](#investor)** | | `total_net_worth` | float | Patrimônio Líquido da posição do investidor | | `total_number_of_quotas` | float | Número de cotas da posição do investidor | | `issuance_serie` | JSON | Objeto de **[Issuance Serie](#issuance_serie)** | | `investor_position_key` | JSON | Chave única de identificação da posição do investidor | ### Investor | Campo | Tipo | Descrição | Caracteres | |--------------------------|----------|---------------------------------------------------|------------| | `name` | string | Nome do investidor | até 255 | | `investor_key` | string | Chave única de identificação do investidor | 36 | | `document_number` | string | CPF/CNPJ do investidor | 14 ou 18 | | `person_type` | string | Pessoa Física / Pessoa Jurídica / Classe de Fundo | até 50 | | `distributor` | JSON | Objeto de **[Distributor](#distributor)** | - | | `account_data` | JSON | Objeto de **[Account Data](#account_data)** | - | ### Distributor | Campo | Tipo | Descrição | Caracteres | |--------------------------|----------|---------------------------------------------------|------------| | `name` | string | Nome do distribuidor | até 255 | | `distributor_key` | string | Chave única de identificação do distribuidor | - | | `document_number` | string | CPF/CNPJ do distribuidor | 14 ou 18 | | `account_data` | JSON | Objeto de **[Account Data](#account_data)** | - | ### Account Data | Campo | Tipo | Descrição | |------------------------------|----------|-----------------------------------------------------------------------------| | `account_digit` | string | Dígito da conta bancária | | `account_branch` | string | N° da agência da conta bancária | | `account_number` | string | N° da conta bancária | | `financial_institution_code` | string | Código da instituição financeira | | `financial_institution_ispb` | string | Identificador no Sistema de Pagamento Brasileiro da instituição financeira | ### Issuance Serie | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|---------------------------------------------------|------------| | `name` | string | Nome da série de emissão | até 255 | | `issuance_serie_key` | string | Chave única de identificação da série de emissão | 36 | | `cetip_code` | string | Código da série de emissão como ativo na CETIP | 10 | | `start_date` | string | Data de início da série de emissão | 10 | | `maturity_date` | string | Data de vencimento da série de emissão | 10 | | `original_quota_value` | float | Valor de cota original | - | | `remuneration_type` | string | Curva de rendimento / Residual | até 50 | | `investment_category` | string | FIDC / Multimercado | até 50 | | `condominum_type` | string | Aberto / Fechado | até 50 | | `tax_classification` | string | Curto prazo / Longo prazo | até 50 | | `investment_restriction_type` | string | Sem restrição / Qualificado / Profissional | até 50 | | `minimum_share_capital` | float | Valor mínimo para aplicação | - | | `accounting_date` | string | Data contábil da série de emissão | 10 | | `sub_class` | JSON | Objeto de **[Sub Class](#sub_class)** | - | ### Sub Class | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|---------------------------------------------------|------------| | `name` | string | Nome da sub classe | até 255 | | `sub_class_key` | string | Chave única de identificação da sub classe | 36 | | `subordination_level` | int | Nível de subordinação da sub classe | - | | `fund_class` | JSON | Objeto de **[Fund Class](#fund_class)** | - | ### Fund Class | Campo | Tipo | Descrição | Caracteres | |-------------------------------|----------|---------------------------------------------------|------------| | `name` | string | Nome da classe de fundo | até 255 | | `fund_class_key` | string | Chave única de identificação da classe de fundo | 36 | | `document_number` | string | CNPJ da classe de fundo | - | --- # Consulta paginada de pedidos de resgate por classe de fundo URL: /documentation/iaas/passivo/pedido_de_resgate/consulta_pedidos_resgate_classe_fundo Lista **pedidos de resgate** vinculados a uma **classe de fundo** (`fund_class_key`), com paginação. Permite filtrar por **status**, **data de cotização** e **documento do investidor**. ## Request ENDPOINT /quota/fund_class/{fund_class_key}/redemption_requests MÉTODO GET ### Query params | Parâmetro | Tipo | Obrigatoriedade | Descrição | |---|---|---|---| | `page` | integer | opcional | Número da página (começa em `0`). Padrão: `0`. | | `limit` | integer | opcional | Registros por página. Padrão: `20`. Máximo: `500`. | | `quotation_date` | string | opcional | Filtra pela data de cotização (`YYYY-MM-DD`). | | `investor_document_number` | string | opcional | Filtra pelo documento do investidor (com pontuação). | | `request_from_datetime` | string (date-time) | opcional | Retorna apenas os pedidos com data/hora de solicitação maior ou igual ao valor informado. Formato ISO 8601 com Z (`YYYY-MM-DDTHH:MM:SSZ`). | | `request_to_datetime` | string (date-time) | opcional | Retorna apenas os pedidos com data/hora de solicitação menor ou igual ao valor informado. Formato ISO 8601 com Z (`YYYY-MM-DDTHH:MM:SSZ`). | ```python title="Exemplo de chamada" GET /quota/fund_class/{fund_class_key}/redemption_requests?page=0&limit=50&investor_document_number=12.345.678/0001-90 ``` ## Response STATUS 200 ```json title="Response Body" { "data": [ { "redemption_request_key": "f1a2b3c4-d5e6-7890-abcd-ef1234567890", "quotation_date": "2024-06-15", "payment_date": "2024-06-18", "redemption_request_type": "number_of_quotas", "request_datetime": "2024-06-10T14:00:00.000000Z", "status": "quoted", "redemption_request_data": { "number_of_quotas": 500.0 }, "processed_value": 5250.5, "ir_value": 0.0, "iof_value": 0.0, "issuance_serie": { "issuance_serie_key": "c3d4e5f6-a7b8-9012-cdef-123456789012", "original_quota_value": 1.0, "current_number_of_quotas": 499500.0, "current_net_worth": 524475.25, "current_principal_value": 499500.0, "performance_fee_current_value": 0.0, "remuneration_type": "yield_curve", "minimum_share_capital": 1000.0, "interest_rate_type": "post_fixed", "name": "Série Única", "serie": 1, "sub_class": { "name": "Cota Sênior", "sub_class_key": "d4e5f6a7-b8c9-0123-def0-234567890123", "subordination_level": 1, "fund_class": { "name": "Fundo Exemplo FIDC", "short_name": "FEX", "document_number": "12.345.678/0001-90", "fund_class_key": "e5f6a7b8-c9d0-1234-ef01-345678901234", "accounting_date": "2024-06-01", "sub_type": "fidc", "tax_classification_id": "long_term", "condominum_type_id": "open_ended", "investment_category_id": "fidc", "prevent_payment": false, "integralization_account_key": null, "manager": { "manager_key": "f6a7b8c9-d0e1-2345-f012-456789012345", "document_number": "98.765.432/0001-10", "manager_name": "Gestora Exemplo S.A." } } }, "status": "active", "internal_code": "INT-FEX-01", "processing_method": "standard", "operation_period_configuration": {}, "current_quota_value": 1.05000055, "post_fixed": { "calendar_base": "calendar_252", "indexer": "cdi", "rate": 1.0, "lag": { "reference": "daily", "amount": 1 } }, "isin_code": "BRSTREXTFID6", "external_id": null, "specific_interest_rate_data": null }, "investor": { "distributor": { "distributor_key": "3571e292-3a83-4011-904d-20ee963022ef", "document_number": "12.345.678/0001-90", "name": "Distribuidora Exemplo S.A.", "account_data": { "owner": { "name": "Distribuidora Exemplo S.A.", "document_number": "12.345.678/0001-90" }, "account_digit": "1", "account_branch": "0001", "account_number": "12345", "financial_institution_code": "341", "financial_institution_ispb": "60746948" } }, "investor_key": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "name": "Maria Cotista Silva", "person_type": "natural_person", "document_number": "123.456.789-00", "external_id": "ext-inv-001", "external_distribution_key": null }, "status_events": [ { "status": "pending_quote", "event_datetime": "2024-06-10T14:00:01.000000Z" }, { "status": "quoted", "event_datetime": "2024-06-15T18:30:00.000000Z" } ] } ], "limit": 20, "page": 0, "is_last_page": true } ``` ### Atributos da resposta | Campo | Tipo | Descrição | |---|---|---| | `data` | array | Pedidos de resgate. | | `page` | integer | Página atual. | | `limit` | integer | Tamanho da página. | | `is_last_page` | boolean | Última página da consulta. | #### Campos principais de cada pedido em `data` | Campo | Tipo | Descrição | |---|---|---| | `redemption_request_key` | string | Identificador único do pedido (UUID). | | `redemption_request_type` | string | Tipo do pedido — veja [Tipos de pedido](#tipos-de-pedido-de-resgate). | | `status` | string | Status atual — veja [Status do pedido](#status-do-pedido-de-resgate). | | `quotation_date` | string | Data de cotização (`YYYY-MM-DD`). | | `payment_date` | string | Data prevista/realizada de pagamento (`YYYY-MM-DD`). | | `request_datetime` | string | Momento da solicitação (ISO 8601 com sufixo Z quando aplicável). | | `processed_value` | number | Valor processado (quando aplicável). | | `ir_value` / `iof_value` | number | Retenções quando aplicáveis. | | `redemption_request_data` | object | Payload específico do tipo de resgate (valores solicitados, cotas, etc.). | | `issuance_serie` | object | Série de emissão vinculada. | | `investor` | object | Dados do investidor e distribuidora. | | `status_events` | array | Histórico de mudanças de status. | ## Tipos de pedido de resgate | Valor | Descrição | |---|---| | `gross_redemption_value` | Resgate por valor bruto. | | `number_of_quotas` | Resgate por quantidade de cotas. | | `remaining_application_value` | Resgate do valor remanescente da aplicação. | | `net_value_redemption` | Resgate por valor líquido. | ## Status do pedido de resgate | Status | Descrição resumida | |---|---| | `created` | Criado. | | `pending_manager_approval` | Aguardando aprovação do gestor. | | `pending_quote` | Aguardando cotização. | | `processing_quotation` | Cotização em processamento. | | `pending_quotation_date_input` | Aguardando informação de data de cotização. | | `quoted` | Cotizado. | | `canceled` | Cancelado. | | `reprocessed` | Reprocessado. | ## Objetos da resposta ### Issuance Serie (`issuance_serie`) | Campo | Tipo | Descrição | |---|---|---| | `issuance_serie_key` | string | Chave única de identificação da série de emissão | | `name` | string | Nome da série de emissão | | `serie` | int | Número da série | | `original_quota_value` | float | Valor da cota original | | `current_quota_value` | float | Valor atual da cota | | `current_number_of_quotas` | float | Quantidade atual de cotas | | `current_net_worth` | float | Patrimônio líquido atual | | `current_principal_value` | float | Valor de principal atual | | `performance_fee_current_value` | float | Valor atual de taxa de performance | | `minimum_share_capital` | float | Valor mínimo para aplicação | | `remuneration_type` | string | Tipo de remuneração (ex.: `yield_curve`) | | `interest_rate_type` | string | Tipo de taxa (`post_fixed` / `pre_fixed`) | | `post_fixed` / `pre_fixed` | object | Dados de remuneração (`calendar_base`, `indexer`, `rate`, `lag`) | | `status` | string | Status da série de emissão (ex.: `active`) | | `internal_code` | string | Código interno da série | | `isin_code` | string | Código ISIN | | `processing_method` | string | Método de processamento | | `operation_period_configuration` | object | Configuração de períodos de operação | | `external_id` | string | Identificador externo | | `sub_class` | object | Objeto **Sub Class** | ### Sub Class (`sub_class`) | Campo | Tipo | Descrição | |---|---|---| | `name` | string | Nome da subclasse | | `sub_class_key` | string | Chave única de identificação da subclasse | | `subordination_level` | int | Nível de subordinação da subclasse | | `fund_class` | object | Objeto **Fund Class** | ### Fund Class (`fund_class`) | Campo | Tipo | Descrição | |---|---|---| | `name` | string | Nome da classe de fundo | | `short_name` | string | Nome curto da classe de fundo | | `fund_class_key` | string | Chave única de identificação da classe de fundo | | `document_number` | string | CNPJ da classe de fundo | | `accounting_date` | string | Data contábil da classe de fundo | | `sub_type` | string | Subtipo (ex.: `fidc`) | | `tax_classification_id` | string | Classificação tributária (ex.: `long_term`) | | `condominum_type_id` | string | Tipo de condomínio (ex.: `open_ended`) | | `investment_category_id` | string | Categoria de investimento (ex.: `fidc`) | | `prevent_payment` | boolean | Indica se os pagamentos estão bloqueados | | `integralization_account_key` | string | Chave da conta de integralização | | `manager` | object | Objeto **Manager** | ### Manager (`manager`) | Campo | Tipo | Descrição | |---|---|---| | `manager_key` | string | Chave única de identificação do gestor | | `document_number` | string | CNPJ do gestor | | `manager_name` | string | Nome do gestor | ### Investor (`investor`) | Campo | Tipo | Descrição | |---|---|---| | `investor_key` | string | Chave única de identificação do investidor | | `name` | string | Nome do investidor | | `document_number` | string | CPF/CNPJ do investidor | | `person_type` | string | Tipo de pessoa (`natural_person` / `legal_person`) | | `external_id` | string | Identificador externo do investidor | | `external_distribution_key` | string | Chave de distribuição externa | | `distributor` | object | Objeto **Distributor** | ### Distributor (`distributor`) | Campo | Tipo | Descrição | |---|---|---| | `distributor_key` | string | Chave única de identificação do distribuidor | | `name` | string | Nome do distribuidor | | `document_number` | string | CNPJ do distribuidor | | `account_data` | object | Objeto **Account Data** | ### Account Data (`account_data`) | Campo | Tipo | Descrição | |---|---|---| | `owner` | object | Titular da conta (`name`, `document_number`) | | `account_digit` | string | Dígito da conta bancária | | `account_branch` | string | N° da agência da conta bancária | | `account_number` | string | N° da conta bancária | | `financial_institution_code` | string | Código da instituição financeira | | `financial_institution_ispb` | string | Identificador no Sistema de Pagamento Brasileiro (ISPB) da instituição financeira | ## Possíveis erros STATUS 404 **Classe de fundo não encontrada** ```json { "title": " Fund Class not Found", "description": "Fund Class with key {fund_class_key} was not found.", "translation": "A classe com chave {fund_class_key} não foi encontrado.", "code": "QTA000002" } ``` --- # Consulta paginada de pedidos de resgate por investidor URL: /documentation/iaas/passivo/pedido_de_resgate/consulta_pedidos_resgate_investidor Retorna os **pedidos de resgate** de um investidor identificado por `investor_key`, com paginação e filtros opcionais por **status** e **data de cotização**. A lista é ordenada por fundo, subclasse, série e data de cotização (mais recente primeiro). ## Request ENDPOINT /quota/investor/{investor_key}/redemption_requests MÉTODO GET ### Query params | Parâmetro | Tipo | Obrigatoriedade | Descrição | |---|---|---|---| | `page` | integer | opcional | Número da página (começa em `0`) | | `limit` | integer | opcional | Registros por página. Padrão: `20`. Máximo: `500`. | | `status` | array de strings | opcional | Um ou mais valores de status do pedido (veja [Status do pedido de resgate](#status-do-pedido-de-resgate)). Repita o parâmetro ou use o formato aceito pela plataforma para listas. | | `quotation_date` | string | opcional | Filtra pela data de cotização no formato `YYYY-MM-DD`. | | `fund_class_document_number` | string | opcional | Filtra pelo documento (CNPJ) da classe de fundo. | | `request_from_datetime` | string (date-time) | opcional | Retorna apenas os pedidos com data/hora de solicitação maior ou igual ao valor informado. Formato ISO 8601 com Z (`YYYY-MM-DDTHH:MM:SSZ`). | | `request_to_datetime` | string (date-time) | opcional | Retorna apenas os pedidos com data/hora de solicitação menor ou igual ao valor informado. Formato ISO 8601 com Z (`YYYY-MM-DDTHH:MM:SSZ`). | ```python title="Exemplo de chamada" GET /quota/investor/{investor_key}/redemption_requests?page=0&limit=20&status=quoted"ation_date=2024-06-15 ``` ## Response STATUS 200 ```json title="Response Body" { "data": [ { "redemption_request_key": "f1a2b3c4-d5e6-7890-abcd-ef1234567890", "quotation_date": "2024-06-15", "payment_date": "2024-06-18", "redemption_request_type": "number_of_quotas", "request_datetime": "2024-06-10T14:00:00.000000Z", "status": "quoted", "redemption_request_data": { "number_of_quotas": 500.0 }, "processed_value": 5250.5, "ir_value": 0.0, "iof_value": 0.0, "issuance_serie": { "issuance_serie_key": "c3d4e5f6-a7b8-9012-cdef-123456789012", "original_quota_value": 1.0, "current_number_of_quotas": 499500.0, "current_net_worth": 524475.25, "current_principal_value": 499500.0, "performance_fee_current_value": 0.0, "remuneration_type": "yield_curve", "minimum_share_capital": 1000.0, "interest_rate_type": "post_fixed", "name": "Série Única", "serie": 1, "sub_class": { "name": "Cota Sênior", "sub_class_key": "d4e5f6a7-b8c9-0123-def0-234567890123", "subordination_level": 1, "fund_class": { "name": "Fundo Exemplo FIDC", "short_name": "FEX", "document_number": "12.345.678/0001-90", "fund_class_key": "e5f6a7b8-c9d0-1234-ef01-345678901234", "accounting_date": "2024-06-01", "sub_type": "fidc", "tax_classification_id": "long_term", "condominum_type_id": "open_ended", "investment_category_id": "fidc", "prevent_payment": false, "integralization_account_key": null, "manager": { "manager_key": "f6a7b8c9-d0e1-2345-f012-456789012345", "document_number": "98.765.432/0001-10", "manager_name": "Gestora Exemplo S.A." } } }, "status": "active", "internal_code": "INT-FEX-01", "processing_method": "standard", "operation_period_configuration": {}, "current_quota_value": 1.05000055, "post_fixed": { "calendar_base": "calendar_252", "indexer": "cdi", "rate": 1.0, "lag": { "reference": "daily", "amount": 1 } }, "isin_code": "BRSTREXTFID6", "external_id": null, "specific_interest_rate_data": null }, "investor": { "distributor": { "distributor_key": "3571e292-3a83-4011-904d-20ee963022ef", "document_number": "12.345.678/0001-90", "name": "Distribuidora Exemplo S.A.", "account_data": { "owner": { "name": "Distribuidora Exemplo S.A.", "document_number": "12.345.678/0001-90" }, "account_digit": "1", "account_branch": "0001", "account_number": "12345", "financial_institution_code": "341", "financial_institution_ispb": "60746948" } }, "investor_key": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "name": "Maria Cotista Silva", "person_type": "natural_person", "document_number": "123.456.789-00", "external_id": "ext-inv-001", "external_distribution_key": null }, "status_events": [ { "status": "pending_quote", "event_datetime": "2024-06-10T14:00:01.000000Z" }, { "status": "quoted", "event_datetime": "2024-06-15T18:30:00.000000Z" } ] } ], "limit": 20, "page": 0, "is_last_page": true } ``` ### Atributos da resposta | Campo | Tipo | Descrição | |---|---|---| | `data` | array | Pedidos de resgate. | | `page` | integer | Página atual. | | `limit` | integer | Tamanho da página. | | `is_last_page` | boolean | Última página da consulta. | #### Campos principais de cada pedido em `data` | Campo | Tipo | Descrição | |---|---|---| | `redemption_request_key` | string | Identificador único do pedido (UUID). | | `redemption_request_type` | string | Tipo do pedido — veja [Tipos de pedido](#tipos-de-pedido-de-resgate). | | `status` | string | Status atual — veja [Status do pedido](#status-do-pedido-de-resgate). | | `quotation_date` | string | Data de cotização (`YYYY-MM-DD`). | | `payment_date` | string | Data prevista/realizada de pagamento (`YYYY-MM-DD`). | | `request_datetime` | string | Momento da solicitação (ISO 8601 com sufixo Z quando aplicável). | | `processed_value` | number | Valor processado (quando aplicável). | | `ir_value` / `iof_value` | number | Retenções quando aplicáveis. | | `redemption_request_data` | object | Payload específico do tipo de resgate (valores solicitados, cotas, etc.). | | `issuance_serie` | object | Série de emissão vinculada. | | `investor` | object | Dados do investidor e distribuidora. | | `status_events` | array | Histórico de mudanças de status. | | `cancellation_data` | object | Presente quando o pedido foi cancelado (omitido quando `null`). | ## Tipos de pedido de resgate | Valor | Descrição | |---|---| | `gross_redemption_value` | Resgate por valor bruto. | | `number_of_quotas` | Resgate por quantidade de cotas. | | `remaining_application_value` | Resgate do valor remanescente da aplicação. | | `net_value_redemption` | Resgate por valor líquido. | ## Status do pedido de resgate | Status | Descrição resumida | |---|---| | `created` | Criado. | | `pending_manager_approval` | Aguardando aprovação do gestor. | | `pending_quote` | Aguardando cotização. | | `processing_quotation` | Cotização em processamento. | | `pending_quotation_date_input` | Aguardando informação de data de cotização. | | `quoted` | Cotizado. | | `canceled` | Cancelado. | | `reprocessed` | Reprocessado. | ## Objetos da resposta ### Issuance Serie (`issuance_serie`) | Campo | Tipo | Descrição | |---|---|---| | `issuance_serie_key` | string | Chave única de identificação da série de emissão | | `name` | string | Nome da série de emissão | | `serie` | int | Número da série | | `original_quota_value` | float | Valor da cota original | | `current_quota_value` | float | Valor atual da cota | | `current_number_of_quotas` | float | Quantidade atual de cotas | | `current_net_worth` | float | Patrimônio líquido atual | | `current_principal_value` | float | Valor de principal atual | | `performance_fee_current_value` | float | Valor atual de taxa de performance | | `minimum_share_capital` | float | Valor mínimo para aplicação | | `remuneration_type` | string | Tipo de remuneração (ex.: `yield_curve`) | | `interest_rate_type` | string | Tipo de taxa (`post_fixed` / `pre_fixed`) | | `post_fixed` / `pre_fixed` | object | Dados de remuneração (`calendar_base`, `indexer`, `rate`, `lag`) | | `status` | string | Status da série de emissão (ex.: `active`) | | `internal_code` | string | Código interno da série | | `isin_code` | string | Código ISIN | | `processing_method` | string | Método de processamento | | `operation_period_configuration` | object | Configuração de períodos de operação | | `external_id` | string | Identificador externo | | `sub_class` | object | Objeto **Sub Class** | ### Sub Class (`sub_class`) | Campo | Tipo | Descrição | |---|---|---| | `name` | string | Nome da subclasse | | `sub_class_key` | string | Chave única de identificação da subclasse | | `subordination_level` | int | Nível de subordinação da subclasse | | `fund_class` | object | Objeto **Fund Class** | ### Fund Class (`fund_class`) | Campo | Tipo | Descrição | |---|---|---| | `name` | string | Nome da classe de fundo | | `short_name` | string | Nome curto da classe de fundo | | `fund_class_key` | string | Chave única de identificação da classe de fundo | | `document_number` | string | CNPJ da classe de fundo | | `accounting_date` | string | Data contábil da classe de fundo | | `sub_type` | string | Subtipo (ex.: `fidc`) | | `tax_classification_id` | string | Classificação tributária (ex.: `long_term`) | | `condominum_type_id` | string | Tipo de condomínio (ex.: `open_ended`) | | `investment_category_id` | string | Categoria de investimento (ex.: `fidc`) | | `prevent_payment` | boolean | Indica se os pagamentos estão bloqueados | | `integralization_account_key` | string | Chave da conta de integralização | | `manager` | object | Objeto **Manager** | ### Manager (`manager`) | Campo | Tipo | Descrição | |---|---|---| | `manager_key` | string | Chave única de identificação do gestor | | `document_number` | string | CNPJ do gestor | | `manager_name` | string | Nome do gestor | ### Investor (`investor`) | Campo | Tipo | Descrição | |---|---|---| | `investor_key` | string | Chave única de identificação do investidor | | `name` | string | Nome do investidor | | `document_number` | string | CPF/CNPJ do investidor | | `person_type` | string | Tipo de pessoa (`natural_person` / `legal_person`) | | `external_id` | string | Identificador externo do investidor | | `external_distribution_key` | string | Chave de distribuição externa | | `distributor` | object | Objeto **Distributor** | ### Distributor (`distributor`) | Campo | Tipo | Descrição | |---|---|---| | `distributor_key` | string | Chave única de identificação do distribuidor | | `name` | string | Nome do distribuidor | | `document_number` | string | CNPJ do distribuidor | | `account_data` | object | Objeto **Account Data** | ### Account Data (`account_data`) | Campo | Tipo | Descrição | |---|---|---| | `owner` | object | Titular da conta (`name`, `document_number`) | | `account_digit` | string | Dígito da conta bancária | | `account_branch` | string | N° da agência da conta bancária | | `account_number` | string | N° da conta bancária | | `financial_institution_code` | string | Código da instituição financeira | | `financial_institution_ispb` | string | Identificador no Sistema de Pagamento Brasileiro (ISPB) da instituição financeira | ## Possíveis erros STATUS 404 **Status informado inválido** Algum valor em `status` não corresponde a um enumerador válido de `RedemptionRequestStatus`. ```json { "title": "Not found enumerator", "description": "invalid_status is not a valid type of RedemptionRequestStatus", "translation": "invalid_status não é um tipo válido de RedemptionRequestStatus", "code": "QTA000004" } ``` --- # Criar Pedido de Resgate URL: /documentation/iaas/passivo/pedido_de_resgate/criar_pedido_de_resgate --- ### Request ENDPOINT /quota/investor/INVESTOR_KEY/redemption_request MÉTODO POST STATUS 201 ```json title='Request Body' { "issuance_serie_key": "UUID", "redemption_request_type": "gross_redemption_value" | "number_of_quotas" | "remaining_application_value" | "net_value_redemption", "payment_method": "regular / b3", "gross_redemption_value":0.00, "net_value": 0.00, "remaining_application_value":0.00, "number_of_quotas":0.00000000, "disbursement_account_key": "UUID", "quotation_date": "yyyy-mm-dd", "reference_date": "yyyy-mm-dd" } ``` :::::warning - O campo redemption_request_type define se os campos gross_redemption_value , remaining_application_value e number_of_quotas devem ser passados ou não. - Caso gross_redemption_value , o campo gross_redemption_value é obrigatório. - Caso remaining_application_value , o campo remaining_application_value é obrigatório. - Caso number_of_quotas , o campo number_of_quotas é obrigatório. - Caso net_value_redenotuib , o campo net_value é obrigatório. - O campo disbursement_account_key deve ser utilizada para a liquidação do resgate em uma conta específica do investidor. Caso não seja informada uma conta específica, a conta principal do investidor será utilizada ::::: ### Body params | Campo | Tipo | Descrição | Obrigatório |-----------------------------------|----------|-----------------------------------------------------------------------------------------|-----| | `issuance_serie_key` | string | Chave única de identificação da Série de emissão | Sim | `redemption_request_type` | string | Enumerador de **[Tipos de Pedido de Resgate](#tipos_de_pedido_de_resgate)** | Sim | `gross_redemption_value` | float | Valor bruto do resgate, sem descontar IR e IOF | Não | `net_value` | float | Valor Líquido do resgate, já disconsiderando IR e IOF | Não | `remaining_application_value` | float | Valor restante da aplicação | Não | `number_of_quotas` | float | Valor da aplicação financeira | Não | `disbursement_account_key` | string | Chave única de identificação da conta bancária do investidor | Não | | `quotation_date` | string | Data de cotização do resgate | Não | | `payment_method` | string | Método de pagamento do resgate. Valores esperados:
• regular **(default)**
• b3: Via B3 | Não | | `reference_date` | string | Data de referência do resgate, no formato yyyy-mm-dd | Não | ### Tipos de Pedido de Resgate | Enumerador | Descrição | |---------------------------------|-------------------------------------------------| | `gross_redemption_value` | Resgate por valor bruto | | `number_of_quotas` | Resgate por número de cotas | | `remaining_application_value` | Resgate por posição remanescente |] | `net_value_redemption` | Resgate por valor líquido | ### Response ```json title='Response Body' { "redemption_request_key": "UUID" } ``` --- # Enviar Termo de Adesão Assinado URL: /documentation/iaas/passivo/termo_de_adesao/enviar_termo_de_adesao_assinado --- ### Introdução Este recurso tem como objetivo nos enviar a comprovação de assinatura do **termo de adesão** de um **investidor** a uma **série de emissão** de um fundo. :::warning Atenção Este recurso está disponível apenas para integrações que exercem o papel de **Distribuidor**. ::: ### Input / Output: Como ***input*** deve ser enviado o UUID da **série de emissão** do fundo que o investidor aderiu e **tipo de assinatura** e dependendo da assinatura o conteúdo necessário para validação. Segue abaixo exemplo. Como ***output*** será entregue uma ***investor_adhesion_key***. A ***investor_adhesion_key*** é utilizada para identificar a **adesão do investidor**. ### Request ENDPOINT /investor_adhesion/investor/INVESTOR_KEY/signed_investor_adhesion MÉTODO POST STATUS 201 ### Request body ```json title='Request Body' { "issuance_serie_key": "UUID", "signature_method": "opt_in", "opt_in_hash" : "OPT_IN_HASH" } ``` :::warning Atenção Durante o processo de integração será exigido um meio de autenticação da hash enviada. ::: ### Response ```json title='Response Body' { "investor_adhesion_key": "UUID" } ``` --- # Solicitar Termo de Adesão URL: /documentation/iaas/passivo/termo_de_adesao/solicitar_termo_de_adesao --- ### Introdução Este recurso tem como objetivo criar uma solicitação de **termo de adesão** de um **investidor** a uma **série de emissão** de um fundo. A partir desta solicitação, são gerados os documentos necessários para a formalização da adesão, de acordo com as configurações da série de emissão. ### Input / Output: Como ***input*** deve ser enviado o UUID da **série de emissão** em que o investidor está aderindo e, opcionalmente, o **método de assinatura** que será utilizado para os documentos gerados. Como ***output*** será entregue uma ***investor_adhesion_key***. A ***investor_adhesion_key*** é utilizada para identificar a **adesão do investidor**. ### Request ENDPOINT /investor_adhesion/investor/INVESTOR_KEY/investor_adhesion MÉTODO POST STATUS 201 ### Request body ```json title='Request Body' { "issuance_serie_key": "UUID", "signature_method": "qi_sign" } ``` ### Investor Adhesion | Campo | Tipo | Descrição | Caracteres | Obrigatório | |----------------------|--------|------------------------------------------------------------------------|------------|-------------| | `issuance_serie_key` | string | Chave da série de emissão a qual o investidor está aderindo | 36 | Sim | | `signature_method` | string | Enumerador do método de assinatura a ser utilizado nos documentos | até 255 | Não | ### Signature Method | Enumerador | Descrição | |---------------|--------------------------------------------------------------| | `certifiqi` | Assinatura via CertifiQi (Certificado Digital) | | `qi_sign` | Assinatura via QI Sign (Assinatura Eletrônica) | ### Response ```json title='Response Body' { "investor_adhesion_key": "UUID" } ``` :::info Fluxo da adesão Após solicitar uma nova adesão, podemos seguir dois caminhos: - **Investidor NÃO tinha uma adesão ativa**: a adesão é criada no status `pending_documents` e permanece assim até que todos os documentos exigidos sejam gerados e assinados. - **Investidor já tinha uma adesão ativa**: a requisição é rejeitada. :::