Status da transação

Esta seção descreve os estados e status que uma transação pode assumir ao
longo do fluxo operacional da Novo Saque.

O status indica o momento atual da transação e orienta o parceiro sobre
quando uma ação é necessária ou quando a operação segue de forma automática.

Quando o parceiro deve agir

O parceiro deve executar ações somente quando o status da transação indicar necessidade explícita de intervenção.

Em especial:

PENDING_ACTION: indica que existe uma pendência que exige atuação

READY_FOR_FORMALIZATION: indica que a formalização pode ser iniciada

DOCUMENT_REQUIRED: indica necessidade de envio de documentos

A execução de ações fora do status esperado pode resultar em erro ou bloqueio da operação.

1. Simulação e Oferta

Nesta fase inicial, verificamos a elegibilidade do cliente e as condições de crédito disponíveis.

Estágio (`stage`)	Status (`summary_status`)	O que significa?	Próximo Passo / Ação
`term`	`🔵 Awaiting authorization`	O cliente precisa autorizar a consulta de dados no app do FGTS/Banco.	Orientar o cliente a realizar a autorização.
`check-balance`	`🟡 Simulation started`	A margem consignável está sendo verificada internamente.	Aguardar processamento automático.
`check-balance`	`🔴 Offer unavailable`	Impedimento: Margem insuficiente ou consulta negada.	Operação encerrada.
`simulation`	`🟢 Offer available`	Sucesso! Ofertas geradas e prontas para seleção.	Parceiro: Selecionar oferta e iniciar formalização.
`simulation`	`🔴 Offer unavailable`	Nenhuma oferta disponível para as condições solicitadas.	Operação encerrada.

2. Formalização e Assinatura

Após a escolha da oferta, o contrato é gerado e enviado para a assinatura do cliente.

Estágio (`stage`)	Status (`summary_status`)	O que significa?	Próximo Passo / Ação
`create-contract`	`🟡 Awaiting contract generation`	O contrato está sendo montado e registrado no sistema.	Aguardar processamento automático.
`sign-contract`	`🔵 Awaiting formalization`	Link de assinatura (`contract_link`) está disponível.	Parceiro: Enviar link ao cliente para assinatura.
`sign-contract`	`🟡 Signed contract - Awaiting registry`	O cliente assinou. O contrato segue para registro bancário.	Aguardar processamento automático.
`sign-contract`	`🔴 Contract signature error`	Erro: Falha no processo de assinatura digital.	Verificar erro ou reiniciar fluxo de assinatura.

3. Registro e Desembolso

O contrato assinado passa pelo registro oficial e o pagamento é enviado ao cliente.

Estágio (`stage`)	Status (`summary_status`)	O que significa?	Próximo Passo / Ação
`registry`	`🟡 Signed contract - Awaiting registry`	Registro em processamento pela instituição financeira.	Aguardar processamento automático.
`disbursement`	`🟡 Registered - Pending payment`	Registro confirmado. Ordem de pagamento em fila.	Aguardar processamento automático.
`disbursement`	`🟢 Contract paid`	Sucesso! O valor foi creditado na conta do cliente.	Fluxo de desembolso concluído.
`disbursement`	`🔴 Payment returned`	Erro: Falha na transferência (ex: conta incorreta).	Parceiro: Corrigir dados bancários via API.

4. Finalização Técnica

Etapas finais de liquidação e comissionamento.

Estágio (`stage`)	Status (`summary_status`)	O que significa?	Próximo Passo / Ação
`pay-commission`	`🟢 Commission paid`	Pagamento da comissão do parceiro realizado.	Registro informativo.
`collateral`	`🟢 Collateral sended`	Garantias enviadas ao banco. Operação 100% finalizada.	Fim do ciclo de vida da transação.

Legenda de Estados

Para facilitar o monitoramento em dashboards, os status podem ser classificados em:

🟢 Finalizados: Contract paid, Collateral sended, Offer unavailable.

🟡 Processamento: Simulation started, Awaiting contract generation, Registry.

🔵 Ação Requerida: Awaiting authorization, Awaiting formalization (Assinatura).

🔴 Falha Técnica: Payment returned, Contract signature error.

Utilize sempre o campo summary_status para atualizações de interface com o usuário final, e o campo stage para controle de lógica interna da sua integração.
Os nomes de status podem variar conforme o produto ou evolução da API.
Sempre utilize o valor retornado pela API como referência.

Status da transação#

Quando o parceiro deve agir#

1. Simulação e Oferta#

2. Formalização e Assinatura#

3. Registro e Desembolso#

4. Finalização Técnica#