1. Guia de Integração
  • Portal de Integração
    • Introdução
    • Comece por aqui
  • Guia de Integração
    • Autenticação e Credenciais
    • Conceitos fundamentais
    • Fluxo da operação
    • Status da transação
  • Referência da API
    • Contract
      • Buscar contrato e status do fluxo
    • Simulation
      • Iniciar simulação de contrato
      • Re-simulaçãoo de parametros de simulação existente
    • Formalization
      • Iniciar formalizacao do contrato
    • Reprocessing
      • Reprocessar pagamento
    • Documents
      • Obter URL de arquivo assinado
  1. Guia de Integração

Fluxo da operação#

Esta seção descreve, em alto nível, como funciona o fluxo operacional da Novo Saque desde o início de uma operação até sua conclusão.
O fluxo é único e padronizado, sendo utilizado por diferentes produtos de crédito. As variações entre produtos estão relacionadas a regras e validações específicas, não à estrutura do fluxo.

Visão geral do fluxo#

Toda operação na plataforma da Novo Saque é representada por uma transação única, identificada por um transaction_id.
Esse identificador acompanha a operação durante todo o ciclo de vida, permitindo que o parceiro acompanhe o status, consulte dados e execute ações conforme a etapa em que a transação se encontra.
De forma geral, o fluxo segue as seguintes fases:
1.
Criação da transação por meio da simulação
2.
Acompanhamento e validação da operação
3.
Início da formalização
4.
Gestão de documentos e eventuais reprocessamentos
5.
Conclusão da operação

Etapas do fluxo#

1. Simulação e criação da transação#

O fluxo é iniciado com a realização de uma simulação de operação de crédito.
Essa etapa cria a transação e retorna o transaction_id, que deve ser armazenado pelo parceiro.
A partir desse momento, todas as interações com a operação utilizam esse identificador.

2. Acompanhamento da transação#

Após a criação, a transação passa por etapas de análise e validação.
Durante essa fase, o parceiro pode consultar:
O status atual da transação
Os dados consolidados do contrato
O resultado das validações executadas
Essa consulta permite identificar quando a operação está apta para avançar para a próxima etapa.

3. Início da formalização#

Quando a transação atende aos critérios definidos, o parceiro pode iniciar a formalização da operação.
Essa etapa dá continuidade ao fluxo até a efetivação do contrato, podendo envolver ações adicionais conforme o produto operado.

4. Documentos e reprocessamentos#

Ao longo do fluxo, podem ser solicitados documentos ou ser necessário reprocessar etapas específicas.
Essas ações permitem corrigir pendências e garantir a continuidade da operação sem a necessidade de reiniciar o fluxo.

5. Conclusão da operação#

A operação é considerada concluída quando todas as etapas obrigatórias são finalizadas com sucesso.
O status final da transação indica o encerramento do fluxo, seja por conclusão positiva ou por encerramento da operação.

Papéis no fluxo#

Parceiro: inicia a simulação, acompanha a transação e executa as ações necessárias conforme o status retornado.
Novo Saque: executa as validações, orquestra o fluxo e processa as etapas internas da operação.

Observações importantes#

Nem todas as etapas exigem ação do parceiro
O fluxo não reinicia ao longo da operação: eventuais ajustes são feitos por meio de reprocessamentos específicos
As regras específicas podem variar conforme o produto, sem alterar a estrutura do fluxo
Página anterior
Conceitos fundamentais
Próxima página
Status da transação
Built with