ℹ️ Conteúdo em atualização

Estamos revisando estes procedimentos. Pessoas técnicas podem encontrar ajustes em códigos de erro ou mapeamentos de payload; valide com os logs e o OpenAPI mais recente. Pessoas não técnicas podem continuar usando o passo a passo e acionar o time de suporte caso algo pareça diferente do descrito.

💰 API de Empréstimo Pessoal Lojista

Este guia apresenta o passo a passo para integração com o serviço de empréstimo pessoal em lojas físicas, permitindo que seus clientes contratem crédito de forma rápida e segura.

🎯 Visão Geral

A API de Empréstimo Pessoal Lojista permite que você:

🔍 Simule planos de empréstimo disponíveis
✅ Verifique elegibilidade do cliente
📄 Gere pré-contratos com todas as informações
💳 Efetive empréstimos e transfira valores
📋 Consulte contratos e parcelas
⚡ Antecipe parcelas com desconto
❌ Cancele contratos quando necessário
🛡️ Gerencie seguros opcionais
📧 Envie boletos por SMS e e-mail

URL Base:

Homologação: https://apihml.credsystem.com.br/emprestimo-pessoal-lojista/api/v1

🔐 Autenticação

Todos os endpoints requerem autenticação via Bearer Token (JWT).

Header obrigatório:

Authorization: Bearer <seu_token_jwt>

Atenção

Tokens inválidos ou expirados retornarão erro 401 Unauthorized.

📚 Endpoints Disponíveis

1️⃣ Simular Planos de Empréstimo

Consulta os planos de empréstimo disponíveis para o cliente com base no valor solicitado. Este é o primeiro passo para iniciar um empréstimo.

Endpoint: GET /simulacao-plano

Parâmetros:

Parâmetro	Tipo	Local	Obrigatório	Descrição
`Authorization`	string	Header	✅ Sim	Bearer token JWT
`cpfCliente`	string	Header	✅ Sim	CPF do cliente
`valorTransacao`	number	Header	✅ Sim	Valor do empréstimo desejado
`incluirSeguro`	boolean	Header	❌ Não	Se deve incluir seguro (default: false)

Exemplo de Requisição:

curl -X GET "https://app-bffepl-hml.credsystem.com.br/emprestimo-pessoal-lojista/api/v1/simulacao-plano" \
  -H "Authorization: Bearer SEU_TOKEN_JWT" \
  -H "cpfCliente: 12345678901" \
  -H "valorTransacao: 5000.00" \
  -H "incluirSeguro: true"

Exemplo de Resposta (200 Success):

{
  "planos": [
    {
      "quantidadeParcelas": 12,
      "valorParcela": 485.50,
      "taxaMes": 2.99,
      "taxaAno": 42.58,
      "valorTotal": 5826.00,
      "valorIOF": 326.00,
      "cetMes": 3.15,
      "cetAno": 45.20,
      "valorSeguro": 150.00
    },
    {
      "quantidadeParcelas": 24,
      "valorParcela": 275.30,
      "taxaMes": 2.99,
      "taxaAno": 42.58,
      "valorTotal": 6607.20,
      "valorIOF": 607.20,
      "cetMes": 3.15,
      "cetAno": 45.20,
      "valorSeguro": 300.00
    }
  ]
}

Melhor Prática

Exiba os planos de forma clara para o cliente, mostrando o valor da parcela, quantidade e total a pagar. O seguro é opcional e deve ser apresentado como uma escolha do cliente.

2️⃣ Verificar Elegibilidade do Cliente

Verifica se o cliente está apto a contratar o empréstimo. Este endpoint valida crédito, restrições e limites disponíveis.

Endpoint: POST /elegibilidade

Headers:

Header	Tipo	Descrição
`Authorization`	string	Bearer token JWT
`cpfCliente`	string	CPF do cliente

Corpo da Requisição:

{
  "codigoCliente": 123456,
  "numeroBin": 5555,
  "idCanal": 1,
  "codigoEstabelecimento": 12345
}

Campos da Requisição:

Campo	Tipo	Descrição
`codigoCliente`	integer	Código do cliente no sistema
`numeroBin`	integer	BIN do cartão
`idCanal`	integer	Identificador do canal (ex: 1 = App, 2 = Loja)
`codigoEstabelecimento`	integer	Código da loja/estabelecimento

Exemplo de Requisição:

curl -X POST "https://app-bffepl-hml.credsystem.com.br/emprestimo-pessoal-lojista/api/v1/elegibilidade" \
  -H "Authorization: Bearer SEU_TOKEN_JWT" \
  -H "cpfCliente: 12345678901" \
  -H "Content-Type: application/json" \
  -d '{
    "codigoCliente": 123456,
    "numeroBin": 5555,
    "idCanal": 1,
    "codigoEstabelecimento": 12345
  }'

Exemplo de Resposta (200 Success):

{
  "elegivel": true,
  "limiteDisponivel": 10000.00,
  "motivoRecusa": null,
  "restricoes": []
}

Possíveis Respostas:

Situação	elegivel	Descrição
✅ Aprovado	`true`	Cliente pode contratar o empréstimo
❌ Recusado	`false`	Cliente não está apto (verificar `motivoRecusa`)

3️⃣ Gerar Pré-Contrato

Gera o pré-contrato com todas as condições do empréstimo para o cliente visualizar antes de efetivar. Este documento contém todas as informações legais e comerciais.

Endpoint: GET /precontrato

Parâmetros:

Parâmetro	Tipo	Local	Descrição
`Authorization`	string	Header	Bearer token JWT
`cpfCliente`	string	Header	CPF do cliente
`valorEmprestimo`	number	Header	Valor do empréstimo
`valorTotalIof`	number	Header	Valor total do IOF
`valorTotal`	number	Header	Valor total a pagar
`taxaMes`	number	Header	Taxa de juros mensal
`taxaAno`	number	Header	Taxa de juros anual
`taxaCetMes`	number	Header	CET mensal
`taxaCetAno`	number	Header	CET anual
`codigoCompe`	string	Header	Código do banco (COMPE)
`numeroAgencia`	string	Header	Número da agência
`numeroConta`	string	Header	Número da conta
`tipoConta`	string	Header	Tipo da conta (CC ou PP)
`numeroParcela`	integer	Header	Quantidade de parcelas
`dataVencimentoParcela`	datetime	Header	Data de vencimento da 1ª parcela
`valorParcela`	number	Header	Valor de cada parcela
`valorTotalSeguro`	number	Header	Valor total do seguro (se contratado)

Exemplo de Requisição:

curl -X GET "https://app-bffepl-hml.credsystem.com.br/emprestimo-pessoal-lojista/api/v1/precontrato" \
  -H "Authorization: Bearer SEU_TOKEN_JWT" \
  -H "cpfCliente: 12345678901" \
  -H "valorEmprestimo: 5000.00" \
  -H "valorTotalIof: 326.00" \
  -H "valorTotal: 5826.00" \
  -H "taxaMes: 2.99" \
  -H "taxaAno: 42.58" \
  -H "taxaCetMes: 3.15" \
  -H "taxaCetAno: 45.20" \
  -H "codigoCompe: 001" \
  -H "numeroAgencia: 1234" \
  -H "numeroConta: 123456-7" \
  -H "tipoConta: CC" \
  -H "numeroParcela: 12" \
  -H "dataVencimentoParcela: 2025-01-03T00:00:00.000Z" \
  -H "valorParcela: 485.50" \
  -H "valorTotalSeguro: 150.00"

Exemplo de Resposta (200 Success):

{
  "precontratoBase64": "JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlL...",
  "hashContrato": "a1b2c3d4e5f6g7h8i9j0",
  "dataExpiracao": "2025-12-03T23:59:59.000Z"
}

Importante

O pré-contrato é gerado em Base64 e deve ser apresentado ao cliente para leitura e aceite. O cliente deve concordar com os termos antes da efetivação.

4️⃣ Gerenciar Contas Bancárias do Cliente

Permite cadastrar e consultar as contas bancárias do cliente para recebimento do empréstimo.

Consultar Contas

Endpoint: GET /conta

Headers:

Header	Tipo	Descrição
`Authorization`	string	Bearer token JWT
`cpfCliente`	string	CPF do cliente

Exemplo de Requisição:

curl -X GET "https://app-bffepl-hml.credsystem.com.br/emprestimo-pessoal-lojista/api/v1/conta" \
  -H "Authorization: Bearer SEU_TOKEN_JWT" \
  -H "cpfCliente: 12345678901"

Exemplo de Resposta:

{
  "contas": [
    {
      "id": 1,
      "codigoCompe": "001",
      "nomeInstituicao": "Banco do Brasil",
      "numeroAgencia": "1234",
      "numeroConta": "123456",
      "dvConta": "7",
      "tipoConta": "CC",
      "status": "A"
    }
  ]
}

Cadastrar Nova Conta

Endpoint: POST /conta

Corpo da Requisição:

{
  "codigoCliente": 123456,
  "codigoCompe": "001",
  "nomeInstituicao": "Banco do Brasil",
  "numeroAgencia": "1234",
  "numeroConta": "123456",
  "dvConta": "7",
  "ispb": "00000000",
  "tipoConta": "CC",
  "status": "A"
}

Tipos de Conta:

CC - Conta Corrente
PP - Poupança

Status:

A - Ativo
I - Inativo
R - Removido

5️⃣ Efetivar Empréstimo

Efetiva o empréstimo após o cliente aceitar o pré-contrato. Este é o passo que cria o contrato e agenda a transferência do valor.

Endpoint: POST /efetivacao

Headers:

Header	Tipo	Descrição
`Authorization`	string	Bearer token JWT
`cpfCliente`	string	CPF do cliente

Corpo da Requisição:

{
  "idCanal": 1,
  "codigoEstabelecimento": 12345,
  "numeroBin": 5555,
  "idApp": 100,
  "valor": 5000.00,
  "quantidadeParcela": 12,
  "codigoCartao": "1234567890123456",
  "dataHoraAceite": "2025-12-03T14:30:00.000Z",
  "Conta": {
    "codigoCompe": "001",
    "numeroAgencia": "1234",
    "numeroConta": "123456",
    "dvConta": "7",
    "tipoConta": "CC"
  },
  "seguroAceito": true
}

Campos da Requisição:

Campo	Tipo	Descrição
`idCanal`	integer	Canal de atendimento
`codigoEstabelecimento`	integer	Código da loja
`numeroBin`	integer	BIN do cartão
`idApp`	integer	ID do aplicativo/sistema
`valor`	number	Valor do empréstimo
`quantidadeParcela`	integer	Quantidade de parcelas
`codigoCartao`	string	Número do cartão
`dataHoraAceite`	datetime	Data/hora que o cliente aceitou o contrato
`Conta`	object	Dados da conta para recebimento
`seguroAceito`	boolean	Se o cliente aceitou o seguro

Exemplo de Requisição:

curl -X POST "https://app-bffepl-hml.credsystem.com.br/emprestimo-pessoal-lojista/api/v1/efetivacao" \
  -H "Authorization: Bearer SEU_TOKEN_JWT" \
  -H "cpfCliente: 12345678901" \
  -H "Content-Type: application/json" \
  -d '{
    "idCanal": 1,
    "codigoEstabelecimento": 12345,
    "numeroBin": 5555,
    "idApp": 100,
    "valor": 5000.00,
    "quantidadeParcela": 12,
    "codigoCartao": "1234567890123456",
    "dataHoraAceite": "2025-12-03T14:30:00.000Z",
    "Conta": {
      "codigoCompe": "001",
      "numeroAgencia": "1234",
      "numeroConta": "123456",
      "dvConta": "7",
      "tipoConta": "CC"
    },
    "seguroAceito": true
  }'

Exemplo de Resposta (200 Success):

{
  "numeroContrato": 987654321,
  "mensagem": "Empréstimo efetivado com sucesso",
  "dataPrevisaoTransferencia": "2025-12-04T10:00:00.000Z",
  "status": "AGENDADO"
}

Empréstimo Efetivado!

O valor será transferido para a conta do cliente na data prevista. O contrato está criado e as parcelas já estão agendadas.

6️⃣ Consultar Empréstimos do Cliente

Lista todos os empréstimos pessoais do cliente, incluindo contratos ativos, quitados e cancelados.

Endpoint: GET /efetivacao

Headers:

Header	Tipo	Descrição
`Authorization`	string	Bearer token JWT
`cpfCliente`	string	CPF do cliente

Exemplo de Requisição:

curl -X GET "https://app-bffepl-hml.credsystem.com.br/emprestimo-pessoal-lojista/api/v1/efetivacao" \
  -H "Authorization: Bearer SEU_TOKEN_JWT" \
  -H "cpfCliente: 12345678901"

Exemplo de Resposta:

{
  "emprestimos": [
    {
      "numeroContrato": 987654321,
      "valor": 5000.00,
      "quantidadeParcelas": 12,
      "valorParcela": 485.50,
      "dataContratacao": "2025-12-03T14:30:00.000Z",
      "status": "ATIVO",
      "saldoDevedor": 4500.00,
      "parcelasPagas": 2,
      "parcelasAbertas": 10
    }
  ]
}

7️⃣ Consultar Detalhes do Contrato

Retorna todos os detalhes de um contrato específico de empréstimo.

Endpoint: GET /contrato

Headers:

Header	Tipo	Descrição
`Authorization`	string	Bearer token JWT
`numeroContrato`	integer	Número do contrato

Exemplo de Requisição:

curl -X GET "https://app-bffepl-hml.credsystem.com.br/emprestimo-pessoal-lojista/api/v1/contrato" \
  -H "Authorization: Bearer SEU_TOKEN_JWT" \
  -H "numeroContrato: 987654321"

Exemplo de Resposta:

{
  "numeroContrato": 987654321,
  "cpfCliente": "12345678901",
  "nomeCliente": "João da Silva",
  "valorEmprestimo": 5000.00,
  "quantidadeParcelas": 12,
  "valorParcela": 485.50,
  "taxaMes": 2.99,
  "taxaAno": 42.58,
  "cetMes": 3.15,
  "cetAno": 45.20,
  "valorIOF": 326.00,
  "valorTotal": 5826.00,
  "dataContratacao": "2025-12-03T14:30:00.000Z",
  "dataVencimentoPrimeiraParcela": "2025-01-03T00:00:00.000Z",
  "status": "ATIVO",
  "saldoDevedor": 4500.00,
  "parcelasPagas": 2,
  "parcelasAbertas": 10,
  "possuiSeguro": true,
  "valorSeguro": 150.00
}

8️⃣ Consultar Parcelas do Contrato

Lista todas as parcelas de um contrato de empréstimo com suas respectivas situações.

Endpoint: GET /parcela

Headers:

Header	Tipo	Descrição
`Authorization`	string	Bearer token JWT
`numeroContrato`	integer	Número do contrato

Exemplo de Requisição:

curl -X GET "https://app-bffepl-hml.credsystem.com.br/emprestimo-pessoal-lojista/api/v1/parcela" \
  -H "Authorization: Bearer SEU_TOKEN_JWT" \
  -H "numeroContrato: 987654321"

Exemplo de Resposta:

{
  "parcelas": [
    {
      "numeroParcela": 1,
      "dataVencimento": "2025-01-03",
      "valorParcela": 485.50,
      "valorPago": 485.50,
      "dataPagamento": "2025-01-02",
      "status": "PAGO"
    },
    {
      "numeroParcela": 2,
      "dataVencimento": "2025-02-03",
      "valorParcela": 485.50,
      "valorPago": 485.50,
      "dataPagamento": "2025-02-01",
      "status": "PAGO"
    },
    {
      "numeroParcela": 3,
      "dataVencimento": "2025-03-03",
      "valorParcela": 485.50,
      "valorPago": 0,
      "dataPagamento": null,
      "status": "ABERTO"
    }
  ]
}

Status das Parcelas:

ABERTO - Parcela em aberto
PAGO - Parcela quitada
VENCIDO - Parcela vencida e não paga
ANTECIPADO - Parcela antecipada

9️⃣ Gerar Boleto de Parcela

Gera o boleto para pagamento de uma parcela específica do empréstimo.

Endpoint: GET /parcela/boleto

Headers:

Header	Tipo	Descrição
`Authorization`	string	Bearer token JWT
`numeroContrato`	integer	Número do contrato
`numeroParcela`	integer	Número da parcela

Exemplo de Requisição:

curl -X GET "https://app-bffepl-hml.credsystem.com.br/emprestimo-pessoal-lojista/api/v1/parcela/boleto" \
  -H "Authorization: Bearer SEU_TOKEN_JWT" \
  -H "numeroContrato: 987654321" \
  -H "numeroParcela: 3"

Exemplo de Resposta:

{
  "numeroParcela": 3,
  "dataVencimento": "2025-03-03",
  "valorParcela": 485.50,
  "linhaDigitavel": "00190.00009 01234.567890 12345.678901 2 99990000048550",
  "codigoBarras": "00192999900000485500000001234567890123456789012",
  "boletoBase64": "JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlL..."
}

Enviar Boleto por SMS

Endpoint: POST /parcela/boleto/envio-sms

Headers:

Header	Tipo	Descrição
`Authorization`	string	Bearer token JWT
`cpfCliente`	string	CPF do cliente
`numeroContrato`	integer	Número do contrato
`numeroParcela`	integer	Número da parcela

Corpo da Requisição:

{
  "ddd": "11",
  "celular": "987654321",
  "boleto": "boletoBase64String",
  "linhaDigitavel": "00190.00009 01234.567890 12345.678901 2 99990000048550"
}

Exemplo:

curl -X POST "https://app-bffepl-hml.credsystem.com.br/emprestimo-pessoal-lojista/api/v1/parcela/boleto/envio-sms" \
  -H "Authorization: Bearer SEU_TOKEN_JWT" \
  -H "cpfCliente: 12345678901" \
  -H "numeroContrato: 987654321" \
  -H "numeroParcela: 3" \
  -H "Content-Type: application/json" \
  -d '{
    "ddd": "11",
    "celular": "987654321",
    "boleto": "JVBERi0xLjQK...",
    "linhaDigitavel": "00190.00009 01234.567890 12345.678901 2 99990000048550"
  }'

Enviar Boleto por E-mail

Endpoint: POST /parcela/boleto/envio-email

Corpo da Requisição:

{
  "email": "cliente@email.com",
  "boleto": "boletoBase64String",
  "linhaDigitavel": "00190.00009 01234.567890 12345.678901 2 99990000048550"
}

🔟 Antecipar Parcelas

Permite que o cliente antecipe o pagamento de parcelas com desconto nos juros.

Consultar Elegibilidade para Antecipação

Endpoint: GET /antecipacao/elegibilidade

Headers:

Header	Tipo	Descrição
`Authorization`	string	Bearer token JWT
`numeroContrato`	integer	Número do contrato

Exemplo de Requisição:

curl -X GET "https://app-bffepl-hml.credsystem.com.br/emprestimo-pessoal-lojista/api/v1/antecipacao/elegibilidade" \
  -H "Authorization: Bearer SEU_TOKEN_JWT" \
  -H "numeroContrato: 987654321"

Exemplo de Resposta:

{
  "podeAntecipar": true,
  "parcelas": [
    {
      "numeroParcela": 3,
      "dataVencimento": "2025-03-03",
      "valorOriginal": 485.50,
      "valorDesconto": 15.50,
      "valorTotal": 470.00
    },
    {
      "numeroParcela": 4,
      "dataVencimento": "2025-04-03",
      "valorOriginal": 485.50,
      "valorDesconto": 30.80,
      "valorTotal": 454.70
    }
  ],
  "valorTotalDesconto": 46.30,
  "valorTotalAntecipacao": 924.70
}

Consultar Parcelas para Antecipação

Endpoint: GET /antecipacao/parcela

Headers:

Header	Tipo	Descrição
`Authorization`	string	Bearer token JWT
`numeroContrato`	integer	Número do contrato

Efetivar Antecipação

Endpoint: POST /antecipacao/efetivacao

Corpo da Requisição:

{
  "loja": 12345,
  "contrato": 987654321,
  "parcelas": [
    {
      "parcela": 3,
      "dataVencimento": "2025-03-03",
      "valorOriginal": 485.50,
      "valorDesconto": 15.50,
      "valorTotal": 470.00
    },
    {
      "parcela": 4,
      "dataVencimento": "2025-04-03",
      "valorOriginal": 485.50,
      "valorDesconto": 30.80,
      "valorTotal": 454.70
    }
  ]
}

Exemplo de Resposta:

{
  "codigoAntecipacao": "ANT123456",
  "mensagem": "Antecipação realizada com sucesso",
  "valorTotal": 924.70,
  "valorDesconto": 46.30,
  "dataEfetivacao": "2025-12-03T14:45:00.000Z",
  "boletoLinhaDigitavel": "00190.00009 01234.567890 12345.678901 2 99990000092470"
}

Consultar Antecipação

Endpoint: GET /antecipacao

Headers:

Header	Tipo	Descrição
`Authorization`	string	Bearer token JWT
`cpfCliente`	string	CPF do cliente
`codigoAntecipacao`	string	Código da antecipação

Cancelar Antecipação

Endpoint: POST /antecipacao/cancelamento

Headers:

Header	Tipo	Descrição
`Authorization`	string	Bearer token JWT
`codigoAntecipacao`	string	Código da antecipação

Corpo da Requisição:

{
  "motivo": "Desistência do cliente"
}

Enviar Boleto de Antecipação por SMS

Endpoint: POST /antecipacao/boleto/envio-sms

Headers:

Header	Tipo	Descrição
`Authorization`	string	Bearer token JWT
`codigoAntecipacao`	string	Código da antecipação

Corpo da Requisição:

{
  "ddd": "11",
  "celular": "987654321"
}

Enviar Boleto de Antecipação por E-mail

Endpoint: POST /antecipacao/boleto/envio-email

Corpo da Requisição:

{
  "email": "cliente@email.com"
}

1️⃣1️⃣ Cancelar Empréstimo

Permite cancelar um empréstimo pessoal contratado. O cancelamento gera um boleto para devolução do valor recebido.

Verificar Elegibilidade para Cancelamento

Endpoint: POST /elegibilidade/cancelamento

Corpo da Requisição:

{
  "numeroContrato": 987654321,
  "idCanal": 1,
  "codigoEstabelecimento": 12345,
  "idApp": 100,
  "dataHoraCancelamento": "2025-12-03T15:00:00.000Z",
  "canalCancelamento": "LOJA"
}

Exemplo de Resposta:

{
  "podeCancelar": true,
  "valorDevolucao": 5000.00,
  "prazoMaximo": "2025-12-10T23:59:59.000Z",
  "observacoes": "Cancelamento permitido dentro do prazo de 7 dias"
}

Efetivar Cancelamento

Endpoint: POST /efetivacao/cancelamento

Corpo da Requisição:

{
  "numeroContrato": 987654321,
  "idCanal": 1,
  "codigoEstabelecimento": 12345,
  "idApp": 100,
  "dataHoraCancelamento": "2025-12-03T15:00:00.000Z",
  "canalCancelamento": "LOJA"
}

Exemplo de Resposta:

{
  "mensagem": "Cancelamento realizado com sucesso",
  "valorDevolucao": 5000.00,
  "dataVencimentoBoleto": "2025-12-10",
  "linhaDigitavel": "00190.00009 01234.567890 12345.678901 2 99990000500000"
}

Gerar Boleto de Cancelamento

Endpoint: GET /efetivacao/cancelamento/boleto

Headers:

Header	Tipo	Descrição
`Authorization`	string	Bearer token JWT
`numeroContrato`	integer	Número do contrato

Enviar Boleto de Cancelamento por SMS

Endpoint: POST /cancelamento/boleto/envio-sms

Headers:

Header	Tipo	Descrição
`Authorization`	string	Bearer token JWT
`cpfCliente`	string	CPF do cliente

Corpo da Requisição:

{
  "ddd": "11",
  "celular": "987654321",
  "boleto": "boletoBase64String",
  "linhaDigitavel": "00190.00009 01234.567890 12345.678901 2 99990000500000"
}

Enviar Boleto de Cancelamento por E-mail

Endpoint: POST /cancelamento/boleto/envio-email

Corpo da Requisição:

{
  "email": "cliente@email.com",
  "boleto": "boletoBase64String",
  "linhaDigitavel": "00190.00009 01234.567890 12345.678901 2 99990000500000"
}

1️⃣2️⃣ Gerenciar Seguro

O seguro é opcional no empréstimo pessoal. Permite ao cliente cancelar o seguro contratado.

Verificar Elegibilidade para Cancelamento do Seguro

Endpoint: GET /seguro/cancelamento/elegibilidade

Headers:

Header	Tipo	Descrição
`Authorization`	string	Bearer token JWT
`numeroContrato`	integer	Número do contrato

Exemplo de Resposta:

{
  "podeCancelar": true,
  "possuiSeguro": true,
  "valorSeguroPago": 150.00,
  "valorDevolucao": 120.00,
  "prazoMaximo": "2025-12-17T23:59:59.000Z"
}

Consultar Valores do Cancelamento do Seguro

Endpoint: GET /seguro/cancelamento/valores

Headers:

Header	Tipo	Descrição
`Authorization`	string	Bearer token JWT
`numeroContrato`	integer	Número do contrato

Efetivar Cancelamento do Seguro

Endpoint: POST /seguro/cancelamento

Headers:

Header	Tipo	Descrição
`Authorization`	string	Bearer token JWT
`numeroContrato`	integer	Número do contrato

Exemplo de Resposta:

{
  "mensagem": "Seguro cancelado com sucesso",
  "valorDevolucao": 120.00,
  "formaDevolucao": "CREDITO_FATURA"
}

Consultar Seguro Cancelado

Endpoint: GET /seguro/consulta-cancelado

Headers:

Header	Tipo	Descrição
`Authorization`	string	Bearer token JWT
`numeroContrato`	integer	Número do contrato

Solicitar Transferência da Devolução do Seguro

Endpoint: POST /seguro/cancelamento/pedido-transferencia

Headers:

Header	Tipo	Descrição
`Authorization`	string	Bearer token JWT
`numeroContrato`	integer	Número do contrato

Corpo da Requisição:

{
  "banco": {
    "codigo": "001",
    "agencia": "1234",
    "conta": "123456",
    "dvConta": "7",
    "tipoConta": "CC"
  }
}

Consultar Pedido de Transferência

Endpoint: GET /seguro/cancelamento/consulta-pedido-transferencia

1️⃣3️⃣ Consultar Lista de Bancos

Retorna a lista de bancos disponíveis para transferência (TED/PIX).

Endpoint: GET /banco

Headers:

Header	Tipo	Descrição
`Authorization`	string	Bearer token JWT
`ativoSpb`	boolean	Filtrar apenas bancos ativos no SPB (default: false)

Exemplo de Requisição:

curl -X GET "https://app-bffepl-hml.credsystem.com.br/emprestimo-pessoal-lojista/api/v1/banco" \
  -H "Authorization: Bearer SEU_TOKEN_JWT" \
  -H "ativoSpb: true"

Exemplo de Resposta:

{
  "bancos": [
    {
      "codigo": "001",
      "nome": "Banco do Brasil",
      "ispb": "00000000",
      "ativoSpb": true
    },
    {
      "codigo": "104",
      "nome": "Caixa Econômica Federal",
      "ispb": "00360305",
      "ativoSpb": true
    },
    {
      "codigo": "237",
      "nome": "Bradesco",
      "ispb": "60746948",
      "ativoSpb": true
    }
  ]
}

1️⃣4️⃣ Verificar Agendamento de Transferência

Verifica se a transferência será agendada ou realizada na hora com base no banco e horário.

Endpoint: GET /transferencia-agendada

Headers:

Header	Tipo	Descrição
`Authorization`	string	Bearer token JWT
`codigoCompe`	string	Código COMPE do banco

Exemplo de Requisição:

curl -X GET "https://app-bffepl-hml.credsystem.com.br/emprestimo-pessoal-lojista/api/v1/transferencia-agendada" \
  -H "Authorization: Bearer SEU_TOKEN_JWT" \
  -H "codigoCompe: 001"

Exemplo de Resposta:

{
  "agendada": true,
  "dataPrevisao": "2025-12-04T10:00:00.000Z",
  "motivo": "Transferência fora do horário bancário"
}

1️⃣5️⃣ Gerenciar Agendamentos

Consulta e cancela agendamentos de empréstimos.

Consultar Agendamentos

Endpoint: GET /agendamento

Headers:

Header	Tipo	Descrição
`Authorization`	string	Bearer token JWT
`cpfCliente`	string	CPF do cliente

Exemplo de Resposta:

{
  "agendamentos": [
    {
      "idAgendamento": 12345,
      "numeroContrato": 987654321,
      "valor": 5000.00,
      "quantidadeParcelas": 12,
      "dataAgendamento": "2025-12-03T14:30:00.000Z",
      "dataPrevisaoTransferencia": "2025-12-04T10:00:00.000Z",
      "status": "AGENDADO"
    }
  ]
}

Cancelar Agendamento

Endpoint: POST /agendamento/cancelamento

Corpo da Requisição:

{
  "idAgendamento": 12345,
  "idCanal": 1
}

Exemplo de Resposta:

{
  "mensagem": "Agendamento cancelado com sucesso",
  "idAgendamento": 12345,
  "dataCancelamento": "2025-12-03T16:00:00.000Z"
}

🔄 Fluxo Completo de Empréstimo

Fluxo 1: Contratação de Empréstimo

Fluxo 2: Pagamento de Parcelas

Fluxo 3: Antecipação de Parcelas

📊 Códigos de Resposta

Código	Descrição	Ação
`200`	Sucesso	Operação realizada com sucesso
`400`	Requisição Inválida	Verificar parâmetros enviados
`401`	Não Autorizado	Verificar token de autenticação
`404`	Não Encontrado	Recurso não existe
`500`	Erro Interno	Contatar suporte técnico

💡 Boas Práticas

1. Simulação e Elegibilidade

Sempre faça a simulação antes da elegibilidade
Mostre ao cliente todas as opções de parcelamento
Deixe claro o valor da parcela e o custo total

2. Pré-Contrato

Apresente o pré-contrato de forma legível
Garanta que o cliente leu e entendeu os termos
Registre a data/hora do aceite corretamente

3. Dados Bancários

Valide os dados bancários antes de efetivar
Verifique se a conta está ativa e no nome do cliente
Alerte sobre transferências agendadas

4. Seguro

Apresente o seguro como opcional
Explique os benefícios de forma clara
Informe sobre a possibilidade de cancelamento

5. Comunicação

Envie comprovantes por SMS e e-mail
Mantenha o cliente informado sobre status
Disponibilize segunda via de boletos

🔒 Segurança

Informações Sensíveis

NUNCA armazene dados completos de cartão
Use sempre HTTPS em produção
Valide CPF e autenticação em todas as requisições
Registre logs de auditoria de todas as operações

🆘 Suporte

Para dúvidas ou problemas com a integração, entre em contato com a equipe de suporte técnico.

Versão da API: 1.0.1
Última atualização: Dezembro de 2025

🎯 Visão Geral​

🔐 Autenticação​

📚 Endpoints Disponíveis​

1️⃣ Simular Planos de Empréstimo​

2️⃣ Verificar Elegibilidade do Cliente​

3️⃣ Gerar Pré-Contrato​

4️⃣ Gerenciar Contas Bancárias do Cliente​

Consultar Contas​

Cadastrar Nova Conta​

5️⃣ Efetivar Empréstimo​

6️⃣ Consultar Empréstimos do Cliente​

7️⃣ Consultar Detalhes do Contrato​

8️⃣ Consultar Parcelas do Contrato​

9️⃣ Gerar Boleto de Parcela​

Enviar Boleto por SMS​

Enviar Boleto por E-mail​

🔟 Antecipar Parcelas​

Consultar Elegibilidade para Antecipação​

Consultar Parcelas para Antecipação​

Efetivar Antecipação​

Consultar Antecipação​

Cancelar Antecipação​

Enviar Boleto de Antecipação por SMS​

Enviar Boleto de Antecipação por E-mail​

1️⃣1️⃣ Cancelar Empréstimo​

Verificar Elegibilidade para Cancelamento​

Efetivar Cancelamento​

Gerar Boleto de Cancelamento​

Enviar Boleto de Cancelamento por SMS​

Enviar Boleto de Cancelamento por E-mail​

1️⃣2️⃣ Gerenciar Seguro​

Verificar Elegibilidade para Cancelamento do Seguro​

Consultar Valores do Cancelamento do Seguro​

Efetivar Cancelamento do Seguro​

Consultar Seguro Cancelado​

Solicitar Transferência da Devolução do Seguro​

Consultar Pedido de Transferência​

1️⃣3️⃣ Consultar Lista de Bancos​

1️⃣4️⃣ Verificar Agendamento de Transferência​

1️⃣5️⃣ Gerenciar Agendamentos​

Consultar Agendamentos​

Cancelar Agendamento​

🔄 Fluxo Completo de Empréstimo​

Fluxo 1: Contratação de Empréstimo​

Fluxo 2: Pagamento de Parcelas​

Fluxo 3: Antecipação de Parcelas​

📊 Códigos de Resposta​

💡 Boas Práticas​

1. Simulação e Elegibilidade​

2. Pré-Contrato​

3. Dados Bancários​

4. Seguro​

5. Comunicação​

🔒 Segurança​

🆘 Suporte​

🎯 Visão Geral

🔐 Autenticação

📚 Endpoints Disponíveis

1️⃣ Simular Planos de Empréstimo

2️⃣ Verificar Elegibilidade do Cliente

3️⃣ Gerar Pré-Contrato

4️⃣ Gerenciar Contas Bancárias do Cliente

Consultar Contas

Cadastrar Nova Conta

5️⃣ Efetivar Empréstimo

6️⃣ Consultar Empréstimos do Cliente

7️⃣ Consultar Detalhes do Contrato

8️⃣ Consultar Parcelas do Contrato

9️⃣ Gerar Boleto de Parcela

Enviar Boleto por SMS

Enviar Boleto por E-mail

🔟 Antecipar Parcelas

Consultar Elegibilidade para Antecipação

Consultar Parcelas para Antecipação

Efetivar Antecipação

Consultar Antecipação

Cancelar Antecipação

Enviar Boleto de Antecipação por SMS

Enviar Boleto de Antecipação por E-mail

1️⃣1️⃣ Cancelar Empréstimo

Verificar Elegibilidade para Cancelamento

Efetivar Cancelamento

Gerar Boleto de Cancelamento

Enviar Boleto de Cancelamento por SMS

Enviar Boleto de Cancelamento por E-mail

1️⃣2️⃣ Gerenciar Seguro

Verificar Elegibilidade para Cancelamento do Seguro

Consultar Valores do Cancelamento do Seguro

Efetivar Cancelamento do Seguro

Consultar Seguro Cancelado

Solicitar Transferência da Devolução do Seguro

Consultar Pedido de Transferência

1️⃣3️⃣ Consultar Lista de Bancos

1️⃣4️⃣ Verificar Agendamento de Transferência

1️⃣5️⃣ Gerenciar Agendamentos

Consultar Agendamentos

Cancelar Agendamento

🔄 Fluxo Completo de Empréstimo

Fluxo 1: Contratação de Empréstimo

Fluxo 2: Pagamento de Parcelas

Fluxo 3: Antecipação de Parcelas

📊 Códigos de Resposta

💡 Boas Práticas

1. Simulação e Elegibilidade

2. Pré-Contrato

3. Dados Bancários

4. Seguro

5. Comunicação

🔒 Segurança

🆘 Suporte