Query Redemption Request by Key

Returns a redemption request of an investor by key.

Available on

Profile	Host	Required permission
Manager	manager-api	Read

Base URL for each host: Environments (Hosts).

Request

ENDPOINT

/quota/investor/INVESTOR_KEY/redemption_request/REDEMPTION_REQUEST_KEY

METHOD

GET

STATUS

200

The manager only queries redemption requests of its own funds.

Responses

Case 01: Successful query

{
    "redemption_request_key": "UUID",
    "redemption_request_type": "gross_redemption_value",
    "status": "quoted",
    "quotation_date": "2025-01-15",
    "payment_date": "2025-01-16",
    "payment_method": "regular",
    "request_datetime": "2025-01-14T13:05:00Z",
    "redemption_request_data": {
        "gross_redemption_value": 1000.0
    },
    "processed_value": 1000.0,
    "ir_value": 2.78,
    "iof_value": 0.0,
    "investor": {
        "investor_key": "UUID",
        "name": "INVESTIDOR EXEMPLO",
        "person_type": "natural_person",
        "document_number": "969.698.790-03",
        "distributor": {
            "distributor_key": "UUID",
            "document_number": "11.222.333/0001-81",
            "name": "DISTRIBUIDORA EXEMPLO",
            "account_data": {}
        }
    },
    "issuance_serie": {
        "issuance_serie_key": "UUID",
        "name": "SERIE 1",
        "sub_class": {
            "name": "COTA SÊNIOR",
            "sub_class_key": "UUID",
            "subordination_level": 1,
            "fund_class": {
                "name": "FUNDO EXEMPLO",
                "fund_class_key": "UUID",
                "document_number": "11.222.333/0001-81"
            }
        }
    },
    "payments": [
        {
            "payment_key": "UUID",
            "origin_key": "UUID",
            "total_value": 997.22,
            "payment_type": "redemption.investor",
            "payment_date": "2025-01-16",
            "status": "paid"
        }
    ],
    "status_events": [
        {
            "status": "pending_quote",
            "event_datetime": "2025-01-14T13:05:00Z"
        },
        {
            "status": "quoted",
            "event_datetime": "2025-01-15T21:00:00Z"
        }
    ]
}

Redemption Request

Field	Type	Description
redemption_request_key	string	Unique key of the redemption request
redemption_request_type	string	Redemption Request Type enumerator
status	string	Redemption Request Status enumerator
quotation_date	string	Quotation date
payment_date	string	Payment date
payment_method	string	regular or b3
request_datetime	string	Date and time the request was created (UTC)
redemption_request_data	object	Values sent on creation (e.g. gross_redemption_value, net_value)
processed_value	float	Processed redemption value
ir_value	float	Redemption IR
iof_value	float	Redemption IOF
investor	object	Investor: investor_key, name, person_type, document_number and distributor
issuance_serie	object	Issuance series, with sub_class and sub_class.fund_class
payments	array	Generated payments (investor, IR, IOF): payment_key, origin_key, total_value, payment_type, payment_date, status, status_events
status_events	array	Status history: status and event_datetime (UTC)
cancellation_data	object	Cancellation data, only when the request was canceled

Redemption Request Type

Enumerator	Description
gross_redemption_value	Redemption by gross value
number_of_quotas	Redemption by number of quotas
remaining_application_value	Redemption by remaining position
net_value_redemption	Redemption by net value

Redemption Request Status

Enumerator	Description
created	Created
pending_manager_approval	Waiting for the manager's approval
pending_quote	Pending quotation
processing_quotation	Quotation in progress
pending_quotation_date_input	Waiting for the quotation date to be defined
processing_issuance_serie_impacts	Processing impacts on the series
quoted	Quoted
canceled	Canceled
reprocessed	Reprocessed

Errors

Status	Code	When it happens
400	QIT000004	The redemption request does not belong to a fund of the manager
404	QTA000036	Redemption request not found for the investor

Authentication, permission and host errors: see API Errors.