Criar Pedido de Resgate
Atenção
Este recurso está disponível apenas para integrações que exercem o papel de Gestor.
Request
ENDPOINT
/trade_fund_quota/fund_class/FUND_CLASS_KEY/redemption_requestMÉTODO
POSTSTATUS
201Request Body
{
"issuance_serie_key": "UUID",
"external_id": "UUID",
"amount": 0.00,
"source_account_key": "UUID",
"redeem_all": false
}
Atenção.
Sempre que a operação for em uma série que o "payment_type" é "automatic_debit" (normalmente fundos de zeragem) é preciso enviar o source_account_key.
Esta operação não resultará em um resgate de fato, apenas na criação das expectativas e transferência para a conta de sua titularidade para que seja efetuado a operação na sequência.
Você pode recuperar essa chave através do endpoint: Recuperando Informações da Conta
Onde o source_account_key é a account_key da instituição onde você deseja realizar o resgate.
Caso contrário não envie este campo.
Body params
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
issuance_serie_key | string | Chave única da Série de Emissão | Sim |
external_id | string | Identificador externo único do pedido de resgate | Sim |
amount | float | Valor bruto do resgate (ignorado se redeem_all for true) | Não |
source_account_key | string | Chave da conta bancária de origem do fundo classe | Não |
redeem_all | boolean | Indica se o resgate deve ser total | Não |
Response
Response Body
{
"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"
}
}
}
Aprovar um Pedido de Resgate
Request
ENDPOINT
/trade_fund_quota/fund_class/FUND_CLASS_KEY/redemption_request/REDEMPTION_REQUEST_KEYMÉTODO
PUTSTATUS
202Request Body
{
"status": "pending_external_approval"
}
Body params
| Campo | Tipo | Descrição |
|---|---|---|
status | string | Novo status do pedido de resgate. Veja abaixo os valores permitidos. |
Response
Response Body
{
"redemption_request_key": "UUID",
"status": "pending_external_approval",
"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"
}
}
}
Cancelar um Pedido de Resgate
Request
ENDPOINT
/trade_fund_quota/fund_class/FUND_CLASS_KEY/redemption_request/REDEMPTION_REQUEST_KEY/cancelMÉTODO
PUTSTATUS
202Atenção.
Você poderá cancelar um pedido de resgate caso ele esteja em algum destes status:
- pending_manager_approval
- pending_distributor_approval
Caso contrário você vai receber um erro com o seguinte código: TFQ000078
Response
Response Body
{
"redemption_request_key": "UUID",
"status": "canceled",
"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"
}
}
}