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

Conceitos fundamentais#

Esta seção descreve os principais conceitos utilizados ao longo da integração com a API da Novo Saque. A compreensão desses conceitos é essencial para a correta operação do fluxo.

Transação#

Uma transação representa uma operação de crédito em andamento dentro da plataforma da Novo Saque.
Desde a simulação inicial até a formalização, todas as etapas da operação estão associadas a uma única transação.

Transaction_id#

📌
O transaction_id é o identificador único de uma transação.
Ele é criado no início do fluxo e deve ser utilizado em todas as chamadas subsequentes, independentemente do produto operado.
Esse identificador é a principal referência para acompanhamento da operação.

Produto#

O produto define a modalidade de crédito operada dentro da transação.
A API da Novo Saque suporta múltiplos produtos dentro do mesmo fluxo operacional. As diferenças entre produtos estão relacionadas a regras, validações e campos específicos, e não à estrutura do fluxo.

Etapas do fluxo#

Toda transação percorre um conjunto padronizado de etapas, que podem incluir:
Simulação
Análise e acompanhamento
Formalização
Gestão de documentos
Reprocessamentos, quando aplicável
Nem todas as etapas exigem ação do parceiro, dependendo do produto e do momento da operação.

Status da transação#

O status indica o estado atual da transação dentro do fluxo.
Por meio da consulta de status, o parceiro pode acompanhar a evolução da operação e identificar quando uma nova ação é necessária.
Página anterior
Autenticação e Credenciais
Próxima página
Fluxo da operação
Built with