Aplicação em Renda Fixa
Este guia tem o objetivo de detalhar o processo de criação de uma aplicação em renda fixa para o cliente e descrever todos os endpoints para acompanhar a evolução da aplicação.
📈 Criando a Aplicação em Renda Fixa
Para criar a aplicação, utilize o endpoint Aplicação em Renda Fixa. Nele, devem ser fornecidas as seguintes informações:
🆔 user_virtual_account: Campo indicando a subconta do cliente;
🎫 bond: Campo informando o ID do título de renda fixa. Os títulos que a conta do cliente tem acesso podem ser consultados em Lista de Títulos. Para um maior detalhamento do título de renda fixa desejado, basta realizar uma consulta em Detalhe do Título;
📝 client_has_accepted_bond_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;
💸 quantity: Valor financeiro a ser investido. Os limites para aplicação são encontrados em Detalhes do Título e são dados pelos campos "minimum_investment_quantity" e "maximum_investment_quantity";
📅 schedueld_to: Data de agendamento da aplicação. Para encontrar a data limite para o título, basta consultar em Detalhes do Título. A data limite para aplicação é dada pelo campo "application_time_limit". É preciso ficar atento também para o horário limite para criação da aplicação, que é dado pelo campo "application_datetime_limit". Após o horário limite, a data de agendamento deve ser o próximo dia útil.
🔤 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 renda fixa. Campo opcional.
⏳ Ciclo de Vida da Aplicação
Status existentes:
scheduled(Agendado)requested(Solicitado)processed(Processado)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) |
(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;
- 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 até o horário de corte a operação ainda estiver no status scheduled (Agendado), a operação é alterada para o status canceled (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). - Estiver dentro do horário de corte.
Mudança de Status ExcepcionalA mudança de status de
processed(Processado) paracanceled(Cancelado) só ocorre excepcionalmente e também é realizada internamente.
✔ Consultando a Aplicação Criada
A aplicação criada pode ser consultada em Detalhes da Aplicação.
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 renda fixa 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
