Consulta paginada de pedidos de resgate por classe de fundo
Lista pedidos de resgate de uma classe de fundo da gestora (fund_class_key), com paginação e filtros opcionais.
Disponível em
| Perfil | Host | Permissão exigida |
|---|---|---|
| Gestora | manager-api | Leitura |
URL base de cada host: Ambientes (Hosts).
Request
ENDPOINT
/quota/fund_class/{fund_class_key}/redemption_requestsMÉTODO
GETQuery params
| Parâmetro | Tipo | Obrigatoriedade | Descrição |
|---|---|---|---|
page | integer | opcional | Número da página (começa em 0). Padrão: 0. |
limit | integer | opcional | Registros por página. Padrão: 20. Máximo: 500. |
status | array de strings | opcional | Um ou mais status do pedido. Repita o parâmetro para enviar mais de um. |
quotation_date | string | opcional | Filtra pela data de cotização (YYYY-MM-DD). |
investor_name | string | opcional | Parte do nome do investidor (sem diferenciar maiúsculas). |
investor_document_number | string | opcional | Filtra pelo documento do investidor, no mesmo formato em que foi cadastrado (com pontuação). |
request_from_datetime | string (date-time) | opcional | Pedidos com data/hora de solicitação maior ou igual ao valor, no formato YYYY-MM-DDTHH:MM:SSZ (UTC). |
request_to_datetime | string (date-time) | opcional | Pedidos com data/hora de solicitação menor ou igual ao valor, no formato YYYY-MM-DDTHH:MM:SSZ (UTC). |
Exemplo de chamada
GET /quota/fund_class/{fund_class_key}/redemption_requests?page=0&limit=50&investor_document_number=969.698.790-03
Response
STATUS
200Cada item de data é o objeto Redemption Request completo, descrito em Consultar Pedido de Resgate por chave — lá estão também os tipos e os status.
Response Body (resumido)
{
"data": [
{
"redemption_request_key": "UUID",
"redemption_request_type": "number_of_quotas",
"status": "quoted",
"quotation_date": "2024-06-15",
"payment_date": "2024-06-18",
"payment_method": "regular",
"request_datetime": "2024-06-10T14:00:00Z",
"redemption_request_data": {
"number_of_quotas": 500.0
},
"processed_value": 5250.5,
"ir_value": 0.0,
"iof_value": 0.0
}
],
"limit": 20,
"page": 0,
"is_last_page": true
}
| Campo | Tipo | Descrição |
|---|---|---|
data | array | Pedidos de resgate |
limit | integer | Itens por página |
page | integer | Página retornada |
is_last_page | boolean | true quando não há mais páginas |
Um valor de status que não existe não gera erro: a consulta apenas não encontra pedidos.
Erros
| Status | Código | Quando acontece |
|---|---|---|
| 400 | QIT000001 | Data ou data/hora em formato inválido |
| 400 | QIT000004 | O fundo não é da gestora |
| 404 | QTA000002 | Classe de fundo não encontrada |
Erros de autenticação, permissão e host: veja Erros da API.