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

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.

Visão geral#

Toda transação evolui de forma sequencial, desde a criação na simulação até
sua conclusão.
Nem todo status exige ação do parceiro. Em muitos casos, a transação avança
automaticamente após validações internas realizadas pela Novo Saque.

Tabela de status da transação#

StatusDescriçãoAção do parceiro
CREATEDTransação criada após a simulaçãoNenhuma
IN_ANALYSISEm análise e validações internasNenhuma
PENDING_ACTIONAguardando ação do parceiroVerificar pendência
READY_FOR_FORMALIZATIONApta para formalizaçãoIniciar formalização
FORMALIZATION_IN_PROGRESSFormalização em andamentoNenhuma
DOCUMENT_REQUIREDDocumento pendenteEnviar documento
REPROCESSINGEtapa em reprocessamentoNenhuma
COMPLETEDOperação concluída com sucessoNenhuma
CANCELEDOperação encerrada sem conclusãoNenhuma
Os nomes de status podem variar conforme o produto ou evolução da API.
Sempre utilize o valor retornado pela API como referência.

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.

Status finais#

Os seguintes status indicam o encerramento do fluxo:
COMPLETED: a operação foi concluída com sucesso
CANCELED: a operação foi encerrada sem conclusão
Após atingir um status final, a transação não retorna ao fluxo ativo.
Página anterior
Fluxo da operação
Próxima página
Contract
Built with