Paginated query of redemption requests by investor

Returns the redemption requests of an investor identified by investor_key, with pagination and optional filters by status and quotation date. The list is ordered by fund, subclass, series and quotation date (most recent first).

Request

ENDPOINT

/quota/investor/{investor_key}/redemption_requests

METHOD

GET

Query params

Parameter	Type	Required	Description
`page`	integer	optional	Page number (starts at `0`)
`limit`	integer	optional	Records per page. Default: `20`. Maximum: `500`.
`status`	array of strings	optional	One or more status values of the request (see Redemption request status). Repeat the parameter or use the format accepted by the platform for lists.
`quotation_date`	string	optional	Filters by the quotation date in the `YYYY-MM-DD` format.
`fund_class_document_number`	string	optional	Filters by the document (CNPJ) of the fund class.
`request_from_datetime`	string (date-time)	optional	Returns only the requests whose request date/time is greater than or equal to the provided value. ISO 8601 format with Z (`YYYY-MM-DDTHH:MM:SSZ`).
`request_to_datetime`	string (date-time)	optional	Returns only the requests whose request date/time is less than or equal to the provided value. ISO 8601 format with Z (`YYYY-MM-DDTHH:MM:SSZ`).

Example call
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",
        "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
}

Response attributes

Field	Type	Description
`data`	array	Redemption requests.
`page`	integer	Current page.
`limit`	integer	Page size.
`is_last_page`	boolean	Last page of the query.

Main fields of each request in `data`

Field	Type	Description
`redemption_request_key`	string	Unique identifier of the request (UUID).
`redemption_request_type`	string	Type of the request — see Request types.
`status`	string	Current status — see Request status.
`quotation_date`	string	Quotation date (`YYYY-MM-DD`).
`payment_date`	string	Scheduled/actual payment date (`YYYY-MM-DD`).
`request_datetime`	string	Moment of the request (ISO 8601 with the Z suffix when applicable).
`processed_value`	number	Processed value (when applicable).
`ir_value` / `iof_value`	number	Withholdings when applicable.
`redemption_request_data`	object	Payload specific to the redemption type (requested values, quotas, etc.).
`issuance_serie`	object	Linked issuance series.
`investor`	object	Data of the investor and of the distributor.
`status_events`	array	History of the status changes.
`cancellation_data`	object	Present when the request was canceled (omitted when `null`).

Redemption request types

Value	Description
`gross_redemption_value`	Redemption by gross value.
`number_of_quotas`	Redemption by number of quotas.
`remaining_application_value`	Redemption of the remaining value of the application.
`net_value_redemption`	Redemption by net value.

Redemption request status

Status	Short description
`created`	Created.
`pending_manager_approval`	Awaiting the manager's approval.
`pending_quote`	Awaiting quotation.
`processing_quotation`	Quotation in processing.
`pending_quotation_date_input`	Awaiting the quotation date to be provided.
`quoted`	Quoted.
`canceled`	Canceled.
`reprocessed`	Reprocessed.

Response objects

Issuance Serie (`issuance_serie`)

Field	Type	Description
`issuance_serie_key`	string	Unique identification key of the issuance series
`name`	string	Name of the issuance series
`serie`	int	Number of the series
`original_quota_value`	float	Original quota value
`current_quota_value`	float	Current quota value
`current_number_of_quotas`	float	Current number of quotas
`current_net_worth`	float	Current net worth
`current_principal_value`	float	Current principal value
`performance_fee_current_value`	float	Current value of the performance fee
`minimum_share_capital`	float	Minimum value for an application
`remuneration_type`	string	Remuneration type (e.g. `yield_curve`)
`interest_rate_type`	string	Rate type (`post_fixed` / `pre_fixed`)
`post_fixed` / `pre_fixed`	object	Remuneration data (`calendar_base`, `indexer`, `rate`, `lag`)
`status`	string	Status of the issuance series (e.g. `active`)
`internal_code`	string	Internal code of the series
`isin_code`	string	ISIN code
`processing_method`	string	Processing method
`operation_period_configuration`	object	Configuration of the operation periods
`external_id`	string	External identifier
`sub_class`	object	Sub Class object

Sub Class (`sub_class`)

Field	Type	Description
`name`	string	Name of the subclass
`sub_class_key`	string	Unique identification key of the subclass
`subordination_level`	int	Subordination level of the subclass
`fund_class`	object	Fund Class object

Fund Class (`fund_class`)

Field	Type	Description
`name`	string	Name of the fund class
`short_name`	string	Short name of the fund class
`fund_class_key`	string	Unique identification key of the fund class
`document_number`	string	CNPJ of the fund class
`accounting_date`	string	Accounting date of the fund class
`sub_type`	string	Subtype (e.g. `fidc`)
`tax_classification_id`	string	Tax classification (e.g. `long_term`)
`condominum_type_id`	string	Condominium type (e.g. `open_ended`)
`investment_category_id`	string	Investment category (e.g. `fidc`)
`prevent_payment`	boolean	Indicates whether payments are blocked
`integralization_account_key`	string	Key of the integralization account
`manager`	object	Manager object

Manager (`manager`)

Field	Type	Description
`manager_key`	string	Unique identification key of the manager
`document_number`	string	CNPJ of the manager
`manager_name`	string	Name of the manager

Investor (`investor`)

Field	Type	Description
`investor_key`	string	Unique identification key of the investor
`name`	string	Name of the investor
`document_number`	string	CPF/CNPJ of the investor
`person_type`	string	Person type (`natural_person` / `legal_person`)
`external_id`	string	External identifier of the investor
`external_distribution_key`	string	External distribution key
`distributor`	object	Distributor object

Distributor (`distributor`)

Field	Type	Description
`distributor_key`	string	Unique identification key of the distributor
`name`	string	Name of the distributor
`document_number`	string	CNPJ of the distributor
`account_data`	object	Account Data object

Account Data (`account_data`)

Field	Type	Description
`owner`	object	Holder of the account (`name`, `document_number`)
`account_digit`	string	Check digit of the bank account
`account_branch`	string	Branch number of the bank account
`account_number`	string	Number of the bank account
`financial_institution_code`	string	Code of the financial institution
`financial_institution_ispb`	string	Identifier in the Brazilian Payment System (ISPB) of the financial institution

Possible errors

STATUS

404

Invalid status provided

Some value in status does not correspond to a valid RedemptionRequestStatus enumerator.

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

Request​

Query params​

Response​

Response attributes​

Main fields of each request in data​

Redemption request types​

Redemption request status​

Response objects​

Issuance Serie (issuance_serie)​

Sub Class (sub_class)​

Fund Class (fund_class)​

Manager (manager)​

Investor (investor)​

Distributor (distributor)​

Account Data (account_data)​

Possible errors​