# Integração Credsystem — Introdução

<section class="capitulo" id="bkmrk-este-material-explic">Este material explica como o sistema ILLI se conecta à Credsystem para consultar faturas, receber pagamentos e operar o Totem de Pagamento Instantâneo nas lojas.

<nav aria-label="Índice do livro" class="indice">## Índice dos capítulos

**01 — Introdução** (esta página): o que é o sistema e palavras importantes  
**02 — Arquitetura**: como os módulos se conectam  
**03 — Instalação**: banco de dados e passos de instalação  
**04 — Configuração**: cadastro por loja/entidade  
**05 — Portal do operador**: tela de atendimento no balcão  
**06 — Fluxo de pagamento**: pagamento em dinheiro ou cartão  
**07 — Fluxo de Pagamento Instantâneo e Totem**: pagamento por Código de Resposta Rápida e autoatendimento  
**08 — Parcelamento e limite**: simulação e contratação de planos  
**09 — Estorno e regras**: desfazimento de pagamento  
**10 — Gestor no celular**: configuração de caixa e impressora  
**11 — Referência para Tecnologia da Informação**: endpoints, tabelas e auditoria

</nav><section class="para-todos">## Em linguagem simples

O sistema permite que a loja **consulte a fatura do cliente** pelo Cadastro de Pessoa Física, **receba o pagamento** (dinheiro, cartão ou Pagamento Instantâneo) e **registre tudo** no caixa e no histórico da loja.

Existem três formas principais de uso:

1. **Portal no computador** — o operador atende o cliente no balcão.
2. **Totem de Pagamento Instantâneo** — o cliente paga sozinho na tela de autoatendimento.
3. **Aplicativo Gestor no celular** — configura qual caixa e impressora cada funcionário usa.

Tudo isso conversa com os servidores da **Credsystem** (empresa do cartão/fatura) pela internet, de forma segura.

</section>![Visão geral do sistema](https://kb.illimitar.pro/uploads/images/gallery/2026-06/embedded-image-qtacawxx.png)

*Figura 1 — O ILLI fica no meio: recebe o pedido da loja, fala com a Credsystem e registra no caixa.*

## Glossário — palavras que você vai encontrar

<dl><dt>Cadastro de Pessoa Física</dt><dd>Número de identificação do cliente. É usado para buscar a fatura dele.</dd><dt>Extrato / Fatura</dt><dd>Conta que o cliente precisa pagar. Pode ter valor total, valor mínimo ou parcelas.</dd><dt>Entidade / Loja</dt><dd>Cada unidade de negócio cadastrada no ILLI. Cada loja tem sua própria configuração.</dd><dt>Caixa</dt><dd>O ponto de venda onde o operador trabalha. O pagamento pode gerar uma entrada de dinheiro no caixa.</dd><dt>Pré-autorização</dt><dd>Passo em que a Credsystem *reserva* o pagamento antes de confirmar de vez. É como "segurar" o valor.</dd><dt>Efetivação</dt><dd>Confirmação final do pagamento na Credsystem.</dd><dt>Estorno / Desfazimento</dt><dd>Cancelar um pagamento que já foi feito. Só é permitido em alguns casos e dentro de um prazo.</dd><dt>Pagamento Instantâneo</dt><dd>Forma de pagamento instantânea pelo celular, usando Código de Resposta Rápida.</dd><dt>Totem</dt><dd>Tela de autoatendimento na loja, onde o cliente paga sozinho pelo Pagamento Instantâneo.</dd><dt>Integrador</dt><dd>Banco de dados auxiliar que guarda histórico de clientes, pagamentos e avaliações do totem.</dd><dt>Ponto de Venda</dt><dd>Sistema de ponto de venda do ILLI. Registra entradas e saídas de dinheiro no caixa.</dd></dl><section class="para-ti">## Detalhes para Tecnologia da Informação

O diretório `bibliotecas/` contém 4 módulos independentes escritos em Pré-processador de Hipertexto, cada um identificado por Identificador Universal Único:

<table><thead><tr><th>Identificador Universal Único</th><th>Classe</th><th>Função</th></tr></thead><tbody><tr><td>`981bfb94-…`</td><td>`api_integracao_credsystem`</td><td>Cliente de Transferência Representacional de Estado/Autorização Aberta Credsystem</td></tr><tr><td>`88e14c87-…`</td><td>`api_integracao_credsystem_pagamento_total`</td><td>Portal, totem, Ponto de Venda, banco integrador</td></tr><tr><td>`857e21c5-…`</td><td>`credsystem_gestor_configuracoes`</td><td>Config caixa/impressora por usuário</td></tr><tr><td>`f3d67c71-…`</td><td>`configCredsystem`</td><td>Tela legada (substituída pela Quasar em `981bfb94`)</td></tr></tbody></table>

Dependência compartilhada: `util.php` (`12262a22-30ab-11e9-bb4c-127101af6b0d`).

Documentação focada nos módulos atuais; legado Protocolo Simples de Acesso a Objetos em `v1/credsystem` não é coberto neste livro.

</section></section>