Create Redemption Request
Request
ENDPOINT
/quota_distributor/investor/INVESTOR_KEY/redemption_requestMETHOD
POSTSTATUS
201Request Body
{
"issuance_serie_key": "UUID",
"redemption_request_type": "gross_redemption_value" | "number_of_quotas" | "remaining_application_value" | "net_value_redemption",
"gross_redemption_value":0.00,
"net_value": 0.00,
"remaining_application_value":0.00,
"number_of_quotas":0.00000000,
"bank_account_key": "UUID",
"quotation_date": "yyyy-mm-dd"
}
warning
-
The redemption_request_type field defines whether the gross_redemption_value, remaining_application_value and number_of_quotas fields should be passed or not.
- If gross_redemption_value, the gross_redemption_value field is required.
- If remaining_application_value, the remaining_application_value field is required.
- If number_of_quotas, the number_of_quotas field is required.
- If net_value_redenotuib, the net_value field is required.
-
The bank_account_key field should be used for redemption settlement in a specific account of the investor. If no specific account is informed, the investor's primary account will be used
Body params
| Field | Type | Description | Required |
|---|---|---|---|
issuance_serie_key | string | Unique identifier key for the Issuance Series | Yes |
redemption_request_type | string | Enumerator for Redemption Request Types | Yes |
gross_redemption_value | float | Gross redemption value, without deducting IR and IOF | No |
net_value | float | Net redemption value, already discounting IR and IOF | No |
remaining_application_value | float | Remaining application value | No |
number_of_quotas | float | Financial application value | No |
bank_account_key | string | Unique identifier key for the investor's bank account | No |
quotation_date | string | Redemption quotation date | No |
Redemption Request Types
| 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 |
Response
Response Body
{
"redemption_request_key": "UUID"
}