Pular para o conteúdo principal

Jornada de Crédito - Finway

Esta documentação apresenta a jornada completa de crédito disponível na plataforma Finway, organizando cada etapa do processo em seções específicas.

🏦 1. Pré-qualificação e Consulta​

Listar Bancos Disponíveis

Endpoint: GET /banks

Primeiro passo da jornada onde o usuário consulta todos os bancos parceiros disponíveis para operações de crédito.

Funcionalidade:

  • Lista todos os bancos habilitados
  • Informações básicas dos parceiros bancários
  • Base para escolha do provedor de crédito

Resposta: Lista de bancos com detalhes institucionais

Consultar Produtos de Crédito Disponíveis

Endpoint: GET /holders/me/credit/products

Obtém todos os produtos de crédito disponíveis para o usuário autenticado.

Funcionalidades:

  • Lista produtos personalizados por perfil
  • Informações de elegibilidade
  • Tipos de crédito disponíveis (cartão, empréstimo, etc.)

Resposta: Array com produtos de crédito elegíveis

Obter Detalhes de Produto Específico

Endpoint: GET /holders/me/credit/products/{id}

Consulta informações detalhadas de um produto de crédito específico.

Funcionalidades:

  • Condições detalhadas do produto
  • Limites e taxas aplicáveis
  • Requisitos específicos
  • Vantagens e benefícios

Parâmetros: ID do produto Resposta: Detalhes completos do produto selecionado

💰 2. Simulação e Análise​

Simular Produto de Crédito

Endpoint: POST /holders/me/credit/products/{id}/simulation

Realiza simulação personalizada do produto de crédito com valores específicos.

Funcionalidades:

  • Cálculo de parcelas
  • Projeção de juros e taxas
  • Análise de viabilidade
  • Comparação de cenários

Parâmetros:

  • ID do produto
  • Valor desejado
  • Prazo pretendido

Resposta: Simulação detalhada com condições financeiras

📄 3. Documentação​

Upload de Documentos

Endpoint: POST /holders/me/credit/products/{id}/documents

Envio da documentação necessária para análise de crédito.

Tipos de Documentos:

  • Comprovantes de renda
  • Documentos pessoais
  • Extratos bancários
  • Comprovantes de residência

Funcionalidades:

  • Validação automática de documentos
  • OCR para extração de dados
  • Status de análise documental
  • Notificação de pendências

Parâmetros: ID do produto e arquivo

📋 4. Contratação​

Criar Contrato

Endpoint: POST /holders/me/credit/products/{id}/contracts

Formalização do contrato de crédito após aprovação da análise.

Processo de Contratação:

  • Aceite dos termos e condições
  • Definição de modalidades de pagamento
  • Configuração de dados bancários
  • Assinatura eletrônica

Parâmetros:

  • ID do produto
  • Dados do contrato
  • Modalidade de pagamento

Resposta: Contrato formalizado com identificador único

Consultar Contratos

Endpoint: GET /holders/me/credit/products/{id}/contracts

Lista todos os contratos ativos de um produto de crédito específico.

Funcionalidades:

  • Visualização de contratos vigentes
  • Status de cada contrato
  • Histórico de operações

Parâmetros: ID do produto Resposta: Lista de contratos do produto

Detalhes de Contrato Específico

Endpoint: GET /holders/me/credit/products/{id}/contracts/{contractId}/details

Obtém informações detalhadas de um contrato específico.

Informações Disponíveis:

  • Condições contratuais
  • Cronograma de pagamentos
  • Saldo devedor atual
  • Histórico de movimentações

Parâmetros: ID do produto e ID do contrato

💸 5. Gestão de Empréstimos​

Consultar Saques Pendentes

Endpoint: GET /holders/me/credit/products/contracts/withdrawals/pending

Verifica se existem saques de empréstimo aguardando autorização.

Funcionalidades:

  • Lista de saques em processamento
  • Status de cada operação
  • Valores e prazos
  • Requisitos pendentes

Resposta: Detalhes dos saques pendentes

Autorizar Saque

Endpoint: POST /holders/me/credit/products/contracts/withdrawals/authorize

Autoriza um saque de empréstimo que estava pendente.

Processo de Autorização:

  • Validação biométrica
  • Confirmação de dados
  • Processamento da liberação
  • Notificação de conclusão

Parâmetros: Dados de autorização do saque

Cancelar Pré-autorização

Endpoint: POST /holders/me/credit/products/contracts/cancel

Cancela uma pré-autorização de saque antes da efetivação.

Funcionalidades:

  • Cancelamento de operações não efetivadas
  • Reversão de reservas de limite
  • Notificação de cancelamento

💳 6. Gestão de Pagamentos​

Consultar Produtos com Pagamentos Pendentes

Endpoint: GET /holders/me/credit/products/payments/pending

Lista produtos que possuem pagamentos em atraso ou próximos ao vencimento.

Funcionalidades:

  • Alertas de vencimento
  • Valores em aberto
  • Datas de vencimento
  • Opções de pagamento

Resposta: Lista de produtos com pendências

Consultar Faturas

Endpoint: GET /holders/me/credit/products/{productId}/invoices

Obtém faturas de um produto específico dentro de um período.

Parâmetros:

  • ID do produto
  • Data início (opcional)
  • Data fim (opcional)

Funcionalidades:

  • Histórico de faturas
  • Detalhes de consumo
  • Status de pagamento
  • Valores e vencimentos
Consultar Última Fatura

Endpoint: GET /holders/me/credit/products/{productId}/invoices/last

Obtém as faturas mais recentes de um produto.

Funcionalidade: Acesso rápido às faturas atuais Parâmetros: ID do produto e filtros de data opcionais

Gerar Boleto de Fatura

Endpoint: GET /holders/me/credit/products/{productId}/invoices/{invoiceId}/payment-slip

Gera boleto bancário para pagamento de fatura específica.

Funcionalidades:

  • Código de barras
  • Dados para pagamento
  • QR Code PIX (se disponível)
  • Data de vencimento

Parâmetros: ID do produto e ID da fatura

Planos de Parcelamento de Fatura

Endpoint: GET /holders/me/credit/products/{productId}/invoices/installment

Consulta opções de parcelamento disponíveis para faturas.

Funcionalidades:

  • Diferentes opções de parcelas
  • Cálculo de juros
  • Condições de pagamento
  • Simulação de valores

Parâmetros: ID do produto

Criar Parcelamento de Fatura

Endpoint: POST /holders/me/credit/products/{productId}/invoices/installment

Efetiva o parcelamento de uma fatura em várias parcelas.

Processo:

  • Seleção do número de parcelas
  • Aceite das condições
  • Criação do plano de pagamento
  • Atualização da fatura original

Parâmetros: ID do produto e dados do parcelamento

Consultar Planos de Pagamento

Endpoint: GET /holders/me/credit/products/{productId}/payment-plans

Lista todos os planos de pagamento ativos de um produto.

Filtros Disponíveis:

  • Tipo de plano
  • Status (ativo/inativo)
  • Período específico

Funcionalidades:

  • Cronogramas de pagamento
  • Status de cada parcela
  • Valores e vencimentos
Consultar Parcelas de Plano

Endpoint: GET /holders/me/credit/products/{productId}/payment-plans/installments

Obtém lista paginada de parcelas de planos de pagamento.

Recursos:

  • Paginação configurável
  • Filtros por tipo e status
  • Período específico
  • Detalhes de cada parcela

Parâmetros: ID do produto, filtros e paginação

Gerar Boleto de Parcela

Endpoint: GET /holders/me/credit/products/{productId}/payment-plans/installments/{installmentId}/payment-slip

Gera boleto para pagamento de parcela específica de um plano.

Funcionalidades:

  • Código de barras da parcela
  • Informações de pagamento
  • QR Code PIX
  • Data de vencimento específica

Parâmetros: ID do produto e ID da parcela

Consultar Métodos de Pagamento

Endpoint: POST /holders/me/credit/products/{productId}/payment-methods

Obtém métodos de pagamento disponíveis para um produto específico.

Métodos Disponíveis:

  • Boleto bancário
  • PIX
  • Débito automático
  • Cartão de crédito

Funcionalidades:

  • Configuração de preferências
  • Dados para cada modalidade
  • Condições especiais por método

🏠 7. FGTS - Antecipação (Fluxo Específico)​

Enviar Proposta FGTS

Endpoint: POST /fgts/proposal

Inicia processo de antecipação do FGTS com dados do solicitante.

Dados Necessários:

  • CPF
  • Data de nascimento
  • Quantidade de parcelas desejadas
  • Telefone para contato
  • Nome completo

Funcionalidades:

  • Análise automática de elegibilidade
  • Cálculo de condições
  • Geração de número da proposta
Obter Detalhes da Proposta FGTS

Endpoint: GET /fgts/proposal/{proposalNumber}/details

Consulta detalhes completos de uma proposta FGTS já criada.

Informações Retornadas:

  • Status da análise
  • Condições aprovadas
  • Plano de pagamento
  • Taxas e encargos
  • Próximos passos

Parâmetros: Número da proposta

Obter Documentos para Formalização

Endpoint: GET /fgts/proposal/{proposalNumber}/formalization/documents

Obtém lista de documentos necessários para formalização da proposta FGTS.

Documentos Típicos:

  • Termo de adesão
  • Contrato de antecipação
  • Autorização FGTS
  • Comprovantes complementares

Parâmetros: Número da proposta

Formalizar Proposta FGTS

Endpoint: PUT /fgts/proposal/{proposalNumber}/formalization

Efetiva a formalização da proposta FGTS após análise aprovada.

Processo de Formalização:

  • Assinatura de documentos
  • Validação biométrica
  • Confirmação de dados bancários
  • Ativação do contrato

Parâmetros: Número da proposta e dados de formalização

📊 Fluxo Completo da Jornada​

  1. Início: Consulta de bancos e produtos disponíveis
  2. Análise: Simulação e avaliação de condições
  3. Documentação: Upload e validação de documentos
  4. Contratação: Formalização e criação de contratos
  5. Operação: Gestão de saques e movimentações
  6. Pagamento: Acompanhamento de faturas e parcelas
  7. FGTS: Fluxo específico para antecipação (quando aplicável)

Cada etapa da jornada possui validações específicas e requisitos de compliance, garantindo segurança e conformidade regulatória em todas as operações de crédito.