Aplicação em Fundos
Este guia tem o objetivo de detalhar o processo de criação de uma aplicação em fundos para o cliente e descrever todos os endpoints para acompanhar a evolução da aplicação.
📈 Criando a Aplicação em Fundos
Para criar a aplicação, utilize o endpoint Aplicação em Fundos.Nele, devem ser fornecidas as seguintes informações:
🆔 user_virtual_account: Campo indicando a subconta do cliente.
🎫 fund: Campo informando o ID do fundos. Os fundos que a conta do cliente tem acesso podem ser consultados em Lista de Fundos. Para mais detalhes sobre o fundo desejado, consulte Detalhe do Fundo. Informações adicionais também podem ser encontradas em Cotas do Fundo e Cotas do Benchmark.
📝 client_has_accepted_fund_investor_profile_term: Booleano indicando se o cliente aceitou o termo de investidor. Campo necessário para clientes que não preencheram o perfil de suitability. Se desejar preencher o perfil de investidor do cliente, consulte o Respondendo o Questionário;
📝 client_has_accepted_fund_terms: Booleano indicando se o cliente aceitou os termos de adesão ao fundo. Os termos específicos de cada fundo podem ser obtidos realizando uma consulta em Termos de Adesão ao Fundo;
💸 quantity: Valor financeiro a ser investido. Em Detalhes do Fundo, no campo "operability", é possível obter os limites para aplicação em fundos. Há dois tipos de limites para aplicação:
- Primeiras aplicações: "minimum_initial_application_amount" e "maximum_initial_application_amount".
- Novas aplicações: "minimum_subsequent_application_amount" e "maximum_subsequent_application_amount".
📅 schedueld_to: Data de agendamento da aplicação. Os fundos podem ter dias específicos liberados para criar a aplicação. Os dias indisponíveis do fundo podem ser obtidos em Datas Indisponíveis. É preciso ficar atento também para o horário limite para criação da aplicação, que é dado pelo campo "application_time_limit", encontrado em Detalhes do Fundo. Após o horário limite, a data de agendamento deve ser o próximo dia disponível para aplicação.
🔤 external_id: ID de identificação externo fornecido pelo parceiro, podendo ser constituído por qualquer caractere. O
external_idinformado será retornado em todos os endpoints relacionados à aplicação de fundos. Campo opcional.
Simulação da AplicaçãoPara obter uma estimativa das datas de liquidação e cotização da aplicação, é possível realizar uma simulação da aplicação em fundos, fazendo uma requisição em Simulação de Aplicação em Fundos.Este passo é recomendado para mostrar ao cliente as datas relacionadas à aplicação no fundo.
⏳ Ciclo de Vida da Aplicação
Status existentes:
scheduled(Agendado)requested(Solicitado)processed(Processado)pre_executed(Pré-executado)executed(Aguardando cotização)done(Concluído)canceled(Cancelado)
Status Iniciais:
scheduled(Agendado)
Status finais:
done(Concluído)canceled(Cancelado)
Transições de status:
Status Inicial | Status Seguinte | Pode ser cancelada? |
|---|---|---|
(Agendado) |
(Solicitado) | ✅ |
(Solicitado) |
(Processado) | ✅ |
(Processado) |
(Pré-executado) | ❌ |
(Pré-executado) |
(Aguardando cotização) | ❌ |
(Aguardando cotização) |
(Concluído) | ❌ |
Evolução do StatusAs transições de status são feitas internamente no sistema da Nikos. Toda operação nasce no status inicial:
scheduled(Agendado). No momento da aplicação é checado se a operação pode mudar pararequested(Solicitado).
Requisitos para transição:
- Cliente ter o aceite do termo do produto, caso necessário. Consultar em Termos de Adesão ao Fundo;
- Cliente ter o aceite do termo de desenquadramento, caso necessário;
- Cliente ter o aceite do termo de Investidor Qualificado, caso necessário.
Caso não atenda aos requisitos, a operação permanece em scheduled (Agendado).
Entre a aplicação e o horário de corte, uma tarefa é executada periodicamente, verificando se é possível realizar a transição de scheduled (Agendado) para requested (Solicitado).
Se ate o horário de corte a operação ainda estiver no status scheduled (Agendado), a operação é alterada para o statuscanceled (Cancelado).
O próprio cliente também pode cancelar a aplicação. Uma aplicação só pode ser cancelada se:
- Estiver nos status
scheduled(Agendado) ourequested(Solicitado). - Se estiver dentro do horário de corte.
Mudança de StatusA mudança de status de
processed(Processado) paracanceled(Cancelado) só ocorre excepcionalmente e também é realizada internamente.
CotizaçãoQuando a operação chegar ao status
done(Concluído), significa que a aplicação foi cotizada. A evolução para a cotização depende do fundo especificado na aplicação. O parâmetro chamado "application_quotation_days", o qual pode ser encontrado no campo "operability" em Detalhes do Fundo indica o número de dias para a cotização do fundo desejado.
✔ Consultando a Aplicação Criada
A aplicação criada pode ser consultada em Buscar Aplicação por ID. Também é possível consultar as aplicações em fundos de um cliente em Lista de Aplicações do Cliente
Além disso, em Aplicações em Andamento, a aplicação recém-criada será mostrada no campo da respectiva conta.
📈 O extrato de movimentação de fundos do cliente retornará a nova aplicação quando ela é concluída com sucesso, ou seja, avançando para o status done. O extrato pode ser consultado em:
Updated 6 months ago
