> For the complete documentation index, see [llms.txt](https://ajuda.consistem.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ajuda.consistem.com.br/consistem-integracoes/areas-de-negocio/comercial/auttar.md).

# Auttar

### Visão Geral

Esta integração realiza a comunicação online entre o Consistem ERP e a plataforma Auttar (uma empresa Getnet). A Auttar atua como o gateway de Transferência Eletrônica de Fundos (TEF) e provedora dos serviços de conciliação das vendas.

O objetivo principal é unificar e gerenciar múltiplas formas de pagamento (cartão, Pix, dinheiro e créditos de clientes) vinculadas a um ou mais pedidos sob um código único de pagamento gerencial. Essa arquitetura garante que o faturamento de pedidos vinculados ocorra em conjunto e que os valores informados zerem perfeitamente o saldo devedor, mitigando erros operacionais e trazendo maior controle financeiro.

### Requisitos

<table><thead><tr><th width="474">Consistem ERP</th><th>Auttar</th></tr></thead><tbody><tr><td><p><strong>Compatibilidade:</strong> 7.5 ou superiores do Consistem ERP.</p><p><strong>Módulos:</strong> Comercial, Financeiro, Estoque e Itens.</p><p><strong>Licença:</strong> <a href="https://movidesk.consistem.com.br/form/5801/">Aquisição de licença</a> <strong>IMC</strong> ativa junto à Consistem.</p><p>Orientamos o acompanhamento da nossa equipe de consultores.</p></td><td>Aquisição de licença e implantação deve ser verificada com a empresa fornecedora.<br><a href="https://auttar.com.br/">Saiba mais</a></td></tr><tr><td><strong>Segurança:</strong> O usuário do caixa deve estar configurado com um API Token gerado no <a href="/spaces/0E9n0hpwK2TzblZSHb8i/pages/jVOmpcaktNxEB2BurMjf">Cadastro de Usuário (CSMEN050)</a> para a devida autenticação da comunicação via WebSocket.</td><td><strong>Software de Comunicação (CTF Client):</strong> Instalação e configuração obrigatória do aplicativo <em>CTF client</em> localmente no computador ao qual a maquininha física (Pin-pad) está conectada.</td></tr><tr><td></td><td><strong>Infraestrutura Local:</strong> Dependência de rede local estável e IP devidamente configurado. Caso o cliente utilize <em>hostname</em>, o Consistem ERP realiza a tratativa interna para considerar o número de IP da máquina durante o fluxo. Vale ressaltar que erros de rede local ou servidores fora do ar são de total responsabilidade do cliente.</td></tr></tbody></table>

### Configuração da integração

**No Consistem ERP:**

1. **Definição de Regras Gerais:** Acesse o programa [Configuração de Dados de Pagamento (CCCCP000)](/financeiro/manuais-de-telas/financeiro-contas-a-receber/configuracao-de-pagamento-do-contas-a-receber/configuracao-de-dados-de-pagamento.md) para definir os tipos de nota fiscal e as condições de venda que disparam a tela de pagamentos, além de cadastrar a senha mestra utilizada para exclusões manuais de emergência.<br>

   <figure><img src="/files/8Ht4YddAYOnjrEEXPIGz" alt=""><figcaption></figcaption></figure>
2. **Mapeamento Financeiro:** No programa [Configuração de Dados de Recebimento / Conciliação - Operações de Cartão (CCCCP010)](/financeiro/manuais-de-telas/financeiro-contas-a-receber/conciliacao-de-operacoes-de-cartao/configuracao-de-dados-de-recebimento--conciliacao-operacoes-de-cartao.md), realize o mapeamento do portador e do tipo de cobrança específicos para cada modalidade do cartão (como Débito, Crédito à Vista, Parcelado, entre outros).<br>

   <figure><img src="/files/kBXj8I1jIrFh2YbcrF8O" alt=""><figcaption></figcaption></figure>
3. **Parametrização de Rede:** Na tela de [Integração WebSocket (CSWMEN025)](/componentes/manuais-de-telas/cadastros-gerais-de-componentes/integracao-websocket.md), configure a estação de trabalho informando o *hostname* ou IP local da máquina, definindo a porta padrão de escuta da Auttar como *2500*.<br>

   <figure><img src="/files/wMmEiTW4wHfsOuj2Krv4" alt=""><figcaption></figcaption></figure>
4. **Geração de Chave de Segurança:** No programa [Cadastro de Usuário (CSMEN050)](/componentes/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-usuario.md), acesse a [Aba Segurança (CSMEN050TAB4)](/componentes/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-usuario/aba-seguranca.md) para efetuar a geração do Token de API que validará as requisições de comunicação.<br>

   <figure><img src="/files/RG9QCYDZI6Lpc0ZR75Oz" alt=""><figcaption></figcaption></figure>

**No Auttar:**

1. **Instalação do CTF Client:** Garanta que o agente local esteja instalado e em execução na bandeja do sistema operacional da máquina operadora.
2. **Parametrização de Porta:** Certifique-se de que o cliente TEF local esteja alinhado para operar na porta de comunicação *2500* (padrão utilizado pela Auttar).
3. **Pareamento do Hardware:** Confirme que o Pin-pad físico está configurado, conectado e respondendo perfeitamente às chamadas do aplicativo cliente.

### Como a integração funciona

A comunicação técnica baseia-se no protocolo bidirecional WebSocket. Sempre que uma transação eletrônica é iniciada no ERP, o sistema envia uma requisição estruturada (*Request*) para o agente *CTF client* local.

#### O que a Consistem Envia (Leiaute de Envio)

A comunicação parte do ERP para a Auttar seguindo os parâmetros mapeados na estrutura do sistema:

* **Token de Autenticação:** Chave de segurança exclusiva do usuário do caixa.
* **Tipo de Operação (Operação Cartão):** Identificador técnico da transação (Débito, Crédito à Vista, Crédito Parcelado Loja, Crédito Parcelado Administradora ou Pix).
* **Valor da Operadora:** O valor de face exato a ser cobrado na maquininha.
* **Número de Parcelas:** Quantidade de divisões acordadas para a venda.

O *CTF client* processa essa requisição, gerencia as mensagens no hardware (Pin-pad) para a captura dos dadose digitação da senha pelo cliente, e envia as informações criptografadas aos servidores da Getnet. Após a devida autorização da operadora, a Auttar devolve uma resposta (*Response*) via WebSocket para o Consistem ERP.

#### O que a Consistem Recebe (Leiaute de Retorno)

* **Status da Transação:** Confirmação do sucesso da operação (*Aprovada*).
* **NSU do Cartão / NSU Autorizadora:** Códigos únicos que identificam a transação no ambiente financeiro.
* **Bandeira da Operadora:** A marca descritiva do cartão utilizado (Ex: Mastercard, Visa).
* **Instituição Pagadora:** Identificação da adquirente responsável pelo repasse financeiro.

Com o retorno positivo da resposta, o sistema grava essas variáveis de controle no banco de dados e projeta as parcelas diretamente no Grid do ERP, calculando de forma automática todos os vencimentos futuros.

### Fluxo do processo

O fluxo operacional de trabalho de ponta a ponta obedece aos seguintes passos sequenciais de negócio:

1. **Origem na Geração de Dados de Pagamento:**
   1. **Pelo Menu:** Através da tela [Dados de Pagamento (CCCCP100)](/financeiro/manuais-de-telas/financeiro-contas-a-receber/dados-de-pagamento-do-contas-a-receber/dados-de-pagamento.md), o usuário insere as formas de pagamento antes de faturar (bloqueando o pedido para alterações subsequentes).
   2. **Na Seleção para Faturamento:** O programa [Geração de Dados de Pagamento - Sequência de Pagamento (CCCCP100B)](/financeiro/manuais-de-telas/financeiro-contas-a-receber/dados-de-pagamento-do-contas-a-receber/geracao-de-dados-de-pagamento-sequencia-de-pagamento.md) abre obrigatoriamente na etapa final do faturamento. O sistema possui uma trava de segurança que exige que o valor informado zere perfeitamente o saldo devedor; não é possível prosseguir se houver divergências.
2. **Processamento da Operação:** O operador seleciona a opção *TEF*, preenche os dados e clica em **Salvar**, disparando a comunicação com a máquina física.
3. **Cancelamentos e Exclusões:**
   1. **Fluxo Padrão:** Para cancelar uma venda confirmada, o cartão deve ser passado novamente na máquina para processar o estorno junto à Auttar.
   2. **Exclusão de Emergência:** Caso o sistema trave ou perca comunicação com a Auttar, existe um botão de exclusão manual mediante senha. Os dados são limpos no Consistem ERP, mas o lojista assume a responsabilidade de realizar o estorno manual no portal da operadora.
4. **Fechamento e Impressão:** Confirmados os valores, o sistema encerra a venda e dispara a impressão física do comprovante (vias do cliente e estabelecimento) por meio da impressora configurada localmente.
5. **Faturamento e Cálculo de Taxas:** Ao gerar a Nota Fiscal, o sistema gera os títulos no Contas a Receber executando uma baixa parcial automática correspondente à taxa administrativa do cartão configurada.
6. **Módulo de Conciliação Financeira:**
   1. [Importação do Arquivo de Conciliação (CCCCP105)](/financeiro/manuais-de-telas/financeiro-contas-a-receber/conciliacao-de-operacoes-de-cartao/importacao-do-arquivo-de-conciliacao.md): O financeiro realiza a importação do arquivo eletrônico de conciliação disponibilizado pelas administradoras.
   2. [Conciliação de Operações com Cartão (CCCCP110)](/financeiro/manuais-de-telas/financeiro-contas-a-receber/conciliacao-de-operacoes-de-cartao/conciliacao-de-operacoes-com-cartao.md): O programa confronta os NSUs armazenados nos títulos com os registros do arquivo, realizando a baixa líquida definitiva conforme a conciliação.
   3. [Consulta de Conciliação de Operações com Cartão (CCCCP610)](/financeiro/manuais-de-telas/financeiro-contas-a-receber/conciliacao-de-operacoes-de-cartao/consulta-de-conciliacao-de-operacoes-com-cartao.md): Permite a auditoria completa das transações conciliadas e eventuais pendências.

<p align="center">Esse conteúdo foi útil?</p>

<p align="center"><a href="https://movidesk.consistem.com.br/form/10395/" class="button primary" data-icon="thumbs-up">Sim</a> <a href="https://movidesk.consistem.com.br/form/10395/" class="button primary" data-icon="thumbs-down">Não</a></p>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ajuda.consistem.com.br/consistem-integracoes/areas-de-negocio/comercial/auttar.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
