Introdução:
As descrições aqui apresentadas exibem o formato que devem ter as mensagens geradas pela Automação Comercial, bem como o formato da mensagem de retorno gerada pelo modelo de integração troca de arquivos, com a confirmação ou não da transação.
As mensagens serão transferidas por meio de arquivo tipo texto onde cada linha contém um tipo de informação. As linhas possuem formato padrão e tamanho variável, utilizando conceito de palavra chave. O formato genérico é:
AAA-BBBC=CDDDDDDD......DDDDDEF
Onde:
Identificação | Descrição |
---|---|
A | Identificação do tipo de informação ou campo |
B | Nº de seqüência complementar ao tipo de informação ou campo |
C | Posição contendo espaço ou branco |
D | Informação (sempre alinhada a esquerda, sem preenchimento de zeros ou espaços) |
E | Carriage Return (CR) =13 (segundo a tabela ASCII) |
F | Line Feed (LF) = 10 (segundo a tabela ASCII) |
Os tipos possíveis são:
Tipo de Operação | Descrição |
---|---|
ATV | Verifica se a aplicação de gerenciamento da troca de arquivos está ativa |
ADM | Permite o acionamento da Troca de arquivos para execução das funções administrativas |
CHQ* | Pedido de autorização para transação por meio de cheque |
CRT | Pedido de autorização para transação por meio de cartão |
CNC | Cancelamento de venda efetuada por qualquer meio de pagamento |
CNF | Confirmação da venda e impressão de cupom |
NCN | Não confirmação da venda e/ou da impressão. |
Verificação pela Automação Comercial se o Gerenciador está ativo deve ser feita através:
Função ATV:
A Automação Comercial envia as mensagens ao Gerenciador conforme Tabela de campos gerados pela automação comercial, apresentada abaixo.
Se a Automação Comercial receber em até 7 segundos o arquivo C:\TEF_DIAL\RESP\IntPos.Sts conforme Tabela de repostas, significa que o Gerenciador está ativo e a integração via troca de arquivos está disponivel.
Importante:
Toda vez que o Gerenciador Padrão entrar no ar irá informar para a Automação Comercial que está ativo através do arquivo Ativo.001 que será gravado no diretório \Tef_dial\resp , com os campos:
‘000-000 = TEF’
‘016-000 = DDMMHHMMSS’ (Timestamp)
‘999-999 = 0’
Se não existir este arquivo no diretório significa que o Gerenciador não está ativo e não será possível integrar via troca de arquivos.
O cancelamento de venda pode ser feito de duas formas:
- Pela operação ADM, onde o Gerenciador abre uma tela para a captura dos dados
da transação a ser cancelada. - Pela operação CNC, onde o Aplicativo de Automação Comercial captura os dados da
transação a ser cancelada e as transfere para o Gerenciador.
A seguir apresentamos os tipos de informações (ou campos) que deverão estar presentes nos arquivos enviados e recebidos pela Automação Comercial. As informações (ou campos) variam de acordo com o tipo de operação e estão assinalados com ‘M’ quando mandatórios, ‘O’ quando opcionais e ‘-‘ quando ausentes.
Notar que o aplicativo de automação deve estar preparado para receber e ignorar os tipos de registros que ele desconheça. Essa característica é importante para manter compatibilidade com versões futuras.
Quando houver discrepância entre o conteúdo do campo enviado pelo Aplicativo de Automação Comercial e o recebido pelo Gerenciador valerá o do Troca de Arquivos.
Legenda para as seguintes tabelas:
Identificação | Descrição |
---|---|
M | Mandatório |
O | Opcional |
E | Eco da solicitação |
A | Para transação aprovada |
- | Ausente / Não |
Campos presentes na mensageria gerada pela automação comercial
Essas solicitações são vinculadas ao diretório: C:\TEF_DIAL\REQ\IntPos.001
Código do Campo | Tipo de informação | ATV | ADM | CHQ | CRT | CNC | CNF | NCN | PAG |
---|---|---|---|---|---|---|---|---|---|
000-000 | HEADER | M | M | M | M | M | M | M | - |
001-000 | IDENTIFICAÇÃO | M | M | M | M | M | M | M | - |
002-000 | DOCUMENTO FISCAL VINCULADO | - | - | O | O | O | O | O | - |
003-000 | VALOR TOTAL | - | - | M | M | M | - | - | - |
004-000 | MOEDA | - | - | - | O | - | - | - | - |
005-000 | CMC-7 | - | - | O | - | O (1) | - | - | - |
006-000 | TIPO DE PESSOA | - | - | O | - | O (1) | - | - | - |
007-000 | DOCUMENTO DA PESSOA | - | - | O | - | O (1) | - | - | - |
008-000 | DATA DO CHEQUE | - | - | O | - | O (1) | - | - | - |
010-000 | NOME DA REDE | - | - | - | - | M | M | M | - |
012-000 | NÚMERO DE TRANSAÇÃO - NSU | - | - | - | - | M | M | M | - |
022-000 | DATA DA TRANSAÇÃO - COMPROVANTE | - | - | - | - | M | - | - | - |
023-000 | HORA DA TRANSAÇÃO - COMPROVANTE | - | - | - | - | M | - | - | - |
027-000 | FINALIZAÇÃO | - | - | - | - | - | M | M | - |
033-000 | BANCO | - | - | O | - | O (1) | - | - | - |
034-000 | AGÊNCIA | - | - | O | - | O (1) | - | - | - |
035-000 | AGÊNCIA - DC | - | - | O | - | O (1) | - | - | - |
036-000 | CONTA CORRENTE | - | - | O | - | O (1) | - | - | - |
037-000 | CONTA CORRENTE - DC | - | - | O | - | O (1) | - | - | - |
038-000 | NÚMERO DO CHEQUE | - | - | O | - | O (1) | - | - | - |
039-000 | NÚMERO DO CHEQUE - DC | - | - | O | - | O (1) | - | - | - |
800-000 | INDICADOR DA OPERAÇÃO | - | OE | O | - | O (1) | - | - | OE |
999-999 | TRAILER - REGISTRO FINAL | M | M | M | M | M | M | M | - |
Campos presentes na mensageria gerada pelo Geraciador - Status
Essas solicitações são vinculadas ao diretório: C:\TEF_DIAL\RESP \IntPos.Sts
Código do Campo | Tipo de informação | ATV | ADM | CHQ | CRT | CNC | CNF | NCN |
---|---|---|---|---|---|---|---|---|
000-000 | HEADER | M | M | M | M | M | M | M |
001-000 | IDENTIFICAÇÃO | M | M | M | M | M | M | M |
999-999 | TRAILER - REGISTRO FINAL | M | M | M | M | M | M | M |
Campos presentes na mensageria gerada pelo Geraciador - Respostas
Essas solicitações são vinculadas ao diretório: C:\TEF_DIAL\RESP \IntPos.001
Legendas:
(1)- somente existem se a transação foi aprovada.
(2)- devolve, opcionalmente, qual o cheque foi cancelado, desde que o módulo TEF permita cancelamentos.
(3)- Somente estarão preenchidos se a informação for preenchida no arquivo de envio correspondente.
(4)- Somente estarão preenchidos quando o campo CMC7 é ausente.
(*) O campo 028-000 QUANTIDADE DE LINHAS DO COMPROVANTE está como obrigatório para todas as operações por uma medida de segurança para o Aplicativo de Automação Comercial. O Gerenciador preencherá este campo com zero “0” quando não houver comprovante.
Código do Campo | Tipo de informação | ATV | ADM | CHQ | CRT | CNC | PAG |
---|---|---|---|---|---|---|---|
000-000 | HEADER | - | M | M | M | M | M |
001-000 | IDENTIFICAÇÃO | - | M | M | M | M | - |
002-000 | DOCUMENTO FISCAL VINCULADO | - | O | O(3) | O(3) | O(3) | - |
003-000 | VALOR TOTAL | - | O | M | M | M | - |
004-000 | MOEDA | - | O | - | M(3) | M(3) | - |
005-000 | CMC-7 | - | O | M(3) | - | O(2) | - |
006-000 | TIPO DE PESSOA | - | - | M | - | - | - |
007-000 | DOCUMENTO DA PESSOA | - | - | M | - | - | - |
008-000 | DATA DO CHEQUE | - | - | M | - | - | - |
009-000 | STATUS DA TRANSAÇÃO | - | M | M | M | M | - |
010-000 | NOME DA REDE | - | M | M | M | M | - |
011-000 | TIPO DA TRANSAÇÃO | - | M | M | M | M | - |
012-000 | NÚMERO DA TRANSAÇÃO - NSU | - | O | M(1) | M(1) | M(1) | - |
013-000 | CÓDIGO DE AUTORIZAÇÃO DA TRANSAÇÃO | - | O | O | O | O | - |
014-000 | NÚMERO DO LOTE DA TRANSAÇÃO | - | O | - | O | O | - |
015-000 | TIMESTAMP DA TRANSAÇÃO - HOST | - | O | M(1) | M(1) | M(1) | - |
016-000 | TIMESTAMP DA TRANSAÇÃO - LOCAL | - | O | O | O | O | - |
017-000 | TIPO PARCELAMENTO | - | - | - | O | - | - |
018-000 | QUANTIDADE DE PARCELAS | - | - | - | O | - | - |
019-yyy | DATA VENCIMENTO DA PARCELA | - | - | - | O | - | - |
020-yyy | VALOR DA PARCELA | - | - | - | O | - | - |
021-yyy | NÚMERO DA TRANSAÇÃO - NSU PARCELA | - | - | - | O | - | - |
022-000 | DATA DA TRANSAÇÃO - COMPROVANTE | - | O | O | M(1) | M(1) | - |
023-000 | HORA DA TRANSAÇÃO - COMPROVANTE | - | O | O | M(1) | M(1) | - |
024-000 | DATA PRÉ-DATADO | - | - | - | O | - | - |
025-000 | NÚMERO DA TRANSAÇÃO CANCELADA - NSU | - | O | - | - | M | - |
026-000 | TIMESTAMP DA TRANSAÇÃO CANCELADA | - | O | - | - | M | - |
027-000 | FINALIZAÇÃO | - | O | M(1) | M(1) | M(1) | - |
028-000 | QUANTIDADE DE LINHAS DO COMPROVANTE (*) | - | M | M | M | M | - |
029-yyy | IMAGEM DE CADA LINHA DO COMPROVANTE | - | O | O | O | O | - |
030-000 | TEXTO ESPECIAL DO OPERADOR | - | O | O | O | O | - |
031-000 | TESTO ESPECIAL DO CLIENTE | - | O | O | O | O | - |
032-000 | AUTENTICAÇÃO | - | - | O | - | - | - |
033-000 | BANCO | - | O | M(4) | - | O | - |
034-000 | AGÊNCIA | - | O | M(4) | - | O | - |
035-000 | AGÊNCIA - DC | - | O | O | - | O | - |
036-000 | CONTA CORRENTE | - | O | M(4) | - | O | - |
037-000 | CONTA CORRENTE - DC | - | O | O | - | O | - |
038-000 | NÚMERO DO CHEQUE | - | O | O(4) | - | O | - |
039-000 | NÚMERO DO CHEQUE - DC | - | O | O | - | O | - |
040-000 | NOME DA ADMNISTRADORA | - | O | O | O | O | - |
709-000 | VALOR DE DESCONTO (DEVE SER REGISTRADO COMO "DESCONTO"NA ECF) | - | - | - | - | - | - |
801-000 | LOG TRANSAÇÃO APROVADA | - | - | - | - | - | - |
803-000 | LOG ESTENDIDO DA TRANSAÇÃO APROVADA | - | - | - | - | - | - |
999-999 | TRAILER - REGISTRO FINAL | - | M | M | M | M | M |
Descrição dos campos:
Campo. | Conteúdo / Descrição |
---|---|
000-000 |
|
001-000 | IDENTIFICAÇÃO
|
002-000 | DOCUMENTO FISCAL VINCULADO
|
003-000 | VALOR TOTAL
|
004-000 |
|
005-000 | CMC-7
|
006-000 | TIPO DE PESSOA
|
007-000 | DOCUMENTO DA PESSOA
|
008-000 | DATA DO CHEQUE
|
009-000 | STATUS DA TRANSAÇÃO
|
010-000 |
|
011-000 | TIPO DA TRANSAÇÃO
Exemplos de HEADER como "ADM":
|
012-000 |
Quando este campo é enviado do Gerenciador para o Aplicativo de Automação Comercial, ele representa o NSU do Host estabelecido para a transação. Quando este campo é enviado do Aplicativo de Automação Comercial para o Gerenciador, ele representa o NSU da transação a ser tratada (cancelada, confirmada etc.)
|
013-000 | CÓDIGO DE AUTORIZAÇÃO DA TRANSAÇÃO
|
014-000 | NÚMERO DO LOTE DA TRANSAÇÃO
|
015-000 | TIMESTAMP DA TRANSAÇÃO HOST
|
016-000 | TIMESTAMP DA TRANSAÇÃO LOCAL
|
017-000 | TIPO PARCELAMENTO
|
018-000 | QUANTIDADE DE PARCELAS
|
019-yyy |
|
020-yyy | VALOR DA PARCELA
|
021-yyy | NÚMERO DA TRANSAÇÃO – NSU DA PARCELA
|
022-000 |
|
023-000 |
|
024-000 |
|
025-000 |
|
026-000 |
|
027-000 |
|
028-000 |
|
029-yyy |
|
030-000 |
|
031-000 |
|
032-000 | AUTENTICAÇÃO
|
033-000 | BANCO
|
034-000 | AGÊNCIA
|
035-000 | AGÊNCIA - DC
|
036-000 | CONTA CORRENTE
|
037-000 | CONTA CORRENTE - DC
|
038-000 | NÚMERO DO CHEQUE
|
039-000 | NÚMERO DO CHEQUE - DC
|
040-000 | NOME DA ADMINISTRADORA
|
709-000 | Valor de desconto concedido pela rede administradora que deve registrado na ECF como “desconto” no cupom fiscal |
800-000 | Identifica qual operação CRT ou ADM deve ser realizada ⦁ 001-Cancelamento ⦁ 002-Reimpressão ⦁ 003-Consulta Saldo ⦁ 004-Consulta Parcelas ⦁ 005-Serasa [REDECARD] ⦁ 006-Pré-Autorização ⦁ 007-Pagamentos [VISANET] ⦁ 008-Teste Rede Ativa ⦁ 009-Recarga Celular ⦁ 010-Resumo Vendas [REDECARD] ⦁ 011-Pagamento Fatura ⦁ 012-Cadastro Programa ⦁ 013-Acúmulo De Pontos ⦁ 014-Resgate De Pontos ⦁ 015-Estorno De Pontos ⦁ 016-Correspondente Bancário (Menu) ⦁ 036-Transação de Crédito ⦁ 037-Transação de Débito ⦁ 038-Transação Voucher ⦁ 039-Transação Private Label ⦁ 045-Transação Frota 046-Transação Crediário ⦁ 061-Transação ValeGás 062-Transação Débito Qualidade ⦁ 063-Transação Débito MettaCard ⦁ 101-CB (Inicialização de Equipamento) ⦁ 102-CB (Finalização de Equipamento) ⦁ 103-CB (Pagamento de Conta) ⦁ 104-CB (Cancelamento de Pagamento) ⦁ 105-CB (Resumo de Pagamentos) ⦁ 106-CB (Reimpressão de Comprovante) ⦁ 107-CB (Configurações) |
801-000 | Dados da transação de acordo com a operação realizada. Algumas transações não possuem log, nestes casos, este campo não será retornado. Normalmente este campo será gerado para as transações que realizam movimentação financeira. |
802-000 | ⦁ 0-Normal |
803-000 | Dados estendidos da transação, de acordo com o item “2.3.17 – Registro de Log Estendido” deste documento. |
999-999 | Finalidade: |
Exemplo de uma venda com cartão de crédito
Arquivo de solicitação da compra (C:\TEF_DIAL\REQ\IntPos.001)
Imagem do arquivo | Comentários |
---|---|
000-000 = CRT | Header p/ venda p/cartão |
001-000 = 1 | Identificação da solicitação |
002-000 =123456 | Número do documento fiscal vinculado |
003-000 = 150000 | Valor total da transação (R$1.500,00) |
999-999 = 0 | Registro final do arquivo |
Arquivo de informação que a função está sendo executada
Essas solicitações são vinculadas ao diretório: (C:\TEF_DIAL\RESP \IntPos.Sts)
Imagem do arquivo | Comentários |
---|---|
000-000 = CRT | Header p/ venda p/cartão |
001-000 = 1 | Identificação da solicitação |
999-999 = 0 | Registro final do arquivo |
Arquivo de resposta
Essas solicitações são vinculadas ao diretório: (C:\TEF_DIAL\RESP \IntPos.001)
Imagem do arquivo | Comentários |
---|---|
000-000 = CRT | Header p/ venda p/cartão |
001-000 = 1 | Identificação da solicitação |
002-000 = 123456 | Número do documento fiscal vinculado |
003-000 = 150000 | Valor total da transação (R$1.500,00) |
004-000 = 1 | Moeda = real |
009-000 = 0 | Status da transação = Ok |
010-000 = Nome da rede | Nome da Rede |
011-000 = 10 | Tipo da transação = Cartão de crédito à vista |
012-000 = 123456789000 | Número da NSU |
013-000 =123456 | Código de autorização da transação |
014-000 = 1234567890 | Número do lote da transação |
015-000 = DDMMHHMMSS | Data e hora da transação (Host) |
016-000 = DDMMHHMMSS | Data e hora da transação local (ponto de venda) |
022-000 = DDMMAAAA | Data da transação - Comprovante |
023-000 = HHMMSS | Hora da transação - Comprovante |
027-000 =123XXYTZAAABC | Finalização |
028-000 = 20 | Quant. de linhas do comprovante = 20 |
029-001 = "Rede X" | Imagem do comprovante – linha 01 |
029-002 = "Loja X | Imagem do comprovante – linha 02 |
029-003 = "Rua X | Imagem do comprovante – linha 03 |
029-004 = "TERM.666666” | Imagem do comprovante – linha 04 |
029-005 = "ADM.X" | Imagem do comprovante – linha 05 |
. | Imagem do comprovante – linha .. |
. | Imagem do comprovante – linha .. |
. | Imagem do comprovante – linha .. |
029-017 = " | Imagem do comprovante – linha 17 |
029-018 = " | Imagem do comprovante – linha 18 |
029-019. = "Assinatura" | Imagem do comprovante – linha 19 |
029-020 = "Cliente X | Imagem do comprovante – linha 20 |
040-000 = "ADM.X | Admnistradora do cartão |
999-999 = 0 | Registro final do arquivo |
Observação: Somente será disponibilizada uma cópia do comprovante, ficando a cargo da Aplicação de Automação Comercial a emissão da quantidade de vias necessárias, em função do tipo de impressora disponível. Deverão haver ao menos duas "vias", uma para o cliente outra para o estabelecimento.
Arquivo de confirmação
Arquivo de solicitação da compra (C:\TEF_DIAL\REQ\IntPos.001)
Imagem do arquivo | Comentários |
---|---|
000-000 = CRT | Header p/ confirmação de finalização da venda e impressão do cupom |
001-000 = 1 | Identificação da solicitação |
002-000 =123456 | Número do documento fiscal vinculado |
010-000 = Rede X | Rede responsável pela autorização |
012-000 = 123456789000 | Número da transação NSU |
027-000 = 123XXYTZAAABC | Finalização |
999-999 = 0 | Registro final do arquivo |