Skip to main content

Paginated Query for Redemption Requests

Requests​

Request by investor: this endpoint will return all redemptions from an investor
ENDPOINT
/quota_distributor/investor/INVESTOR_KEY/redemption_requests
METHOD
GET
STATUS
200
Request by fund: this endpoint will return all redemptions from a fund
ENDPOINT
/quota_distributor/fund_class/FUND_CLASS_KEY/redemption_requests
METHOD
GET
STATUS
200

Query Params​

ParameterDescription
quotation_dateQuotation date for redemptions
statusList of desired Redemption Request Status

Responses​

Case 01: Successful query
{
    "data": [
        {
            "redemption_request_key": "UUID",
            "redemption_request_type": "gross_redemption_value" | "number_of_quotas" | "remaining_application_value",
            "status": "pending_quote" | "processing_quote" | "canceled" | "quoted",
            "quotation_date": "yyyy-mm-dd",
            "payment_date":"yyyy-mm-dd",
            "request_datetime":"yyyy-mm-dd HH:MM:SS:MS",
            "processed_value": 0.00,
            "investor_position": {
                "investor": {
                    "investor_key": "UUID",
                    "document_number": "999.999.999-99" | "99.999.999/9999-99",
                    "name": "",
                    "person_type": "natural_person" | "legal_person",
                    "account_data": {
                        "owner": {
                            "name": "",
                            "document_number": "99.999.999/9999-99"
                        },
                        "account_digit": "0",
                        "account_branch": "0000",
                        "account_number": "00000",
                        "financial_institution_code": "000",
                        "financial_institution_ispb": "00000000"
                    },
                    "distributor": {
                        "distributor_key": "UUID",
                        "document_number": "99.999.999/9999-99",
                        "name": "",
                        "account_data": {
                            "owner": {
                                "name": "",
                                "document_number": "99.999.999/9999-99"
                            },
                            "account_digit": "0",
                            "account_branch": "0000",
                            "account_number": "00000",
                            "financial_institution_code": "000",
                            "financial_institution_ispb": "00000000"
                        },
                    }
                },
                "total_net_worth": 0.00,
                "total_number_of_quotas": 0.00000000,
                "investor_position_key": "UUID",
                "issuance_serie":{
                    "name":"1",
                    "cetip_code":"0000000SN1",
                    "start_date":"YYYY-MM-DD",
                    "maturity_date":"YYYY-MM-DD",
                    "original_quota_value":0.00000000000000,
                    "remuneration_type":"yield_curve",
                    "interest_rate_type":"post_fixed",
                    "pre_fixed":{
                    "calendar_base":"workdays / calendar_360 / calendar_365",
                    "monthly_rate":0.00000000000000
                    },
                    "post_fixed":{
                    "calendar_base":"workdays / calendar_360 / calendar_365",
                    "indexer":"di / ipca",
                    "rate":1,
                    "lag":{
                        "reference":"daily / monthly",
                        "amount":1
                    }
                    },
                    "investment_category":"fidc / multi_market",
                    "condominum_type":"open_ended / close_ended",
                    "tax_classification":"short_term / long_term",
                    "investment_restriction_type":"just_professional",
                    "issuance_serie_key":"UUID",
                    "minimum_share_capital":0.0,
                    "accounting_date":"YYYY-MM-DD",
                    "sub_class":{
                    "name":"COTA SÊNIOR",
                    "sub_class_key":"UUID",
                    "subordination_level":1,
                    "fund_class":{
                        "name":"SAMPLE FUND CLASS NAME",
                        "fund_class_key":"UUID",
                        "document_number":"00.000.000/0000-00"
                    }
                    }
                }
            },
            "status_events": [
                {
                    "event_datetime": "yyyy-mm-dd HH:MM:SS:ms",
                    "status": "pending_quote" | "processing_quote" | "canceled" | "quoted",
                }
            ],
        }
    ],
    "limit": 50,
    "page": 0,
    "is_last_page": true
}

Page​

FieldTypeDescription
dataarrayList of Redemption Request objects
limitintLimit of objects retrieved per page
pageintNumber of the retrieved page
is_last_pagebooleanInformation indicating whether the retrieved page is the last one

Redemption Request​

FieldTypeDescriptionCharacters
redemption_request_keystringUnique identification key for the redemption request36
redemption_request_typestringRedemption Request Type enumerator-
statusstringRedemption Request Status enumerator-
quotation_datestringQuotation date-
payment_datestringPayment date-
request_datetimestringRedemption request creation date-
processed_valuefloatProcessed redemption value-
investor_positionJSONInvestor Position object-
status_eventsarrayList of Status Event objects-

Redemption Request Status​

EnumeratorDescription
pending_quotePending payment
processing_quotePending quotation
quotedQuoted
canceledFully amortized

Redemption Request Type​

EnumeratorDescription
gross_redemption_valueRedemption by gross value
number_of_quotasRedemption by number of quotas
remaining_application_valueRedemption by remaining value

Investor Position​

FieldTypeDescription
investorJSONInvestor object
total_net_worthfloatNet worth of the investor's position
total_number_of_quotasfloatNumber of quotas in the investor's position
issuance_serieJSONIssuance Serie object
investor_position_keyJSONUnique identification key for the investor's position

Investor​

FieldTypeDescriptionCharacters
namestringInvestor nameup to 255
investor_keystringUnique identification key for the investor36
document_numberstringInvestor's CPF/CNPJ14 or 18
person_typestringNatural Person / Legal Person / Fund Classup to 50
distributorJSONDistributor object-
account_dataJSONAccount Data object-

Distributor​

FieldTypeDescriptionCharacters
namestringDistributor nameup to 255
distributor_keystringUnique identification key for the distributor-
document_numberstringDistributor's CPF/CNPJ14 or 18
account_dataJSONAccount Data object-

Account Data​

FieldTypeDescription
account_digitstringBank account digit
account_branchstringBank account branch number
account_numberstringBank account number
financial_institution_codestringFinancial institution code
financial_institution_ispbstringBrazilian Payment System identifier for the financial institution

Issuance Serie​

FieldTypeDescriptionCharacters
namestringIssuance series nameup to 255
issuance_serie_keystringUnique identification key for the issuance series36
cetip_codestringIssuance series code as an asset in CETIP10
start_datestringIssuance series start date10
maturity_datestringIssuance series maturity date10
original_quota_valuefloatOriginal quota value-
remuneration_typestringYield curve / Residualup to 50
investment_categorystringFIDC / Multi-marketup to 50
condominum_typestringOpen-ended / Closed-endedup to 50
tax_classificationstringShort term / Long termup to 50
investment_restriction_typestringNo restriction / Qualified / Professionalup to 50
minimum_share_capitalfloatMinimum value for investment-
accounting_datestringAccounting date for the issuance series10
sub_classJSONSub Class object-

Sub Class​

FieldTypeDescriptionCharacters
namestringSub class nameup to 255
sub_class_keystringUnique identification key for the sub class36
subordination_levelintSub class subordination level-
fund_classJSONFund Class object-

Fund Class​

FieldTypeDescriptionCharacters
namestringFund class nameup to 255
fund_class_keystringUnique identification key for the fund class36
document_numberstringFund class CNPJ-