💰 APIs de Arrecadação
Bem-vindo à documentação de Arrecadação! Esta seção reúne os guias completos para integração com as APIs de arrecadação de títulos em estabelecimentos lojistas, incluindo pagamentos, consulta de faturas e resolução de problemas.
📚 Documentos Disponíveis
🏬 Arrecadação Lojista
API REST para arrecadação de títulos em estabelecimentos físicos. Permite realizar o ciclo completo de pagamento de extratos, carnês, acordos e empréstimos pessoais.
| Funcionalidade | Descrição |
|---|---|
| Consultar Títulos | Lista títulos disponíveis para pagamento do cliente |
| Pré-Autorização | Cria reserva de valor para o pagamento |
| QR Code PIX | Gera QR Code para pagamento instantâneo |
| Efetivar Pagamento | Confirma e processa o pagamento do título |
| Consultar Status | Verifica o andamento de um pagamento efetivado |
| Desfazimento | Estorna um pagamento realizado |
Estabelecimentos lojistas que recebem pagamentos de títulos, carnês e acordos no PDV.
📋 Consulta de Faturas
Endpoints para consultar faturas e transações detalhadas de um cliente.
| Funcionalidade | Descrição |
|---|---|
| Listar Faturas | Consulta as faturas disponíveis do cliente |
| Detalhe da Fatura | Obtém dados completos para pagamento (QR Code PIX, linha digitável) |
| Transações da Fatura | Lista débitos e créditos de uma fatura específica |
Consulta de histórico de pagamentos, exibição de faturas ao cliente e obtenção de dados para pagamento.
🔧 Troubleshooting
Guia de resolução de problemas para todos os endpoints de arrecadação.
- Erros comuns e suas causas
- Ações recomendadas por endpoint
- Códigos de retorno e mensagens de erro
🔄 Fluxos de Arrecadação
- 💳 Pagamento Tradicional
- 📱 Pagamento via PIX
- 📄 Consulta de Fatura
Pagamento de Título com Pré-Autorização
Pagamento de Título com QR Code PIX
Consulta e Pagamento de Fatura
🛡️ Segurança
| Recurso | Descrição |
|---|---|
| 🔑 Bearer Token (JWT) | Obrigatório em todos os endpoints |
| 📱 PIX | Pagamento instantâneo com QR Code gerado pela API |
| 🔢 NSU | Número Sequencial Único para rastreabilidade de transações |
URLs Base:
| Ambiente | URL |
|---|---|
| Homologação | https://apihml.credsystem.com.br/arrecadacao-lojista/api/v2 |
| Produção | https://api.credsystem.com.br/arrecadacao-lojista/api/v2 |