Skip to main content

Recuperando Informações sobre Retorno de Capital


Request

ENDPOINT
/quota_distributor/investor/INVESTOR_KEY/capital_returns
MÉTODO
GET

Responses

STATUS
200
Caso 01: Investidor com um Retorno de Capital
{
"data": [
{
"capital_return_key": "UUID",
"origin_key": "UUID",
"net_value": 0.00,
"iof_value": 0.00,
"ir_value": 0.00,
"capital_return_date": "YYYY-MM-DD",
"payment_date": "YYYY-MM-DD",
"status": "sending_to_administrator / pending_payment / paid",
"capital_return_type": "amortization / redemption_request / tax_anticipation",
"number_of_units": 0.00000000,
"financial_application": {
"financial_application_key": "UUID",
"share_capital": 0.00,
"original_principal_value": 0.00,
"current_principal_value": 0.00,
"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",
"investor_position": {
"total_net_worth": 0.00,
"total_number_of_quotas": 0.00000000,
"investor": {
"investor_key": "UUID",
"document_number": "000.000.000-00 / 00.000.000/0001-00",
"name": "NAME",
"person_type": "natural_person / legal_person",
"account_data": {
"financial_institution_code": "000",
"account_number": "000000000000",
"account_digit": "0",
"account_branch": "0000",
"financial_institution_ispb": "00000000",
},
"status": "approved / pending_update",
"associations": [
"manager": {
"manager_key": "UUID",
"name": "NAME",
"document_number": "000.000.000-00 / 00.000.000/0001-00",
},
"permissions": [
{"type": "read_data"}
]
],
"distributor": {
"distributor_key": "UUID",
"document_number": "000.000.000-00 / 00.000.000/0001-00",
"name": "NAME",
"account_data": {
"financial_institution_code": "000",
"account_number": "000000000000",
"account_digit": "0",
"account_branch": "0000",
"financial_institution_ispb": "00000000",
},
},
"investor_sub_type": "fund_class / financial_institution"
},
"issuance_serie": {
"issuance_serie_key": "UUID",
"name": "1",
"cetip_code": "0000000SN1",
"start_date": "YYYY-MM-DD",
"maturity_date": "YYYY-MM-DD",
"original_quota_value": 0.00000000000000,
"remuneration_type": "yield_curve / residual",
"interest_rate_type": "post_fixed / 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": "retail / qualified / professional",
"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
}

Response Fields

CampoTipoDescrição
dataarrayLista de objetos de Capital Return
limitintLimite de objetos recuperados por página
pageintNúmero da página recuperada
is_last_pagebooleanInformação que indica se a página recuperada é a última

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
capital_return_datestringValor líquido 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
financial_applicationJSONObjeto de Financial Application

Financial Application

CampoTipoDescrição
financial_application_keystringChave única de identificação da aplicação financeira
share_capitalfloatValor do aporte da aplicação financeira
original_principal_valuefloatValor original de principal no valor da cota da aplicação financeira
current_principal_valuefloatValor atual de principal no valor da cota da aplicação financeira
original_number_of_unitsfloatN° original de cotas da aplicação financeira
current_number_of_unitsfloatN° atual de cotas da aplicação financeira
quotation_datestringData de cotização da aplicação financeira
statusstringPendente Pagamento / Pendente Cotização / Cotizado / Liquidado / Resgatado / Cancelado"
investor_positionJSONObjeto de Investor Position
issuance_serieJSONObjeto de Issuance Serie

Investor Position

CampoTipoDescrição
total_net_worthfloatValor total do patrimônio da posição do investidor
total_number_of_quotasfloatValor total do número de cotas da posição do investidor
investorJSONObjeto de Investor
issuance_serieJSONObjeto de Issuance Serie

Investor

CampoTipoDescriçãoCaracteres
investor_keystringChave única de identificação do investidor36
document_numberstringCPF / CNPJ do investidor14 a 18
namestringNome / Razão Social do investidoraté 255
person_typestringPessoa física / pessoa jurídicaaté 50
account_dataJSONObjeto de Account Data-
statusstringAprovado / pendente atualização-
associationsarrayLista do objeto Association-
distributorJSONObjeto de Distributor-
investor_sub_typestringClasse de fundo / instituição financeiraaté 50

Account Data

CampoTipoDescriçãoCaracteres
financial_institution_codestringN° da instituição financeiraaté 4
account_numberstringN° da conta bancáriaaté 20
account_digitstringDígito da conta bancaria1
account_branchstringAgência da conta bancáriaaté 4
financial_institution_ispbstringCódigo ISPB da instituição financeira8

Association

CampoTipoDescriçãoCaracteres
managerJSONObjeto de Manager-
permissionsarrayLista do objeto Permission-

Manager

CampoTipoDescriçãoCaracteres
manager_keystringChave única de identificação do gestor do fundo36
document_numberstringCPF / CNPJ do gestor14 a 18
namestringNome / Razão social do gestoraté 255

Permission

CampoTipoDescriçãoCaracteres
typestringNome do tipo de permissãoaté 255

Distributor

CampoTipoDescriçãoCaracteres
distributor_keystringChave única de identificação do distribuidor36
document_numberstringCPF / CNPJ do distribuidor14 a 18
namestringNome / Razão social do gestoraté 255
account_dataJSONObjeto de Account Data-

Issuance Serie

CampoTipoDescriçãoCaracteres
issuance_serie_keystringChave única de identificação da série de emissão36
namestringNome da série de emissãoaté 255
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
interest_rate_typestringPós fixado / pré fixadoaté 50
pre_fixedJSONObjeto de Pre fixed-
post_fixedJSONObjeto de Post fixed-
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-

Pre fixed

CampoTipoDescriçãoCaracteres
calendar_basestringDias úteis / calendário 360 / calendário 365até 255
monthly_ratefloatTaxa mensal-

Post fixed

CampoTipoDescriçãoCaracteres
calendar_basestringDias úteis / calendário 360 / calendário 365até 255
indexerstringDI / IPCAaté 255
ratefloatTaxa-
lagJSONObjeto de Lag-

Lag

CampoTipoDescriçãoCaracteres
referencestringDiário / Mensalaté 255
amountintegerQuantidade de lag-

Sub Class

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

Fund Class

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