💵 API de Empréstimo Pessoal Lojista
Bem-vindo à documentação de Empréstimo Pessoal! Esta seção reúne os guias completos para integração com a API de empréstimo pessoal em estabelecimentos lojistas, incluindo contratação, gestão de contratos e resolução de problemas.
📚 Documentos Disponíveis
🏬 Empréstimo Pessoal Lojista
API REST para contratação e gestão de empréstimos pessoais em estabelecimentos físicos. Permite realizar o ciclo completo desde a elegibilidade até a consulta de parcelas e contratos.
| Funcionalidade | Descrição |
|---|---|
| Verificar Elegibilidade | Verifica se o cliente pode contratar empréstimo |
| Simular Planos | Retorna opções de parcelamento com taxas e CET |
| Gerenciar Contas | Consulta e registra contas bancárias do cliente |
| Consultar Bancos | Lista bancos habilitados para transferência |
| Gerar Pré-Contrato | Gera documento com condições para aceite |
| Efetivar Empréstimo | Confirma contratação e agenda transferência |
| Consultar Agendamentos | Lista e cancela agendamentos pendentes |
| Consultar Parcelas | Lista parcelas com status de pagamento |
| Consultar Contrato | Obtém PDF do contrato efetivado |
Estabelecimentos lojistas que oferecem crédito pessoal aos clientes no PDV, com transferência via TED/PIX para conta bancária do cliente.
🔧 Troubleshooting
Guia de resolução de problemas para todos os endpoints de empréstimo pessoal.
- Erros comuns e suas causas
- Ações recomendadas por endpoint
- Códigos de retorno e mensagens de erro
🔄 Fluxo de Contratação
- 💳 Contratação Completa
- 📋 Gestão de Contratos
- 📅 Agendamentos
Fluxo completo de contratação de empréstimo pessoal
Consulta de contratos, parcelas e agendamentos
Consulta e cancelamento de agendamentos
🛡️ Segurança
| Recurso | Descrição |
|---|---|
| 🔑 Bearer Token (JWT) | Obrigatório em todos os endpoints |
| 🔒 HTTPS/TLS 1.2+ | Todas as requisições devem usar HTTPS |
| 📋 CPF no Header | Identificação do cliente via header cpfCliente |
URLs Base:
| Ambiente | URL |
|---|---|
| Homologação | https://apihml.credsystem.com.br/emprestimo-pessoal-lojista/api/v1 |
| Produção | https://api.credsystem.com.br/emprestimo-pessoal-lojista/api/v1 |
📊 Resumo dos Endpoints
| Método | Endpoint | Tag | Descrição |
|---|---|---|---|
POST | /elegibilidade | Elegibilidade | Verifica elegibilidade do cliente |
GET | /simulacao-plano | Simulação | Retorna planos disponíveis |
GET | /banco | Bancos | Lista bancos habilitados |
GET | /conta | Contas | Lista contas do cliente |
POST | /conta | Contas | Registra nova conta |
GET | /precontrato | Pré-Contrato | Gera pré-contrato (PDF) |
GET | /efetivacao | Efetivação | Lista empréstimos do cliente |
POST | /efetivacao | Efetivação | Efetiva empréstimo |
GET | /agendamento | Agendamentos | Lista agendamentos |
POST | /agendamento/cancelamento | Agendamentos | Cancela agendamento |
GET | /parcela | Parcelas | Lista parcelas do contrato |
GET | /contrato | Contrato | Retorna PDF do contrato |
Para detalhes técnicos completos (schemas, exemplos de payload, tipos de dados), consulte a Especificação OpenAPI.