Pular para o conteúdo principal

Consulta de Resgates por Classe de Fundo

Retorna, paginadas, os pedidos de resgate que a sua classe de fundo fez em cotas de outros fundos.

Disponível em
PerfilHostPermissão exigida
Gestoramanager-apiLeitura
Consultoriaconsultant-apiLer Aplicações, Resgates e Séries

URL base de cada host: Ambientes (Hosts).

Request​

ENDPOINT
/trade_fund_quota/fund_class/FUND_CLASS_KEY/redemption_requests
MÉTODO
GET

Query Params​

ParâmetroTipoDescrição
pageintNúmero da página, a partir de 0. Padrão: 0.
limitintRegistros por página. Padrão: 10. Máximo: 50.
quotation_datedataData de cotização exata (YYYY-MM-DD).
quotation_date_fromdataData de cotização inicial (YYYY-MM-DD).
quotation_date_todataData de cotização final (YYYY-MM-DD).
redemption_request_statuslistaStatus a incluir, separados por vírgula.
not_redemption_request_statuslistaStatus a excluir, separados por vírgula.
document_numberstringCNPJ da classe do fundo investido, com pontuação. Correspondência exata.
internal_codeslistaCódigos internos das séries investidas, separados por vírgula.
asset_typestringTipo do ativo (ex.: fidc_fund_quota, multi_market_fund_quota).
sub_class_namelistaNomes de subclasse da série investida, separados por vírgula (sem diferenciar acento e maiúscula).
searchstringBusca parcial no nome curto do fundo investido, no nome da série, no código interno ou no CNPJ.

Os status possíveis estão em Criar Pedido de Resgate.

Response​

STATUS
200
Caso 01: Retorno com um resgate
{
"data": [
{
"redemption_request_key": "UUID",
"status": "confirmed",
"quotation_date": "YYYY-MM-DD",
"payment_date": "YYYY-MM-DD",
"amount": 0.00,
"issuance_serie": {
"issuance_serie_key": "UUID",
"name": "Issuance Serie Name",
"subclass_name": "SUBORDINADA",
"serie": 1,
"quota_calculation_method": "quota_value",
"internal_code": "Internal Code",
"fund_class_name": "Fund Class Name",
"fund_class_short_name": "Fund Class Short Name",
"fund_class_document_number": "00.000.000/0000-00",
"minimum_share_capital": 0.0,
"investment_category": "fixed_income",
"payment_type": "automatic_debit",
"financial_institution_code": "341",
"account_data": {
"account_digit": "0",
"account_branch": "0001",
"account_number": "12345",
"financial_institution_code": "329",
"financial_institution_ispb": "00000000"
},
"last_updated_date": "YYYY-MM-DD",
"administrator": {
"administrator_key": "UUID",
"name": "Administrator Name",
"document_number": "00.000.000/0000-00"
},
"operation_periods": {
"redemption_request": {
"payment": {
"days": 1,
"type": "until",
"calendar_base": "calendar_365"
},
"quotation": {
"days": 1,
"type": "fixed",
"calendar_base": "calendar_365"
}
},
"amortization_request": {
"payment": {
"days": 0,
"type": "fixed",
"calendar_base": "workdays"
},
"quotation": {
"days": 0,
"type": "fixed",
"calendar_base": "workdays"
}
},
"financial_application": {
"payment": {
"days": 0,
"type": "fixed",
"calendar_base": "workdays"
},
"quotation": {
"days": 0,
"type": "fixed",
"calendar_base": "workdays"
}
}
}
},
"fund_class": {
"fund_class_key": "UUID",
"name": "Fund Class Name",
"short_name": "Fund Class Short Name",
"document_number": "00.000.000/0000-00",
"accounting_date": "YYYY-MM-DD",
"distributor": {
"name": "Distributor Name",
"distributor_key": "UUID",
"document_number": "00.000.000/0000-00"
},
"manager": {
"manager_key": "UUID",
"manager_name": "Manager Name",
"document_number": "00.000.000/0000-00"
}
}
}
],
"limit": 10,
"page": 0,
"is_last_page": true
}

Page​

CampoTipoDescrição
dataarrayLista de objetos de Redemption Request
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

Redemption Request​

CampoTipoDescrição
redemption_request_keystringChave única do pedido de resgate
external_redemption_request_keystringChave externa de controle (opcional)
statusstringStatus do pedido de resgate (ex: confirmed)
quotation_datestringData da cotização do resgate
payment_datestringData do pagamento do resgate
amountfloatValor resgatado
redeem_allbooleantrue quando o pedido é de resgate total; omitido nos demais
cash_expectationJSONExpectativa de caixa do resgate; presente quando criada
issuance_serieJSONObjeto de Issuance Serie
fund_classJSONObjeto de Fund Class

Issuance Serie​

CampoTipoDescrição
issuance_serie_keystringChave única da série de emissão
namestringNome da série de emissão
subclass_namestringNome da subclasse (ex: SUBORDINADA)
serieintNúmero da série
quota_calculation_methodstringMétodo de cálculo da cota (ex: quota_value)
internal_codestringCódigo interno da série
fund_class_namestringNome da classe do fundo associado à série
fund_class_short_namestringNome curto da classe do fundo
fund_class_document_numberstringCNPJ da classe do fundo
minimum_share_capitalfloatValor mínimo para aplicação
investment_categorystringCategoria do investimento (ex: multi_market)
payment_typestringTipo de pagamento (ex: transfer)
account_dataJSONObjeto de Account Data
last_updated_datestringÚltima data de atualização (YYYY-MM-DD)
administratorJSONObjeto de Administrator
operation_periodsJSONObjeto de Operation Periods
isin_codestringCódigo ISIN da série

Administrator​

CampoTipoDescrição
administrator_keystringChave única do administrador
namestringNome do administrador
document_numberstringCNPJ do administrador

Operation Periods​

CampoTipoDescrição
redemption_requestJSONObjeto de períodos de Cotização e Pagamento para resgates
amortization_requestJSONObjeto de períodos de Cotização e Pagamento amortizações
financial_applicationJSONObjeto de períodos de Cotização e Pagamento aplicações

Quotation and Payment​

CampoTipoDescrição
daysintQuantidade de dias
typestringTipo de contagem (ex: fixed, until)
calendar_basestringBase de calendário (ex: workdays, calendar_365)

Account Data​

CampoTipoDescrição
account_digitstringDígito da conta bancária
account_branchstringNúmero da agência bancária
account_numberstringNúmero da conta bancária
financial_institution_codestringCódigo da instituição financeira
financial_institution_ispbstringISPB da instituição financeira (Sistema de Pagamentos Brasileiro)

Fund Class​

CampoTipoDescrição
fund_class_keystringChave única da classe de fundo
namestringNome completo da classe de fundo
short_namestringNome curto da classe de fundo
document_numberstringCNPJ da classe de fundo
accounting_datestringData contábil mais recente
distributorJSONObjeto de Distributor
managerJSONObjeto de Manager

Distributor​

CampoTipoDescrição
namestringNome do distribuidor
distributor_keystringChave única do distribuidor
document_numberstringCNPJ do distribuidor

Manager​

CampoTipoDescrição
manager_keystringChave única do gestor
manager_namestringNome do gestor da classe de fundo
document_numberstringCNPJ do gestor

Erros​

StatusCódigoQuando acontece
400TFQ000218quotation_date_from posterior a quotation_date_to.
403TFQ000054A classe de fundo não pertence à sua gestora.
404TFQ000005Classe de fundo não encontrada.

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