Consulta paginada de pedidos de resgate por classe de fundo

Lista pedidos de resgate vinculados a uma classe de fundo (fund_class_key), com paginação. Permite filtrar por status, data de cotização e documento do investidor.

Request

ENDPOINT

/quota/fund_class/{fund_class_key}/redemption_requests

MÉTODO

GET

Query 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.
quotation_date	string	opcional	Filtra pela data de cotização (YYYY-MM-DD).
investor_document_number	string	opcional	Filtra pelo documento do investidor (com pontuação).
request_from_datetime	string (date-time)	opcional	Retorna apenas os pedidos com data/hora de solicitação maior ou igual ao valor informado. Formato ISO 8601 com Z (YYYY-MM-DDTHH:MM:SSZ).
request_to_datetime	string (date-time)	opcional	Retorna apenas os pedidos com data/hora de solicitação menor ou igual ao valor informado. Formato ISO 8601 com Z (YYYY-MM-DDTHH:MM:SSZ).

Exemplo de chamada

GET /quota/fund_class/{fund_class_key}/redemption_requests?page=0&limit=50&investor_document_number=12.345.678/0001-90

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": "3571e292-3a83-4011-904d-20ee963022ef",
          "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

Campo	Tipo	Descrição
data	array	Pedidos de resgate.
page	integer	Página atual.
limit	integer	Tamanho da página.
is_last_page	boolean	Última página da consulta.

Campos principais de cada pedido em data

Campo	Tipo	Descrição
redemption_request_key	string	Identificador único do pedido (UUID).
redemption_request_type	string	Tipo do pedido — veja Tipos de pedido.
status	string	Status atual — veja Status do pedido.
quotation_date	string	Data de cotização (YYYY-MM-DD).
payment_date	string	Data prevista/realizada de pagamento (YYYY-MM-DD).
request_datetime	string	Momento da solicitação (ISO 8601 com sufixo Z quando aplicável).
processed_value	number	Valor processado (quando aplicável).
ir_value / iof_value	number	Retenções quando aplicáveis.
redemption_request_data	object	Payload específico do tipo de resgate (valores solicitados, cotas, etc.).
issuance_serie	object	Série de emissão vinculada.
investor	object	Dados do investidor e distribuidora.
status_events	array	Histórico de mudanças de status.

Tipos de pedido de resgate

Valor	Descrição
gross_redemption_value	Resgate por valor bruto.
number_of_quotas	Resgate por quantidade de cotas.
remaining_application_value	Resgate do valor remanescente da aplicação.
net_value_redemption	Resgate por valor líquido.

Status do pedido de resgate

Status	Descrição resumida
created	Criado.
pending_manager_approval	Aguardando aprovação do gestor.
pending_quote	Aguardando cotização.
processing_quotation	Cotização em processamento.
pending_quotation_date_input	Aguardando informação de data de cotização.
quoted	Cotizado.
canceled	Cancelado.
reprocessed	Reprocessado.

Objetos da resposta

Issuance Serie (issuance_serie)

Campo	Tipo	Descrição
issuance_serie_key	string	Chave única de identificação da série de emissão
name	string	Nome da série de emissão
serie	int	Número da série
original_quota_value	float	Valor da cota original
current_quota_value	float	Valor atual da cota
current_number_of_quotas	float	Quantidade atual de cotas
current_net_worth	float	Patrimônio líquido atual
current_principal_value	float	Valor de principal atual
performance_fee_current_value	float	Valor atual de taxa de performance
minimum_share_capital	float	Valor mínimo para aplicação
remuneration_type	string	Tipo de remuneração (ex.: yield_curve)
interest_rate_type	string	Tipo de taxa (post_fixed / pre_fixed)
post_fixed / pre_fixed	object	Dados de remuneração (calendar_base, indexer, rate, lag)
status	string	Status da série de emissão (ex.: active)
internal_code	string	Código interno da série
isin_code	string	Código ISIN
processing_method	string	Método de processamento
operation_period_configuration	object	Configuração de períodos de operação
external_id	string	Identificador externo
sub_class	object	Objeto Sub Class

Sub Class (sub_class)

Campo	Tipo	Descrição
name	string	Nome da subclasse
sub_class_key	string	Chave única de identificação da subclasse
subordination_level	int	Nível de subordinação da subclasse
fund_class	object	Objeto Fund Class

Fund Class (fund_class)

Campo	Tipo	Descrição
name	string	Nome da classe de fundo
short_name	string	Nome curto da classe de fundo
fund_class_key	string	Chave única de identificação da classe de fundo
document_number	string	CNPJ da classe de fundo
accounting_date	string	Data contábil da classe de fundo
sub_type	string	Subtipo (ex.: fidc)
tax_classification_id	string	Classificação tributária (ex.: long_term)
condominum_type_id	string	Tipo de condomínio (ex.: open_ended)
investment_category_id	string	Categoria de investimento (ex.: fidc)
prevent_payment	boolean	Indica se os pagamentos estão bloqueados
integralization_account_key	string	Chave da conta de integralização
manager	object	Objeto Manager

Manager (manager)

Campo	Tipo	Descrição
manager_key	string	Chave única de identificação do gestor
document_number	string	CNPJ do gestor
manager_name	string	Nome do gestor

Investor (investor)

Campo	Tipo	Descrição
investor_key	string	Chave única de identificação do investidor
name	string	Nome do investidor
document_number	string	CPF/CNPJ do investidor
person_type	string	Tipo de pessoa (natural_person / legal_person)
external_id	string	Identificador externo do investidor
external_distribution_key	string	Chave de distribuição externa
distributor	object	Objeto Distributor

Distributor (distributor)

Campo	Tipo	Descrição
distributor_key	string	Chave única de identificação do distribuidor
name	string	Nome do distribuidor
document_number	string	CNPJ do distribuidor
account_data	object	Objeto Account Data

Account Data (account_data)

Campo	Tipo	Descrição
owner	object	Titular da conta (name, document_number)
account_digit	string	Dígito da conta bancária
account_branch	string	N° da agência da conta bancária
account_number	string	N° da conta bancária
financial_institution_code	string	Código da instituição financeira
financial_institution_ispb	string	Identificador no Sistema de Pagamento Brasileiro (ISPB) da instituição financeira

Possíveis erros

STATUS

404

Classe de fundo não encontrada

{
  "title": " Fund Class not Found",
  "description": "Fund Class with key {fund_class_key} was not found.",
  "translation": "A classe com chave {fund_class_key} não foi encontrado.",
  "code": "QTA000002"
}