Consultar Aplicação Financeira por chave

Retorna uma aplicação financeira de um investidor pela chave.

Disponível em

Perfil	Host	Permissão exigida
Gestora	`manager-api`	Leitura
Consultoria	`consultant-api`	Liberada pelo time de integração

URL base de cada host: Ambientes (Hosts).

Request

ENDPOINT

/quota/investor/INVESTOR_KEY/financial_application/FINANCIAL_APPLICATION_KEY

MÉTODO

GET

STATUS

200

A gestora só consulta investidores aos quais está vinculada; a consultoria, aplicações de fundos em que tem permissão.

Responses

Caso 01: Consulta bem-sucedida

{
    "financial_application_key": "UUID",
    "external_id": "SEU_ID_EXTERNO",
    "share_capital": 1000.0,
    "status": "quoted",
    "financial_application_type": "primary_market",
    "payment_method": "regular",
    "central_depositary": "unregistered",
    "quotation_date": "2025-01-10",
    "original_number_of_quotas": 998.12345678,
    "original_number_of_quotas_str": "998.12345678",
    "current_number_of_quotas": 998.12345678,
    "current_principal_value": 1000.0,
    "acquisition_cost": 1000.0,
    "status_events": [
        {
            "event_datetime": "2025-01-09T14:30:00Z",
            "status": "pending_payment"
        },
        {
            "event_datetime": "2025-01-10T21:00:00Z",
            "status": "quoted"
        }
    ],
    "redemptions": [],
    "amortizations": [],
    "investor": {
        "investor_key": "UUID",
        "name": "INVESTIDOR EXEMPLO",
        "person_type": "natural_person",
        "document_number": "969.698.790-03",
        "distributor": {
            "distributor_key": "UUID",
            "document_number": "11.222.333/0001-81",
            "name": "DISTRIBUIDORA EXEMPLO",
            "account_data": {}
        }
    },
    "issuance_serie": {
        "issuance_serie_key": "UUID",
        "name": "SERIE 1",
        "serie": 1,
        "status": "active",
        "remuneration_type": "yield_curve",
        "original_quota_value": 1.0,
        "current_quota_value": 1.0018,
        "minimum_share_capital": 0.0,
        "sub_class": {
            "name": "COTA SÊNIOR",
            "sub_class_key": "UUID",
            "subordination_level": 1,
            "fund_class": {
                "name": "FUNDO EXEMPLO",
                "fund_class_key": "UUID",
                "document_number": "11.222.333/0001-81"
            }
        }
    },
    "water_mark_events": []
}

Campos opcionais (external_id, original_number_of_quotas, current_number_of_quotas, current_principal_value, acquisition_cost, quotation_date) só aparecem quando preenchidos. As listas status_events, redemptions, amortizations e reserved_taxable_yields são omitidas quando vazias.

Financial Application

Campo	Tipo	Descrição
`financial_application_key`	string	Chave única da aplicação financeira
`external_id`	string	Identificador externo
`share_capital`	float	Valor aplicado
`status`	string	Enumerador de Financial Application Status
`financial_application_type`	string	`primary_market` (aplicação) ou `secondary_market` (mercado secundário)
`payment_method`	string	`regular` (Pix ou TED) ou `b3`
`central_depositary`	string	`unregistered` ou `cetip`
`quotation_date`	string	Data de cotização (`yyyy-mm-dd`)
`original_number_of_quotas`	float	Quantidade de cotas na cotização (`_str`: o mesmo valor como string, sem arredondamento)
`current_number_of_quotas`	float	Quantidade atual de cotas
`current_principal_value`	float	Principal atual
`acquisition_cost`	float	Custo de aquisição
`status_events`	array	Histórico de status: `status` e `event_datetime` (UTC)
`redemptions`	array	Resgates que consumiram a aplicação: `redemption_key`, `redemption_type`, `number_of_quotas`, `total_value`, `ir_value`, `iof_value`, `yield_value`, `taxable_yield_value`, `redemption_date`
`amortizations`	array	Amortizações pagas: `amortization_key`, `payment_date`, `total_value`, `principal_reduction`, `acquisition_cost_reduction` e, quando houver, `yield_value`, `taxable_yield_value`, `ir_value`, `iof_value`
`reserved_taxable_yields`	array	Rendimentos tributáveis reservados (come-cotas)
`investor`	object	Investidor: `investor_key`, `name`, `person_type`, `document_number` e `distributor`
`issuance_serie`	object	Série de emissão, com `sub_class` e `sub_class.fund_class`
`water_mark_quota_value`	float	Valor de cota de referência da marca d'água (taxa de performance), quando houver
`water_mark_reference_date`	string	Data de referência da marca d'água, quando houver
`water_mark_events`	array	Eventos de marca d'água

Financial Application Status

Enumerador	Descrição
`created`	Criada
`pending_formalization`	Pendente de formalização (boletim de subscrição)
`pending_payment`	Pendente de pagamento
`processing_quotation`	Cotização em processamento
`pending_quote`	Pendente de cotização
`processing_issuance_serie_impacts`	Processando impactos na série
`quoted`	Cotizada
`settled`	Totalmente amortizada
`redeemed`	Totalmente resgatada
`canceled`	Cancelada
`reprocessed`	Reprocessada

Erros

Status	Código	Quando acontece
400	`QIT000004`	A gestora não está vinculada ao investidor
403	`QTA000315`	A consultoria não tem permissão no fundo da aplicação
404	`QTA000021`	Investidor não encontrado
404	`QTA000260`	Aplicação financeira não encontrada para o investidor

Erros de autenticação, permissão e host: veja Erros da API.

Request​

Responses​

Financial Application​

Financial Application Status​

Erros​

Request

Responses

Financial Application

Financial Application Status

Erros