Especificação Técnica de integração com a Automação Comercial via troca de arquivos.
Versão: 1.0
Propriedade: Acqio.
Histórico versão
| Versão | Data | Responsável | Descrição da alteração |
|---|---|---|---|
| 1.0 | 2020-02-06 | Cesar Searlini | Criação do documento |
| 2.0 | 2021-08-12 | Fernando Goia | Troca do nome "Acqio Tef" para "Acqio Mais" + Revisões no texto |
Resumo
Este documento tem como objetivo a especificação técnica para integração de uma Automação com o software de captura de pagamentos denominado neste documento como “Acqio Mais”.
O Acqio Mais é uma ferramenta dedicada e responsável pela captura dos dados essenciais para realização uma transação eletrônica de fundos, com operações através das opções de crédito, débito e voucher.
A criação deste documento tem como base “Guia Técnico da Solução TEF Discado”.
Avisos
As informações contidas neste material estão sujeitas a alterações em aviso prévio.
Glossário
Bandeira: Empresas que definem um padrão internacional de intercâmbio e troca de informações
entre as redes de adquirentes ex: Visa, Elo e MasterCard.
Checkout: Terminal caixa também conhecido como PDV, software de cobrança e gestão de
mercadorias de um estabelecimento comercial.
TEF: (Transação eletrônica de fundos) Termo utilizado nos sistema de processamentos de
transação financeira eletrônica.
Pinpad: Equipamento certificado responsável pela leitura de cartões via tecnologia Contactless,
Chip e Tarja Magnetica.
Informações técnicas
O Acqio Mais foi desenvolvido para utilização em ambientes Windows, ele possui duas interfaces de integração:
-
API REST JSON: para mais informações sobre esta forma de integração você pode obter a documentação através do link http://localhost:12030/ .
-
Gerenciador Padrão também conhecido como “TEF-DIAL” ou Integração por Troca de arquivos, o qual será abordado neste documento.
Diretórios de troca de arquivos
A interação via gerenciador padrão segue um fluxo de etapas de troca de arquivos entre a Automação e o Acqio
Mais.
Independentemente do diretório, é de extrema importância que exista um fluxo de requisição e resposta.
Regras de uso
Por padrão utilizaremos os nomes Req/Resp.
-
Req: Local de gravação de arquivos gerados pela Automação Comercial, e manipulação de leitura e delete do Acqio Mais.
-
Resp: Local destinado para gravação de arquivos gerados pelo Acqio Mais, e manipulação de leitura e delete da Automação Comercial.
Os diretórios que são utilizados para esta integração podem ser personalizados através de interface gráfica da ferramenta através da Aba [Arquivo -> Configurações -> TEF-DIAL]:
Nota importante: A integração deve ser feita 1 para 1, cada CHECKOUT
solicitante de uma transação TEF deve se comunicar apenas com 1 único Acqio Mais, sendo assim em uma rede de
estabelecimento com mais de um CHECKOUT deve ser implementado individualmente um Acqio Mais
para cada CHECKOUT.
A resposta da operação pode seguir conforme o tipo de layout selecionado utilizados, “SE” ou “PG”, cada layout
possui um template distinto. Confira a diferença dos comando no sessão (Montagem do arquivo => Arquivo de
Resposta (Resp\intpos.001 )
Fluxo de uma transação
O diagrama abaixo ilustra uma sequencia de troca de arquivos, durante uma transação de venda bem sucedida
Montagem do arquivo
Arquivo de solicitação (Req\intpos.001)
| Código | Nome | ATV | CRT | ADM | CNC | CNF | NCN |
|---|---|---|---|---|---|---|---|
| 000-000 | Comando | M | M | M | M | M | M |
| 001-000 | Identificação | M | M | M | M | M | M |
| 002-000 | Documento fiscal | - | O | O | O | O | O |
| 003-000 | Valor total | - | M | - | O | - | - |
| 004-000 | Moeda | - | O | - | O | - | - |
| 006-000 | Tipo Cliente | - | O | O | O | - | - |
| 007-000 | Documento Cliente (CPF/CNPJ) | - | O | O | O | - | - |
| 010-000 | Rede do Adquirente | - | O | O | O | O | O |
| 012-000 | NSU | - | - | - | M | - | - |
| 022-000 | Data da transação/Comprovante | - | - | - | O | - | - |
| 023-000 | Hora da transação/Comprovante | - | - | - | O | - | - |
| 027-000 | Código de controle | - | - | - | - | M | M |
| 701-000 | Versão da Automação | - | O | O | O | - | - |
| 702-000 | Código do Estabelecimento | - | O | O | O | 0 | 0 |
| 716-000 | Empresa de automação | - | M | M | M | - | - |
| 999-999 | Registro finalizador | M | M | M | M | M | M |
Arquivo de status (Resp\intpos.sts)
| Código | Nome | ATV | CRT | ADM | CNC | CNF | NCN |
|---|---|---|---|---|---|---|---|
| 000-000 | Comando | ME | ME | ME | ME | ME | ME |
| 001-000 | Identificação | ME | ME | ME | ME | ME | ME |
| 999-999 | Registro finalizador | M | M | M | M | M | M |
Arquivo de Resposta (Resp\intpos.001)
Layout SE
| Código | Nome | ATV | CRT | ADM | CNC | CNF | NCN |
|---|---|---|---|---|---|---|---|
| 000-000 | Comando | M | M | M | M | M | M |
| 001-000 | Identificação | M | M | M | M | M | M |
| 002-000 | Documento fiscal | - | O | O | O | O | O |
| 003-000 | Valor total | - | M | - | O | - | - |
| 004-000 | Moeda | - | O | - | O | - | - |
| 009-000 | Status | - | O | O | O | - | - |
| 010-000 | Bandeira | - | O | O | O | - | - |
| 010-001 | Rede adquirente | - | O | O | O | - | - |
| 010-003 | Codigo da bandeira | - | O | O | O | - | - |
| 010-004 | Bin cartão | - | O | O | O | - | - |
| 011-000 | Tipo da Transação | - | O | O | O | - | - |
| 012-000 | NSU | - | - | - | M | - | - |
| 013-000 | Código Autorizador | - | O | O | M | M | - |
| 017-000 | Tipo do Parcelamento | - | O | O | - | - | - |
| 018-000 | Quantida de parcelas | - | O | O | - | - | - |
| 022-000 | Data da transação/Comprovante | - | - | - | O | - | - |
| 023-000 | Hora da transação/Comprovante | - | - | - | O | - | - |
| 023-000 | NSU Original | - | - | O | O | - | - |
| 026-000 | Data Hora Rede Adquirente | - | - | O | O | - | - |
| 027-000 | Código de controle | - | - | - | - | M | - |
| 028-000 | Tamanho da via | - | M | M | M | M | - |
| 029-xxx | Via unica comprovante | - | M | M | M | M | - |
| 030-000 | Mensagem do operador | - | M | M | M | M | - |
| 301-001 | Validade do cartão | - | M | M | M | M | - |
| 300-002 | Nome do portador do cartão | - | M | M | M | M | - |
| 719-000 | Codigo do estabelecimento | - | M | M | M | M | - |
| 022-000 | Data da transação/Comprovante | - | - | - | O | - | - |
| 023-000 | Hora da transação/Comprovante | - | - | - | O | - | - |
| 027-000 | Código de controle | - | - | - | - | M | M |
| 701-000 | Versão da Automação | - | O | O | O | - | - |
| 702-000 | Código do Estabelecimento | - | O | O | O | 0 | 0 |
| 716-000 | Empresa de automação | - | M | M | M | - | - |
| 999-999 | Registro finalizador | M | M | M | M | M | M |
Layout PG
| Código | Nome | ATV | CRT | ADM | CNC | CNF | NCN |
|---|---|---|---|---|---|---|---|
| 000-000 | Comando | M | M | M | M | M | M |
| 001-000 | Identificação | M | M | M | M | M | M |
| 002-000 | Documento fiscal | - | O | O | O | O | O |
| 003-000 | Valor total | - | M | - | O | - | - |
| 004-000 | Moeda | - | O | - | O | - | - |
| 009-000 | Status | - | O | O | O | - | - |
| 010-000 | Rede adquirente | - | O | O | O | - | - |
| 011-000 | Tipo da Transação | - | O | O | O | - | - |
| 012-000 | NSU | - | - | - | M | - | - |
| 013-000 | Código Autorizador | - | O | O | M | M | - |
| 017-000 | Tipo do Parcelamento | - | O | O | - | - | - |
| 018-000 | Quantida de parcelas | - | O | O | - | - | - |
| 022-000 | Data da transação/Comprovante | - | - | - | O | - | - |
| 023-000 | Hora da transação/Comprovante | - | - | - | O | - | - |
| 023-000 | NSU Original | - | - | O | O | - | - |
| 026-000 | Data Hora Rede Adquirente | - | - | O | O | - | - |
| 027-000 | Código de controle | - | - | - | - | M | - |
| 028-000 | Tamanho da via | - | M | M | M | M | - |
| 029-xxx | Via unica comprovante | - | M | M | M | M | - |
| 030-000 | Mensagem do operador | - | M | M | M | M | - |
| 040-000 | Bandeira | - | O | O | O | - | - |
| 701-000 | Versão da Automação | - | O | O | O | - | - |
| 702-000 | Código do Estabelecimento | - | O | O | O | 0 | 0 |
| 710-000 | Tamanho cupom reduzido | - | O | O | O | - | - |
| 711-xxx | Cupom reduzido | - | O | O | O | - | - |
| 712-000 | Tamanho via Cliente | - | O | O | O | - | - |
| 713-xxx | Via Cliente do comprovante | - | O | O | O | - | - |
| 714-000 | Tamanho via Estabelecimento | - | O | O | O | - | - |
| 715-xxx | Via Estabelecimento/Comprovante | - | O | O | O | - | - |
| 716-000 | Empresa de automação | - | M | M | M | - | - |
| 718-000 | Número lógico do terminal | - | O | O | O | - | - |
| 737-000 | Quantidade de Vias/Comprovante | - | O | O | O | - | - |
| 999-999 | Registro finalizador | M | M | M | M | M | M |