Pular para o conteúdo principal

Consulta paginada de pedidos de resgate por 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âmetroTipoObrigatoriedadeDescrição
pageintegeropcionalNúmero da página (começa em 0)
limitintegeropcionalRegistros por página. Padrão: 20. Máximo: 500.
statusarray de stringsopcionalUm ou mais valores de status do pedido (veja Status do pedido de resgate). Repita o parâmetro ou use o formato aceito pela plataforma para listas.
quotation_datestringopcionalFiltra pela data de cotização no formato YYYY-MM-DD.
Exemplo de chamada
GET /quota/investor/{investor_key}/redemption_requests?page=0&limit=20&status=quoted&quotation_date=2024-06-15

Response

STATUS
200
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": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"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

CampoTipoDescrição
dataarrayPedidos de resgate.
pageintegerPágina atual.
limitintegerTamanho da página.
is_last_pagebooleanÚltima página da consulta.

Campos principais de cada pedido em data

CampoTipoDescrição
redemption_request_keystringIdentificador único do pedido (UUID).
redemption_request_typestringTipo do pedido — veja Tipos de pedido.
statusstringStatus atual — veja Status do pedido.
quotation_datestringData de cotização (YYYY-MM-DD).
payment_datestringData prevista/realizada de pagamento (YYYY-MM-DD).
request_datetimestringMomento da solicitação (ISO 8601 com sufixo Z quando aplicável).
processed_valuenumberValor processado (quando aplicável).
ir_value / iof_valuenumberRetenções quando aplicáveis.
redemption_request_dataobjectPayload específico do tipo de resgate (valores solicitados, cotas, etc.).
issuance_serieobjectSérie de emissão vinculada.
investorobjectDados do investidor e distribuidora.
status_eventsarrayHistórico de mudanças de status.
cancellation_dataobjectPresente quando o pedido foi cancelado (omitido quando null).

Tipos de pedido de resgate

ValorDescrição
gross_redemption_valueResgate por valor bruto.
number_of_quotasResgate por quantidade de cotas.
remaining_application_valueResgate do valor remanescente da aplicação.
net_value_redemptionResgate por valor líquido.

Status do pedido de resgate

StatusDescrição resumida
createdCriado.
pending_manager_approvalAguardando aprovação do gestor.
pending_quoteAguardando cotização.
processing_quotationCotização em processamento.
pending_quotation_date_inputAguardando informação de data de cotização.
quotedCotizado.
canceledCancelado.
reprocessedReprocessado.

Possíveis erros

STATUS
404
Status informado inválido

Algum valor em status não corresponde a um enumerador válido de RedemptionRequestStatus.

{
"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"
}