1. Referência da API
  • 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
    • Simulation
      • Iniciar simulação de contrato
      • Re-simulação de parametros de simulação existente
    • Contract
      • Buscar contrato e status do fluxo
    • Formalization
      • Iniciar formalizacao do contrato
    • Payment Authorization
      • payment_authorization
    • Documents Upload
      • documents_upload
    • Reprocessing
      • Reprocessar pagamento
    • Documents
      • Obter URL de arquivo assinado
  1. Referência da API

Contract

O fluxo seguirá os seguintes estágios (stage):
1.
check-balance: Aguarde a conclusão.
2.
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).
3.
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).
4.
O cliente deve acessar o link e realizar a assinatura. Em sandbox utilize a API de assinatura exclusiva de sandbox para simular a assinatura.
5.
Acompanhe o status até Collateral sended para confirmar o encerramento com sucesso.
CampoDescriçãoTipo
contract_linkURL de redirecionamento do tomador para assinatura digital.String
disbursement_dateData do desembolso do crédito (quando o valor é liberado).String (YYYY-MM-DD)
tac_amountValor monetário da TAC (Taxa de Abertura de Crédito).Number
installmentsQuantidade de parcelas da oferta.Integer
outstanding_balanceMargem disponível no momento da proposta.Number
total_iofValor do Imposto sobre Operações Financeiras (IOF) incluso na operação.Number
interest_rate_monthlyTaxa de juros nominal mensal (%).Number
cet_monthly_rateCusto Efetivo Total mensal (%).Number
insurance_amountValor do seguro financiado incluso na operação.Number
installment_valueValor de cada parcela.Number
cet_annual_rateCusto Efetivo Total anual (%).Number
annual_interest_rateTaxa de juros anual (%).Number
first_payment_dateData prevista para o pagamento da primeira parcela (vencimento).String (YYYY-MM-DD)
disbursed_amountValor total a ser liberado ao tomador (líquido).Number
Página anterior
Re-simulação de parametros de simulação existente
Próxima página
Buscar contrato e status do fluxo
Built with