- Novo Saque – Portal de Integração para Parceiros

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:

Criação da transação por meio da simulação

Acompanhamento e validação da operação

Início da formalização

Gestão de documentos e eventuais reprocessamentos

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.

CPFs para Teste em Sandbox

Para facilitar a validação da sua integração, utilize a lista de CPFs abaixo para simular diferentes cenários nos produtos FGTS e CLT.

✅ Disponível: CPF apto para operação (com saldo no caso do FGTS ou elegível para CLT).

❌ Indisponível: CPF sem saldo ou não habilitado para o produto (útil para testar fluxos de erro).

Lista de CPFs para sandbox

CPF	FGTS	CLT
`27054936892`	✅	✅
`03891547684`	✅	✅
`28674395074`	✅	✅
`70583192432`	❌	✅
`92863504142`	✅	✅
`21048736903`	✅	✅
`63958401775`	❌	✅
`38541067939`	✅	✅
`19674523855`	❌	✅
`83795214637`	✅	✅
`23067841590`	✅	✅
`09142573823`	❌	✅
`64289305105`	❌	✅
`31805274635`	✅	✅
`49380265700`	❌	✅
`84617930213`	❌	✅
`35649821089`	❌	✅
`14029865720`	✅	✅
`92174368013`	✅	✅
`14970852332`	✅	✅
`83941702696`	✅	✅
`28415369042`	✅	✅
`17658934020`	❌	✅
`37560842992`	❌	✅
`47862501985`	❌	✅
`05129647343`	✅	✅
`96803541720`	✅	✅
`61074328922`	✅	✅
`64501392770`	✅	✅
`92357640170`	❌	✅
`98346271069`	✅	✅
`14572093652`	❌	✅
`36804172922`	✅	❌
`95083146720`	✅	❌
`01537649299`	✅	❌
`31278095659`	✅	❌

Fluxograma exemplo

O fluxo segue os seguintes estágios (stage):

check-balance: Aguarde a conclusão.

simulation: Quando o status for Offer available, o objeto simulation_results conterá as ofertas disponíveis para escolher um simulation_id e utilizar na formalização da operação (tabelas como CAMPANHA, SMART, etc).

sign-contract: Após a formalização, este estágio conterá o contract_link para a assinatura digital (aguarde a geração do link, pode levar alguns segundos).

O cliente deve acessar o link e realizar a assinatura. Em sandbox utilize a API de assinatura exclusiva de sandbox para simular a assinatura.

Acompanhe o status até Collateral sended para confirmar o encerramento com sucesso.

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

Fluxo da operação#

Visão geral do fluxo#

Etapas do fluxo#

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

2. Acompanhamento da transação#

3. Início da formalização#

4. Documentos e reprocessamentos#

5. Conclusão da operação#

Papéis no fluxo#

CPFs para Teste em Sandbox#

Lista de CPFs para sandbox#

Fluxograma exemplo#

Observações importantes#