Skip to main content

Fund Class Redemption Request Query

Warning

This feature is only available for integrations that perform the Manager role.

Request​

ENDPOINT
/trade_fund_quota/fund_class/FUND_CLASS_KEY/redemption_requests
METHOD
GET

Query Params​

ParameterTypeDescription
quotation_datedateRedemption quotation date
redemption_request_statusstringFilter redemptions by a specific status
not_redemption_request_statusstringExclude redemptions with a specific status
document_numberstringCNPJ of the invested fund class

Response​

STATUS
200
Case 01: Return with one redemption
{
  "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"
                        }
                    }
                },
        "issuance_serie_data": {
          "name": "Issuance Serie Name",
          "serie": 1,
          "payment_type": "automatic_debit",
          "remuneration": "residual",
          "internal_code": "Internal Code",
          "subclass_name": "SUBORDINADA",
          "fund_class_name": "Fund Class Name",
          "issuance_serie_key": "UUID",
          "tax_classification": "long_term",
          "investment_category": "fixed_income",
          "fund_class_short_name": "Fund Class Short Name",
          "minimum_share_capital": 0.00,
          "quota_calculation_method": "quota_value",
          "financial_institution_code": "329",
          "fund_class_document_number": "00.000.000/0000-00",
          "administrator_document_number": "00.000.000/0000-00"
        }
      },
      "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​

FieldTypeDescription
dataarrayList of Redemption Request objects
limitintLimit of objects retrieved per page
pageintRetrieved page number
is_last_pagebooleanInformation indicating if the retrieved page is the last one

Redemption Request​

FieldTypeDescription
redemption_request_keystringUnique key for the redemption request
external_redemption_request_keystringExternal control key (optional)
statusstringRedemption status (e.g., confirmed)
quotation_datestringRedemption quotation date
payment_datestringRedemption payment date
amountfloatRedeemed amount
issuance_serieJSONIssuance Serie object
fund_classJSONFund Class object

Issuance Serie​

FieldTypeDescription
issuance_serie_keystringUnique key for the issuance series
namestringName of the issuance series
subclass_namestringSubclass name (e.g., SUBORDINADA)
serieintSeries number
quota_calculation_methodstringQuota calculation method (e.g., quota_value)
internal_codestringSeries internal code
fund_class_namestringName of the fund class associated with the series
fund_class_short_namestringShort name of the fund class
fund_class_document_numberstringCNPJ of the fund class
minimum_share_capitalfloatMinimum value for investment
investment_categorystringInvestment category (e.g., multi_market)
payment_typestringPayment type (e.g., transfer)
account_dataJSONAccount Data object
last_updated_datestringLast update date (YYYY-MM-DD)
administratorJSONAdministrator object
operation_periodsJSONOperation Periods object
isin_codestringISIN code of the series

Administrator​

FieldTypeDescription
administrator_keystringUnique administrator key
namestringAdministrator name
document_numberstringAdministrator CNPJ

Operation Periods​

FieldTypeDescription
redemption_requestJSONQuotation and Payment periods object for redemptions
amortization_requestJSONQuotation and Payment periods object for amortizations
financial_applicationJSONQuotation and Payment periods object for applications

Quotation and Payment​

FieldTypeDescription
daysintNumber of days
typestringCount type (e.g., fixed, until)
calendar_basestringCalendar base (e.g., workdays, calendar_365)

Account Data​

FieldTypeDescription
account_digitstringBank account digit
account_branchstringBank branch number
account_numberstringBank account number
financial_institution_codestringFinancial institution code
financial_institution_ispbstringFinancial institution ISPB (Brazilian Payment System)

Fund Class​

FieldTypeDescription
fund_class_keystringUnique fund class key
namestringFull name of the fund class
short_namestringShort name of the fund class
document_numberstringCNPJ of the fund class
accounting_datestringMost recent accounting date
distributorJSONDistributor object
managerJSONManager object

Distributor​

FieldTypeDescription
namestringDistributor name
distributor_keystringUnique distributor key
document_numberstringDistributor CNPJ

Manager​

FieldTypeDescription
manager_keystringUnique manager key
manager_namestringFund class manager name
document_numberstringManager CNPJ