Você está na página 1de 32

Manual de Integração CTFClient

Protocolo TEF Dedicado


VERSÃO 01.13

Este documento contém aspectos confidenciais e estratégicos da empresa Auttar, os quais


foram entregues em caráter restrito, não podendo ser distribuído, copiado ou divulgado a
terceiros sem autorização prévia da mesma
Histórico

Versão Data Autor Observações


01.00 01/06/2010 Auttar Criação do documento baseado no documento “Guia Técnico
Gerenciador Padrão 2.5 032010”
01.01 21/01/2011 Auttar Inclusão dos campos 099-000, e 200-000 na seção Mensagens
de Solicitações - Geradas pela AC
(C:\Auttar_TefIP\REQ\IntPos.001).
01.02 26/01/2011 Auttar Inclusão da seção 6 referente aos parâmetros do arquivo
integradortef-ip.ini.
01.03 20/10/2011 Auttar Inclusão do Fluxo de Múltiplas Formas de Pagamento.
01.04 31/12/2011 Eduardo Santos Inclusão da transação CCT – Compra Crédito Telefone
01.05 28/06/2012 Eduardo Santos Inclusão dos códigos de transação 97 – Saque Transferência
Doméstica / 98 – Depósito Transferência Doméstica
(Acessados através do menu administrativo).
01.06 18/07/2012 Eduardo Santos Inclusão da transação ENF – Envio Fácil (Transferência
Doméstica)
01.07 13/08/2012 Eduardo Santos Inclusão do campo 201-00 (Valor desconto – Cielo PP);

Definição do código de transação 95 para o campo 011-00,


retornado na transação de Resgate de Prêmio Cielo PP.

Detalhamento da funcionalidade da Plataforma Promocional.


01.08 12/12/2012 Eduardo Santos Inclusão do tipo de transação 94 (campo 011-000) – Crediário
Cielo
01.09 07/10/2014 Marcos Gregório Inclusão do tipo de transação 93 (campo 011-000) – Vale gás
1.10 17/10/2014 Marcos Gregório Inclusão da transação VLG – Vale gás
1.11 06/04/2016 Auttar Alteração da identidade visual da empresa Auttar
1.12 09/05/2016 Auttar Inclusão da transação GCD – Captura de dado no pinpad.
Inclusão do tipo de transação 80 (campo 011-000) – Captura
de dado no pinpad.
Inclusão do campo 300-00 (Tipo do dado).
Inclusão do campo 301-00 (Dado capturado no pinpad).
Inclusão do campo 710-000 (Quantidade de linhas do
comprovante reduzido).
Inclusão do campo 711-yyy (comprovante reduzido).
Inclusão do campo 712-000 (Quantidade de linhas do
comprovante via cliente).
Inclusão do campo 713-yyy (comprovante via cliente).
Inclusão do campo 714-000 (Quantidade de linhas do

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 1


comprovante via estabelecimento).
Inclusão do campo 715-yyy (comprovante via
estabelecimento).
1.13 24/05/2016 Auttar Inclusão do campo 099-000 (Identificador de múltiplos
cartões).
Inclusão do campo 706-000 (Capacidade do terminal).
Inclusão do campo 707-000 (Valor original da transação).
Inclusão do campo 708-000 (Valor do saque).
Inclusão do campo 709-000 (Valor do desconto).

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 2


Índice
Objetivo ..................................................................................................................................................................... 4
Visão Geral................................................................................................................................................................. 5
Fluxo .......................................................................................................................................................................... 6
FLUXO MÚLTIPLOS CARTÕES .........................................................................................................................9
FLUXO MÚLTIPLAS FORMAS DE PAGAMENTO ..................................................................................................... 10
Diretórios para troca de arquivos ............................................................................................................................ 11
DIRETÓRIOS DE ENVIO DE DADOS ................................................................................................................... 11
DIRETÓRIOS DE RETORNO DE DADOS ............................................................................................................... 11
Layout de Mensagens geradas pela AC .................................................................................................................... 12
MENSAGENS DE STATUS - GERADAS PELO CTFCLIENT (C:\AUTTAR_TEFIP\REQ\INTPOS.001) ............................................. 12
MENSAGENS DE SOLICITAÇÕES - GERADAS PELA AC (C:\AUTTAR_TEFIP\REQ\INTPOS.001) ............................................... 12
MENSAGENS DE RESPOSTAS – GERADAS PELA AC (C:\AUTTAR_TEFIP\REQ\INTPOS.001) ................................................. 13
Formato dos campos................................................................................................................................................ 15
DESCRIÇÃO DOS CAMPOS DAS MENSAGENS........................................................................................................ 17
Plataforma Promocional (Cielo PP) .......................................................................................................................... 31

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 3


Objetivo

Este documento trata da integração entre o Concentrador de Transferência de Fundos (CTF),


desenvolvido pela Auttar, e os aplicativos de Automação Comercial.

Uma aplicação de automação comercial necessita integrar-se com o CTFClient quando deseja
realizar operações de TEF (transferência eletrônica de fundos) através do CTF.

O CTF é responsável pela efetivação dos pagamentos eletrônicos, ou seja, pela autorização e
realização das operações financeiras on line, possibilitando à aplicação de automação comercial
efetuar transações de TEF on line com cartões de crédito e débito de diversas bandeiras bem
como serviços em transações eletrônicas existentes no mercado.

O CTFClient disponibiliza uma interface de integração simples baseada no protocolo TEF Discado
(Gerenciador Padrão), possibilitando que não haja necessidade de desenvolvimento para as
Automações Comerciais que já possuem essa integração .

O acionamento do CTFClient será realizado pela Automação Comercial através de troca de


arquivos contendo as informações da transação.

Ao termino da integração, será necessário realizar a certificação da Automação Comercial junto a


Auttar. Eventualmente, algumas redes autorizadoras poderão solicitar a certificação da integração
entre Automação Comercial e o TEF.

Obs.: Esse manual foi baseado no documento “Guia Técnico Gerenciador Padrão 2.5_032010”.

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 4


Visão Geral

(1) Envia solicitação

(2) Confirma recebimento


da solicitação
(3) Envia solicitação para
redes autorizadoras

CTF CTF
SOLUÇÃO
CLIENT SERVER
AUTOMAÇÃO
COMERCIAL (4) Envia resposta da (4) Envia resposta da
Captura solicitação. Comunicação
solicitação.
de Dados com Redes
Autorizadoras
(5) Imprime cupom TEF (5) Envia confirmação da
Envia status da impressão solicitação

(6) Confirma recebimento


do status da impressão.

O CTFClient , através de uma interface de integração, atua da seguinte forma junto a Automação
Comercial:

 Automação Comercial, no término da operação comercial, gera o arquivo


C:\Auttar_TefIP\REQ\IntPos.001 nos padrões estabelecidos; (ETAPA 1)
 O CTFClient avisa a Automação Comercial que recebeu o arquivo e que está processando,
gerando o arquivo C:\ Auttar_TefIP\RESP\IntPos.Sts. Obs.: Se a Automação Comercial não receber
este arquivo em até 7 segundos, significa que o CTFClient não está ativo; (ETAPA 2)
 O CTFClient maximiza uma tela para seleção da Rede desejada; (ETAPA 3)
 O CTFClient executa a transação solicitada (ETAPA 3) e envia sua resposta para a Automação
Comercial: C:\ Auttar_TefIP\RESP \IntPos.001; (ETAPA 4)
 Caso haja cupom TEF a ser impresso, a Automação Comercial deve imprimi-lo e em seguida
retornar status da impressão para o CTFClient: C:\ Auttar_TefIP\REQ\IntPos.001. No caso de uma
transação de venda, se o valor da transação não completar o valor total da venda, a Automação
Comercial deverá permitir ao usuário completar o pagamento com outras formas (dinheiro,
cheque, etc.) e imprimir o comprovante de TEF. (ETAPA 5)
 O CTFClient confirma recebimento do status da impressão para a Automação Comercial: C:\
Auttar_TefIP\RESP \IntPos.Sts. (ETAPA 6).

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 5


Fluxo

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 6


Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 7
1. Caso ocorra queda de energia durante a impressão do cupom, a ‘AC’ deverá automaticamente
enviar uma transação ‘NCN’ apresentando a mensagem:

2. Quando apresentar mensagem de não confirmação, apresentar os campos Doc. No (campo


12) e rede (campo 10) obrigatoriamente, o campo valor (campo 3) deverá ser apresentado
somente se estiver presente ou com valor diferente de zero no arquivo
Intpos.001 do diretório Resp. O campo valor também deverá ser formatado como moeda.

3. O número de vias impressas do cupom poderá ser parametrizado. Quando de impressão em 2


ou mais vias a ‘AC’ poderá parar a impressão por 5 segundos , entre as vias, para que seja
destacado o cupom. Quando do processo de certificação, os testes serão realizados com a
emissão de 2 vias.

4. A verificação da impressão correta do comprovante deve ser feita pela automação, não deixar
o usuário informar se o mesmo foi impresso corretamente.

5. Não imprimir leitura X entre as vias do comprovante TEF.

6. Mensagem do Campo 30. Esta deve ser apresentada pela Automação Comercial quando seu
conteúdo for diferente de vazio.
Se vazio não poderá ser apresentado o Message Box .

Observações:
a) Quando existir linhas para serem impressas a mensagem do campo 30, deve ser exibida
paralelamente a impressão. Esta não pode ficar aguardando um Ok do usuário para
começar a imprimir. Deixar a mensagem o mínimo por 5 segundos ou durante toda a
impressão.
b) Quando não houver linhas para serem impressas a mensagem deve ficar aguardando uma
confirmação do usuário.

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 8


Fluxo Múltiplos Cartões

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 9


Fluxo Múltiplas Formas de Pagamento

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 10


Diretórios para troca de arquivos
A estrutura de troca de arquivos prevê a utilização de 2 diretórios:

Diretórios de envio de dados


 Utilizado pela Automação Comercial para enviar os dados da transação para o CTFClient.
 A automação Comercial gera um arquivo para cada envio de mensagem.
 O CTFClient utiliza o arquivo recebido e o exclui após sua utilização.

Nome do diretório: C:\ Auttar_TefIP\REQ


Nome do arquivo: (para as etapas 2 e 5): IntPos.001

OBS: Criar o arquivo com o nome IntPos.tmp e em seguida renomeá-lo para IntPos.001

Diretórios de retorno de dados


 Utilizado pela Automação Comercial para receber os dados do CTFClient.
 CTFClient gera um arquivo de resposta conforme fluxo.
 Automação Comercial utiliza o arquivo de resposta e o exclui após sua utilização.
 O arquivo de resposta contém indicação do aceite ou recusa do pedido efetuado pelo
envio.

Nome do diretório: C:\ Auttar_TefIP\RESP


Nome do arquivo (para as etapas 2 e 6): IntPos.Sts
Nome do arquivo (para as demais etapas): IntPos.001

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 11


Layout de Mensagens geradas pela AC

Mensagens de Status - Geradas pelo CTFClient (C:\Auttar_TefIP\REQ\IntPos.001)

CÓDIGO DE TIPO DE INFORMAÇÃO ATV ADM CHQ CRT CCT ENF CNC CNF NCN VLG GCD
CAMPO
000-000 HEADER M M M M M M M M M M M

001-000 IDENTIFICAÇÃO M M M M M M M M M M M

999-999 TRAILER – REGISTRO FINAL M M M M M M M M M M M

M = Mandatório O = Opcional - = Ausente

Mensagens de Solicitações - Geradas pela AC (C:\Auttar_TefIP\REQ\IntPos.001)

CÓDIGO DE TIPO DE INFORMAÇÃO ATV ADM CHQ CRT CCT ENF CNC CNF NCN VLG GCD
CAMPO
000-000 HEADER M M M M M M M M M M M
001-000 IDENTIFICAÇÃO M M M M M M M M M M M
002-000 DOCUMENTO FISCAL VINCULADO - - O O O O O O O O O
003-000 VALOR TOTAL - - M M O O 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 DA TRANSAÇÃO - NSU - - - - - - M M M - -
022-000 DATA DA TRANSAÇÃO - - - - - - - M - - - -
COMPROVANTE
023-000 HORA DA TRANSAÇÃO - - - - - - - M - - - -
COMPROVANTE
027-000 FINALIZAÇÃO - - - - - - - M M - -
033-000 BANCO - - O - - - O(1) - - - -
034-000 AGÊNCIA - - O - - - O(1) - - - -

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 12


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) - - - -
300-000 TIPO DO DADO - - - - - - - - - - M
706-000 CAPACIDADE DO TERMINAL - - - O - - - - - - -
099-000 IDENTIFICADOR DE MÚLTIPLOS - - - O(2) - - - M(2) M(2) - -
CARTÕES
999-999 TRAILER – REGISTRO FINAL M M M M M M M M M M
M = Mandatório O = Opcional - = Ausente

Observações: Os campos marcados com:


(1)- somente existem para cancelamento de operação com cheques.
(2)- O preenchimento desse campo é obrigatório, quando a transação a ser confirmada (CNF) ou desfeita (NCN) foi
processada seguindo o fluxo de múltiplos pagamentos;
(3)- somente existem para transações de saque.

Mensagens de Respostas – Geradas pela AC (C:\Auttar_TefIP\REQ\IntPos.001)

CÓDIGO DE TIPO DE INFORMAÇÃO ATV ADM CHQ CRT CCT ENF CNC VLG GCD
CAMPO
000-000 HEADER - M M M M M M M M
001-000 IDENTIFICAÇÃO - M M M M M M M M
002-000 DOCUMENTO FISCAL VINCULADO - O O(3) O(3) O(3) O(3) O(3) O(3) O(3)
003-000 VALOR TOTAL - O M M M M M M -
004-000 MOEDA - O - M(3) - O 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 M M M M
010-000 NOME DA REDE - M M M M M M M -
011-000 TIPO DA TRANSAÇÃO - M M M M M M M M

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 13


012-000 NÚMERO DA TRANSAÇÃO – NSU - O M(1) M(1) M(1) M(1) M(1) M(1) -
013-000 CÓDIGO DE AUTORIZAÇÃO DA TRANSAÇÃO - O O 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) M(1) O -
016-000 TIMESTAMP DA TRANSAÇÃO – LOCAL - O O O 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 DA PARCELA - - - O - O - - -
022-000 DATA DA TRANSAÇÃO – COMPROVANTE - O O M(1) M(1) M(1) M(1) O -
023-000 HORA DA TRANSAÇÃO – COMPROVANTE - O O M(1) M(1) M(1) M(1) O -
024-000 DATA PRÉ-DATADO - - - O - - - -
025-000 NÚMERO DA TRANSAÇÃO CANCELADA – NSU - O - - - M M - -
026-000 TIMESTAMP DA TRANSAÇÃO CANCELADA - O - - - M M - -
027-000 FINALIZAÇÃO - O M(1) M(1) M(1) M(1) M(1) O -
028-000 QUANTIDADE DE LINHAS DO COMPROVANTE (*) - M M M M M M M -
029-yyy IMAGEM DE CADA LINHA DO COMPROVANTE - O O O O O O O -
030-000 TEXTO ESPECIAL OPERADOR - O O O O O O O O
031-000 TEXTO ESPECIAL CLIENTE - O O O 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 ADMINISTRADORA - O O O O O O O -
200-000 IDENTIFICADOR DE TRANSAÇÃO COM SAQUE - - - M(5) - - M(5) - -
201-000 VALOR DESCONTO (CIELO PP) - - - O - - - - -
301-000 DADO CAPTURADO NO PINPAD - - - - - - - - M
707-000 VALOR ORIGINAL DA TRANSACAO - - - O - - - - -
708-000 VALOR DO SAQUE - - - O - - - - -
709-000 VALOR DO DESCONTO - - - O - - - - -

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 14


710-000 QUANTIDADE DE LINHAS DO COMPROVANTE - M M M M M M M -
REDUZIDO
711-yyy IMAGEM DE CADA LINHA DO COMPROVANTE - O O O O O O O -
REDUZIDO
712-000 QUANTIDADE DE LINHAS DO COMPROVANTE VIA - M M M M M M M -
CLIENTE
713-yyy IMAGEM DE CADA LINHA DO COMPROVANTE VIA - O O O O O O O -
CLIENTE
714-000 QUANTIDADE DE LINHAS DO COMPROVANTE VIA - M M M M M M M -
ESTABELECIMENTO
715-yyy IMAGEM DE CADA LINHA DO COMPROVANTE VIA - O O O O O O O -
ESTABELECIMENTO
999-999 TRAILER – REGISTRO FINAL - M M M M M M M M
CÓDIGO DE TIPO DE INFORMAÇÃO ATV ADM CHQ CRT CCT ENF CNC VLG GCD
CAMPO
M = Mandatório O = Opcional - = Ausente

Observação: Os campos marcados com:


(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.
(5)- Esse campo só existe no arquivo de saída, onde seu retorno está condicionado ao fato do operador informar
um valor de saque na transação de débito.

(*) 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 CTFClient preencherá este campo
com zero “0” quando não houver comprovante.

Formato dos campos


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:
A- Identificação do tipo de informação ou campo
B- Nº de sequência complementar ao tipo de informação ou campo

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 15


C- Posição contendo espaço ou branco
D- Informação (sempre alinhada à 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 de operações possíveis são:

ATV Verifica se o CTFClient está ativo


ADM Permite o acionamento da Solução TEF Discado 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
CCT Compra de crédito de telefone
ENF Envio Fácil (Consulta / Deposito / Saque)
NCN Não confirmação da venda e/ou da impressão.
VLG Vale gás
GCD Captura de dado no pinpad

Verificação pela Automação Comercial se o CTFClient está ativo deve ser feita através:
707.Função ATV:
Se a Automação Comercial receber em até 7 segundos o arquivo
C:\Auttar_TefIP\RESP\IntPos.Sts significa que o CTFClient está ativo.

2. Toda vez que o GP 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 C:\Auttar_TefIP\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 CTFClient não está ativo.

O cancelamento de venda pode ser feito de duas formas:


1. Pela operação ADM, onde o CTFClient abre uma tela para a captura dos dados da transação
a ser cancelada.
2. 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 CTFClient.

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 16


Descrição dos campos das mensagens

CAMPO DESCRIÇÃO
000-000 HEADER
Finalidade:
Indica o início do arquivo e o tipo de operação relacionada ao arquivo.
Formato:
Alfanumérico de 3 bytes.
Conteúdos válidos:
ATV- Verifica se o CTFClient está ativo
ADM- Administrativa
CHQ- Cheque
CRT- Cartão
CCT – Compra de crédito de telefone
CNC- Cancelamento
CNF- Confirmação de finalização da venda e impressão do cupom
NCN- Não confirmação de finalização da venda por desistência do cliente ou erro na impressão do
cupom.
001-000 IDENTIFICAÇÃO
Finalidade:
Indica o número de controle da solicitação que está sendo feita. Este número é gerado pelo
aplicativo de automação comercial, o qual deverá colocar um conteúdo diferente a cada nova
solicitação. Este mesmo conteúdo é devolvido nos arquivos de resposta.
Formato:
Numérico de até 10 bytes.
002-000 DOCUMENTO FISCAL VINCULADO
Finalidade:
Número do documento fiscal vinculado à forma de pagamento ou finalização.
Nota relativa a legislação ECF “…A emissão do comprovante de pagamento de operação ou
prestação, efetuado com cartão de crédito ou débito automático em conta corrente somente
poderá ser feita por meio de ECF, devendo o comprovante estar vinculado ao documento
fiscal emitido na operação ou prestação respectiva, conforme disposto em legislação
pertinente.”.
Formato:
Numérico de até 12 bytes.

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 17


CAMPO DESCRIÇÃO
003-000 VALOR TOTAL
Finalidade:
Valor total desta forma de pagamento.
Formato:
Numérico de até 12 bytes, sendo duas casas decimais sem a virgula separadora
004-000 MOEDA
Finalidade:
Indica a moeda utilizada na operação
Formato:
Numérico de 1 byte
Conteúdos Válidos:
0 – para Real
1 – para Dólar
005-000 CMC-7
Finalidade:
Contém os dados do cheque no mesmo formato obtido por uma leitura do CMC-7
Formato:
Alfanumérico de até 70 bytes.
006-000 TIPO DE PESSOA
Finalidade:
Indica o tipo de pessoa que esta sendo atendida na operação.
Formato:
Alfanumérico de 1 byte
Conteúdos Válidos:
F – para pessoa física – CPF
J – para pessoa jurídica – CNPJ
007-000 DOCUMENTO DA PESSOA
Finalidade:
Indica a pessoa que esta sendo atendida na operação por meio do CNPJ ou CPF.
Formato:
Numérico 16 bytes.
008-000 DATA DO CHEQUE

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 18


CAMPO DESCRIÇÃO
Finalidade:
Data de vencimento do Cheque
Formato:
Numérico – DDMMAAAA
009-000 STATUS DA TRANSAÇÃO
Finalidade:
Indica se a transação foi aprovada ou recusada e qual o motivo da recusa.
Formato:
Alfanumérico de até 3 bytes.
Conteúdos Válidos:
707 – para transação aprovada
Outro valor – transação negada
010-000 NOME DA REDE
Finalidade:
Nome da rede que tratou a transação
Formato:
Alfanumérico de até 8 bytes
Conteúdos Válidos:
AMEX
REDECARD
CIELO
011-000 TIPO DA TRANSAÇÃO
Finalidade:
Código identificando o tipo da transação executada
Formato:
Numérico de até 2 bytes.
Conteúdos Válidos:
00- Administrativas – Outras (Reimpressão, Iniciação de Terminal etc.)
01- Administrativa – Fechamento/Transmissão de Lote
10- Cartão de Crédito à Vista
11- Cartão de Crédito Parcelado pelo Estabelecimento
12- Cartão de Crédito Parcelado pela Administradora
13- Pré-Autorização com Cartão de Crédito

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 19


CAMPO DESCRIÇÃO
20- Cartão de Débito à Vista
21- Cartão de Débito Pré-Datado
22- Cartão de Débito Parcelada
23- Cartão de Débito à Vista Forçada
24- Cartão de Débito Pré-Datado Forçada
25- Cartão de Débito Pré-Datado sem Garantia
30- Outros Cartões
40- CDC
41- Consulta CDC
50- Convênio
60- Voucher
70- Consulta Cheque
71- Garantia de Cheque
80-Captura de dado no pinpad
93– Vale gás
94– Crediário Cielo
95– Resgate de Prêmio (Cielo PP – Plataforma Promocional)
96– Depósitos Transferência Doméstica (Envio Fácil)
97– Saque Transferência Doméstica (Envio Fácil)
98– Crédito Telefone
99-Outras

Obs.: No cancelamento de venda feito através da operação ADM (Administrativa) este campo
conterá o tipo da transação de venda que foi cancelada.

Exemplo-1: 000-000 = ADM


011-000 = 00 (Administrativas: Reimpressão, Iniciação de Terminal etc.)

Exemplo-2: 000-000 = ADM


011-000 = 01 (Administrativa: Fechamento/Transmissão de Lote)

Exemplo-3: 000-000 = ADM


011-000 = 10 (Cancelamento de Cartão de Crédito, qualquer que tenha

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 20


CAMPO DESCRIÇÃO

sido a modalidade: à Vista, Parcelado pelo

Estabelecimento ou pela Administradora)


Exemplo-4: 000-000 = ADM
011-000 = 20 (Cancelamento de Cartão de Débito, qualquer que tenha

sido a modalidade: à Vista, Pré-Datado, Parcelado etc.)

Exemplo-5: 000-000 = ADM


011-000 = 71 (Cancelamento de Garantia de Cheque)
012-000 NÚMERO DA TRANSAÇÃO – NSU
Finalidade:
Indica o número de sequência (NSU – Número Sequencial Único) da transação atribuído pelo Host
(Sistema das Redes de Cartão que recebe e trata as solicitações das transações TEF).

Quando este campo é enviado do CTFClient 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 CTFClient, ele
representa o NSU da transação a ser tratada (cancelada, confirmada etc.)
Formato:
Numérico de até 12 bytes.
013-000 CÓDIGO DE AUTORIZAÇÃO DA TRANSAÇÃO
Finalidade:
Indica o número de autorização da transação atribuída pelo Host.
Cada transação TEF possui um número de autorização.
Formato:
Numérico de até 6 bytes.
014-000 NÚMERO DO LOTE DA TRANSAÇÃO
Finalidade:
Indica o número de lote da transação
Formato:
Numérico de até 10 bytes.
015-000 TIMESTAMP DA TRANSAÇÃO HOST

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 21


CAMPO DESCRIÇÃO
Finalidade:
Indica a data e hora da transação no Host
Formato:
Numérico – DDMMHHMMSS
016-000 TIMESTAMP DA TRANSAÇÃO LOCAL
Finalidade:
Indica a data e hora da transação no ponto de venda.
Formato:
Numérico – DDMMHHMMSS
017-000 TIPO PARCELAMENTO
Finalidade:
Indica o tipo de parcelamento aplicado à operação
Formato:
Numérico de 1 byte
Conteúdos Válidos:
0 – parcelado estabelecimento
1 – parcelado administradora
018-000 QUANTIDADE DE PARCELAS
Finalidade:
Indica o número de parcelas no caso de transações Parceladas (Crédito ou Débito).
Formato:
Numérico de até 2 bytes.
019-yyy DATA VENCIMENTO DA PARCELA
Finalidade:
Indica a data em que foi agendada a parcela (yyy). A parcela é indicada pelos três caracteres (yyy) do
campo correspondente, onde yyy será igual a 001, 002, … respectivamente para cada uma das
parcelas definidas no campo QUANTIDADE DE PARCELAS.
Formato:
Numérico – DDMMAAAA
020-yyy VALOR DA PARCELA
Finalidade:
Indica o valor da parcela (yyy). A parcela é indicada pelos três caracteres (yyy) do campo
correspondente, onde yyy será igual a 001, 002, … respectivamente para cada uma das parcelas

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 22


CAMPO DESCRIÇÃO
definidas no campo QUANTIDADE DE PARCELAS.
Formato:
Numérico de até 12 bytes, sendo duas casas decimais sem a vírgula separadora.
021-yyy NÚMERO DA TRANSAÇÃO – NSU DA PARCELA
Finalidade:
Indica o NSU da parcela (yyy). A parcela é indicada pelos três caracteres (yyy) do campo
correspondente, onde yyy será igual a 001, 002, … respectivamente para cada uma das parcelas
definidas no campo QUANTIDADE DE PARCELAS.
Formato:
Numérico de até 12 bytes.
022-000 DATA DA TRANSAÇÃO – COMPROVANTE
Finalidade:
Indica a data da transação
Formato:
Numérico – DDMMAAAA
023-000 HORA DA TRANSAÇÃO – COMPROVANTE
Finalidade:
Indica a hora da transação
Formato:
Numérico – HHMMSS
024-000 DATA PRÉ-DATADO
Finalidade:
Contém data de agendamento para pré-datado.
Formato:
Numérico – DDMMAAAA
025-000 NÚMERO DA TRANSAÇÃO CANCELADA – NSU
Finalidade:
Número de sequência (NSU) da transação cancelada.
Formato:
Numérico de até 12 bytes.
026-000 TIMESTAMP DA TRANSAÇÃO CANCELADA – Host
Finalidade:
Contém a data e hora da transação cancelada no Host.

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 23


CAMPO DESCRIÇÃO
Formato:
Numérico – DDMMHHMMSS
027-000 FINALIZAÇÃO
Finalidade:
Dados recebidos do Módulo TEF que executou a transação e que devem ser devolvidos no comando
de finalização de uma venda
Formato:
Alfanumérico de até 30 bytes
028-000 QUANTIDADE DE LINHAS DO COMPROVANTE
Finalidade:
Indica a quantidade de linhas do comprovante. Quando não há comprovante o campo deve conter
zero.
Formato:
Numérico de até 3 bytes
029-yyy IMAGEM DE CADA LINHA DO COMPROVANTE
Finalidade:
Apresenta a imagem a ser impressa de cada uma das linhas do comprovante. A linha de impressão é
indicada pelos três caracteres (yyy) do campo correspondente, onde yyy será igual a 001, 002, ...
respectivamente para cada uma das linhas definidas no campo QUANTIDADE DE LINHAS DO
COMPROVANTE.
Formato:
Alfanumérico de até 40 bytes
030-000 TEXTO ESPECIAL OPERADOR
Finalidade:
Texto que, quando presente, deve ser apresentado pelo aplicativo de Automação Comercial ao
operador.
Formato:
Alfanumérico de até 40 bytes.
031-000 TEXTO ESPECIAL CLIENTE
Finalidade:
Texto que, quando presente, deve ser apresentado pelo aplicativo de Automação Comercial ao
cliente.
Formato:
Alfanumérico de até 40 bytes.

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 24


CAMPO DESCRIÇÃO
032-000 AUTENTICAÇÃO
Finalidade:
Mensagem de autenticação a ser impressa no cheque
Formato:
Alfanumérico de até 20 bytes.
033-000 BANCO
Finalidade:
Código do Banco no padrão do Banco Central
Formato:
Alfanumérico de até 4 bytes.
034-000 AGÊNCIA
Finalidade:
Código da agência do cheque
Formato:
Alfanumérico de até 20 bytes.
035-000 AGÊNCIA – DC
Finalidade:
Dígito de controle da agência do cheque
Formato:
Alfanumérico de até 2 bytes.
036-000 CONTA CORRENTE
Finalidade:
Código da conta corrente do cheque
Formato:
Alfanumérico de até 20 bytes.
037-000 CONTA CORRENTE – DC
Finalidade:
Dígito de controle da conta corrente do cheque
Formato:
Alfanumérico de até 2 bytes.
038-000 NÚMERO DO CHEQUE
Finalidade:

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 25


CAMPO DESCRIÇÃO
Número do cheque
Formato:
Alfanumérico de até 20 bytes.
039-000 NÚMERO DO CHEQUE – DC
Finalidade:
Dígito de controle do Número do cheque
Formato:
Alfanumérico de até 2 bytes.
040-000 NOME DA ADMINISTRADORA
Finalidade:
Identifica a Administradora do Cartão utilizado.
Formato:
Alfanumérico de até 12 bytes.
Conteúdos Válidos:
CIELO
AMEX
MASTERCARD
etc.
099-000 IDENTIFICADOR DE MÚLTIPLOS CARTÕES

Finalidade:
O preenchimento desse campo é obrigatório, quando a transação a ser confirmada (CNF) ou desfeita
(NCN) foi processada seguindo o fluxo de múltiplos pagamentos.
200-000 VALOR DO SAQUE
Finalidade:
Valor do saque realizado durante o processamento da transação de compra
Formato:
Numérico de até 12 bytes, sendo duas casas decimais sem a vírgula separadora.
201-000 VALOR DO DESCONTO
Finalidade:
Valor do desconto da plataforma promocional
Formato:
Numérico de até 12 bytes, sendo duas casas decimais sem a vírgula separadora.
300-000 TIPO DO DADO

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 26


CAMPO DESCRIÇÃO
Finalidade:
Tipo do dado a ser capturado.
Formato:
Numérico de até 2 bytes.
Conteúdos Válidos:
01 – DIGITE O DDD
02 – REDIGITE O DDD
03 – DIGITE O TELEFONE
04 – REDIGITE O TELEFONE
05 – DIGITE DDD+TELEFONE
06 – REDIGITE DDD+TELEFONE
07 – DIGITE O CPF
08 – REDIGITE O CPF
09 – DIGITE O RG
10 – REDIGITE O RG
301-000 DADO CAPTURADO NO PINPAD
Finalidade:
Dado capturado no pinpad pelo cliente.
Formato:
Numérico de até 32 bytes.
Conteúdos Válidos:
DDD
TELEFONE
DDD+TELEFONE
CPF
RG
706-000 CAPACIDADE DO TERMINAL
Finalidade:
Indica se o terminal está habilitado para tratar saque ou desconto.
Formato:
Numérico de 1 byte
Conteúdos Válidos:

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 27


CAMPO DESCRIÇÃO
1 – suporta saque
2 – suporta desconto
3 – suporta saque e desconto
707-000 VALOR ORIGINAL DA TRANSACAO
Finalidade:
Valor original da transação quando realizada com saque ou com desconto. Ver a definição do campo
706.
Formato:
Numérico de até 12 bytes, sendo duas casas decimais sem a vírgula separadora
708-000 VALOR DO SAQUE
Finalidade:
Valor do saque realizado durante a transação. Ver a definição do campo 706.
Valor total (003-000) = Valor original (707-000) +Valor do saque (708-000) – Valor do desconto (709-000)

Formato:
Numérico de até 12 bytes, sendo duas casas decimais sem a vírgula separadora
709-000 VALOR DO DESCONTO
Finalidade:
Valor do desconto concedido pela rede adquirente. Ver a definição do campo 706.
Valor total (003-000) = Valor original (707-000) +Valor do saque (708-000) – Valor do desconto (709-000)

Formato:
Numérico de até 12 bytes, sendo duas casas decimais sem a vírgula separadora
710-000 QUANTIDADE DE LINHAS DO COMPROVANTE REDUZIDO
Finalidade:
Indica a quantidade de linhas do comprovante reduzido. Quando não há comprovante o campo deve
conter zero.
Formato:
Numérico de até 3 bytes
711-yyy IMAGEM DE CADA LINHA DO COMPROVANTE REDUZIDO
Finalidade:
Apresenta a imagem a ser impressa de cada uma das linhas do comprovante reduzido. A linha de
impressão é indicada pelos três caracteres (yyy) do campo correspondente, onde yyy será igual a
001, 002, ..., respectivamente para cada uma das linhas definidas no campo QUANTIDADE DE LINHAS
DO COMPROVANTE REDUZIDO.
Formato:

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 28


CAMPO DESCRIÇÃO
Alfanumérico de até 40 bytes
712-000 QUANTIDADE DE LINHAS DO COMPROVANTE VIA CLIENTE
Finalidade:
Indica a quantidade de linhas do comprovante via cliente. Quando não há comprovante o campo
deve conter zero.
Formato:
Numérico de até 3 bytes
713-yyy IMAGEM DE CADA LINHA DO COMPROVANTE VIA CLIENTE
Finalidade:
Apresenta a imagem a ser impressa de cada uma das linhas do comprovante via cliente. A linha de
impressão é indicada pelos três caracteres (yyy) do campo correspondente, onde yyy será igual a
001, 002, ..., respectivamente para cada uma das linhas definidas no campo QUANTIDADE DE LINHAS
DO COMPROVANTE VIA CLIENTE.
Formato:
Alfanumérico de até 40 bytes
714-000 QUANTIDADE DE LINHAS DO COMPROVANTE VIA ESTABELECIMENTO
Finalidade:
Indica a quantidade de linhas do comprovante via estabelecimento. Quando não há comprovante o
campo deve conter zero.
Formato:
Numérico de até 3 bytes
715-yyy IMAGEM DE CADA LINHA DO COMPROVANTE VIA ESTABELECIMENTO
Finalidade:
Apresenta a imagem a ser impressa de cada uma das linhas do comprovante via estabelecimento. A
linha de impressão é indicada pelos três caracteres (yyy) do campo correspondente, onde yyy será
igual a 001, 002, ..., respectivamente para cada uma das linhas definidas no campo QUANTIDADE DE
LINHAS DO COMPROVANTE VIA ESTABELECIMENTO.
Formato:
Alfanumérico de até 40 bytes
999-999 TRAILER - REGISTRO FINAL
Finalidade:
Indica fim do arquivo.
Formato:
Numérico de 1 byte – Constante zero

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 29


Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 30
Plataforma Promocional (Cielo PP)
A Plataforma Promocional também definida como Cielo PP é a plataforma de promoções para Estabelecimento
Comercia centralizada e administrada no Host da Cielo.

Tipos de Prêmio

 Desconto Instantâneo

Prêmio oferecido instantaneamente na resposta de uma compra. Este prêmio está sempre associado a uma
transação monetária
O desconto é informado na resposta da autorização, onde será informado um display e comprovante
impresso indicando o valor original e o valor com desconto. O desconto será aplicado sempre ao valor total
da transação financeira, podendo ser um valor fixo ou um percentual do valor da transação.

Para verificar se a transação financeira possui desconto fornecido pela autorizadora, a Automação Comercial
deve verificar a existência do campo 201-000 que estará preenchido com o valor do desconto, caso exista.

 Cupom Eletrônico

São cupons em formato eletrônico que valem desconto ou prêmios, podendo ser monetário ou não
monetário.

o Monetário – O cupom é gerado durante o fluxo de uma transação financeira e estará disponível
para utilização na próxima compra no estabelecimento. O desconto pode ser um valor fixo ou um
valor percentual sobre o valor total.

o Não Monetário – Prêmio ou brinde que não corresponde a desconto sobre o valor da compra. Para
ter acesso aos “Cupons Eletrônicos” a Automação Comercial deve acessar a função Administrativa e
selecionar a opção “Resgate de Prêmio”. Caso essa função seja selecionada o campo 011-000 (Tipo
Transação) será preenchido com valor igual 95.

Para utilizar a Plataforma Promocional a Automação Comercial precisa ser configurada para tratar os cupons
Cliente e Estabelecimento de forma distinta. Sendo assim, o parâmetro CUPOM_VIA_CLIENTE da solução
TEF-IP deve ser parametrizado com valor 1 (um).

Essa configuração possibilita que a Automação Comercial receba os cupons Cliente e Estabelecimento
formatados no campo 029-yyy. Essa parametrização é obrigatória para utilização da Plataforma Promocional, já que
os dados do Cupom Eletrônico são disponibilizados na via do Cliente.

Manual de Integracao CTFClient - Protocolo TEF Dedicado v01.13.docx 31