Skip to main content

Consultar Aplicação Financeira por chave

Request​

ENDPOINT
/quota_distributor/investor/INVESTOR_KEY/financial_application/FINANCIAL_APPLICATION_KEY
MÉTODO
GET
STATUS
200

Responses​

Caso 01: Consulta bem-sucedida
{
    "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,
        "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​

CampoTipoDescriçãoCaracteres
external_idstringIdentificador externoaté 100
financial_application_keystringChave única de identificação da aplicação financeira36
share_capitalfloatValor do aporte-
investor_positionJSONObjeto de Investor Position-
original_principal_valuefloatValor original de principal por cota-
current_principal_valuefloatValor atual de principal por cota-
original_number_of_unitsfloatQuantidade original de cotas-
current_number_of_unitsfloatQuantidade atual de cotas-
quotation_datestringData da cotização-
statusstringEnumerador de Financial Application Status-
status_eventsarrayLista de objetos de Status Event-
capital_returnsarrayLista de objetos de Capital Return-

Financial Application Status​

EnumeradorDescrição
pending_paymentPendente pagamento
pending_quotePendente cotização
quotedCotizado
settledTotalmente amortizado
redeemedTotalmente resgatado
canceledcancelado

Investor Position​

CampoTipoDescrição
investorJSONObjeto de Investor
total_net_worthfloatPatrimônio Líquido da posição do investidor
total_number_of_quotasfloatNúmero de cotas da posição do investidor
issuance_serieJSONObjeto de Issuance Serie

Investor​

CampoTipoDescriçãoCaracteres
namestringNome do investidoraté 255
investor_keystringChave única de identificação do investidor36
document_numberstringCPF/CNPJ do investidor14 ou 18
person_typestringPessoa Física / Pessoa Jurídica / Classe de Fundoaté 50
distributorJSONObjeto de Distributor-
account_dataJSONObjeto de Account Data-

Distributor​

CampoTipoDescriçãoCaracteres
namestringNome do distribuidoraté 255
distributor_keystringChave única de identificação do distribuidor-
document_numberstringCPF/CNPJ do distribuidor14 ou 18
account_dataJSONObjeto de Account Data-

Account Data​

CampoTipoDescrição
account_digitstringDígito da conta bancária
account_branchstringN° da agência da conta bancária
account_numberstringN° da conta bancária
financial_institution_codestringCódigo da instituição financeira
financial_institution_ispbstringIdentificador no Sistema de Pagamento Brasileiro da instituição financeira

Issuance Serie​

CampoTipoDescriçãoCaracteres
namestringNome da série de emissãoaté 255
issuance_serie_keystringChave única de identificação da série de emissão36
cetip_codestringCódigo da série de emissão como ativo na CETIP10
start_datestringData de início da série de emissão10
maturity_datestringData de vencimento da série de emissão10
original_quota_valuefloatValor de cota original-
remuneration_typestringCurva de rendimento / Residualaté 50
investment_categorystringFIDC / Multimercadoaté 50
condominum_typestringAberto / Fechadoaté 50
tax_classificationstringCurto prazo / Longo prazoaté 50
investment_restriction_typestringSem restrição / Qualificado / Profissionalaté 50
minimum_share_capitalfloatValor mínimo para aplicação-
accounting_datestringData contábil da série de emissão10
sub_classJSONObjeto de Sub Class-

Sub Class​

CampoTipoDescriçãoCaracteres
namestringNome da sub classeaté 255
sub_class_keystringChave única de identificação da sub classe36
subordination_levelintNível de subordinação da sub classe-
fund_classJSONObjeto de Fund Class-

Fund Class​

CampoTipoDescriçãoCaracteres
namestringNome da classe de fundoaté 255
fund_class_keystringChave única de identificação da classe de fundo36
document_numberstringCNPJ da classe de fundo-

Capital Return​

CampoTipoDescrição
capital_return_keystringChave única de identificação do retorno de capital
origin_keystringChave única de identificação da origem do retorno de capital
net_valuefloatValor líquido do retorno de capital
iof_valuefloatValor de IOF do retorno de capital
ir_valuefloatValor de IR do retorno de capital
payment_datestringData de pagamento do retorno de capital
capital_return_datestringData de criação do retorno de capital
statusstringEnviando para o Administrador / Pendente Pagamento / Pago
capital_return_typestringAmortização / Pedido de Resgate / Come-cotas
number_of_unitsfloatN° de quotas do retorno de capital