Pular para o conteúdo principal

Criar Aplicação Financeira


Atenção

Este recurso está disponível apenas para integrações que exercem o papel de Gestor.

Request

ENDPOINT
/trade_fund/fund_class/FUND_CLASS_KEY/financial_application
MÉTODO
POST
STATUS
201
Request Body
{
"issuance_serie_key": "UUID",
"source_account_key": "UUID",
"amount": 0.00,
"quotation_date": "YYYY-MM-DD",
"payment_method": "string"
}
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 uma aplicação 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 a aplicação.

Caso contrário não envie este campo.

Body params

CampoTipoDescriçãoObrigatório
issuance_serie_keystringChave única de identificação da série de emissãoSim
amountfloatValor da aplicaçãoSim
source_account_keystringChave da conta bancária de destino dos recursosNão
quotation_datestringData da cotização no formato YYYY-MM-DDNão
payment_methodstringMétodo de pagamento (wire_transfer, pix)Não

Response

Response Body
{
"amount": 0.00,
"financial_application_key": "UUID",
"asset_key": "UUID",
"quotation_date": "YYYY-MM-DD",
"status": "confirmed",
"issuance_serie": {
"issuance_serie_key": "UUID",
"name": "Invested Issuance Serie Name",
"subclass_name": "Invested Sub Class Name",
"serie": 1,
"quota_calculation_method": "quota_value",
"internal_code": "Internal Code",
"fund_class_name": "Invested Fund Class Name",
"fund_class_short_name": "Invested Fund Class short name",
"fund_class_document_number": "00.000.000/0000-00",
"minimum_share_capital": 0.0,
"investment_category": "multi_market",
"payment_type": "transfer",
"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"
}
}
},
"isin_code": "BR000000000"
},
"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 Aplicação Financeira


Request

ENDPOINT
/trade_fund/fund_class/FUND_CLASS_KEY/financial_application/FINANCIAL_APPLICATION_KEY
MÉTODO
PUT
STATUS
202
Request Body
{
"status": "pending_payment"
}

Body params

CampoTipoDescrição
statusstringNovo status do pedido de resgate. Veja abaixo os valores permitidos.

Response

Response Body
{
"amount": 0.00,
"financial_application_key": "UUID",
"asset_key": "UUID",
"quotation_date": "YYYY-MM-DD",
"status": "confirmed",
"issuance_serie": {
"issuance_serie_key": "UUID",
"name": "Invested Issuance Serie Name",
"subclass_name": "Invested Sub Class Name",
"serie": 1,
"quota_calculation_method": "quota_value",
"internal_code": "Internal Code",
"fund_class_name": "Invested Fund Class Name",
"fund_class_short_name": "Invested Fund Class short name",
"fund_class_document_number": "00.000.000/0000-00",
"minimum_share_capital": 0.0,
"investment_category": "multi_market",
"payment_type": "transfer",
"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"
}
}
},
"isin_code": "BR000000000"
},
"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 Aplicação Financeira


Request

ENDPOINT
/trade_fund/fund_class/FUND_CLASS_KEY/financial_application/FINANCIAL_APPLICATION_KEY/cancel
MÉTODO
PUT
STATUS
202
Atenção.

Você poderá cancelar um pedido de aplicação 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: TFQ000073

Response

Response Body
{
"amount": 0.00,
"financial_application_key": "UUID",
"asset_key": "UUID",
"quotation_date": "YYYY-MM-DD",
"status": "confirmed",
"issuance_serie": {
"issuance_serie_key": "UUID",
"name": "Invested Issuance Serie Name",
"subclass_name": "Invested Sub Class Name",
"serie": 1,
"quota_calculation_method": "quota_value",
"internal_code": "Internal Code",
"fund_class_name": "Invested Fund Class Name",
"fund_class_short_name": "Invested Fund Class short name",
"fund_class_document_number": "00.000.000/0000-00",
"minimum_share_capital": 0.0,
"investment_category": "multi_market",
"payment_type": "transfer",
"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"
}
}
},
"isin_code": "BR000000000"
},
"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"
}
}
}