Resgate em Fundos
Este guia tem o objetivo de detalhar o processo de criação de um resgate em fundos para o cliente e descrever todos os endpoints necessários para acompanhar a evolução do resgate.
📈 Criando o Resgate em Fundos
Para criar o resgate, utilize o endpoint Resgate de 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.
💸 gross_amount: Valor bruto de resgate solicitado.
📅 schedueld_to: Data de agendamento do resgate. Os fundos podem ter dias específicos liberados para criar o resgate, que variam de acordo com o tipo do fundo. É preciso ficar atento também para o horário limite para a criação do resgate, encontrado no campo “retrieval_liquidation_days”, encontrado em Detalhes do Fundo . 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 fundos. Campo opcional.📝 anticipate: Booleano indicando se é um resgate antecipado.
📝 full_amount: Booleano indicando se é um resgate total.
Simulação de ResgatePara obter uma estimativa das datas de liquidação e cotização de resgate, é possível realizar uma simulação de resgate em fundos, fazendo uma requisição em Simulação de Resgate em Fundos.Este passo é recomendado para mostrar ao cliente as datas relacionadas à resgate no fundo.
⏳ Ciclo de Vida do Resgate
Status existentes:
scheduled(Agendado)requested(Solicitado)processed(Processado)pre_executed(Pré-executado)executed(Aguardando cotização)cotized(Aguardando liquidação)pre_liquidated(Aguardando conciliaçã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) |
(Aguardando liquidação) |
|
(Aguardando liquidação) |
(Aguardando conciliação) |
|
(Aguardando conciliaçã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 do resgate é checado se a operação pode mudar pararequested(Solicitado).
Entre o resgate 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 statuscanceled (Cancelado).
O próprio cliente também pode cancelar o resgate. 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 o resgate foi conciliado. A evolução para a conciliação depende do fundo especificado no resgate.
✔ Consultando o Resgate Criado
O resgate criado pode ser consultado em Buscar Resgate por ID. Também é possível consultar os resgates em fundos de um cliente em Lista de Resgates do Cliente
Além disso, em Operações em Andamento - Resgate, o resgate 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
