Detalhamento dos campos

🚧

Esta documentação está desatualizada.

Para informações sempre atualizadas, acesse https://paygodev.readme.io/docs.

A tabela a seguir detalha o conteúdo de cada campo previsto por esta especificação.

Legenda para a coluna “Formato”:

• ‘n’ indica um campo contendo exclusivamente caracteres numéricos;
• ‘a’ indica um campo podendo conter qualquer caractere permitido, de acordo com “6.1. Formato genérico”;
• ‘a7’ indica um campo de exatamente 7 caracteres;
• ‘a..5’ indica um campo de 1 a 5 caracteres.

Campos

Código	Nome	Formato	Descrição
000-000	Comando	a3	Identifica o propósito do arquivo, conforme “Comandos existentes”.
001-000	Identificação	n..10	Número de controle gerado pela Automação Comercial, devendo o valor ser diferente para cada nova operação de TEF. É ecoado pelo PayGo nos arquivos de status e de resposta, e deve ser consistido pelo Automação Comercial.
002-000	Documento fiscal	n..12	Número do documento fiscal ao qual a operação de TEF está vinculada. Caso seja usada uma Impressora Fiscal, o preenchimento deste campo é obrigatório para transações de venda.
003-000	Valor total	n..12	Valor total da operação, em centavos da moeda informada no campo 004-000, incluindo todas as taxas cobradas do Cliente (serviço, embarque, etc.). No arquivo de resposta para transações de venda, este campo indica o valor efetivamente debitado do Cliente e creditado para o Estabelecimento (desconsiderando taxas referentes ao uso da solução, descontadas pela Rede Adquirente).
004-000	Moeda	n1	0: Real 1: Dólar americano 2: Euro
006-000	Entidade Cliente	a1	Forma de identificação do Cliente: F: CPF J: CNPJ X: Outro identificador, gerenciado pelo estabelecimento.
007-000	Identificador Cliente	n..16	Identificador do Cliente (somente números, sem formatação), de acordo com o campo 006-000, obrigatório caso este campo esteja presente. Caso informado pela Automação Comercial, este dado poderá ser utilizado pelo PayGo para transações que requeiram esta informação (por exemplo, fidelização), evitando assim uma dupla digitação na Automação Comercial e no PayGo.
009-000	Status	a..3	Indica o resultado final da operação de TEF: 0: operação bem-sucedida, ou transação aprovada; qualquer outro valor: erro na transação, ou transação negada.
010-000	Rede Adquirente	a..8	Codinome da Rede Adquirente que processou a transação. Para compatibilidade com versões futuras do produto (por exemplo, inclusão de novas redes), a Automação Comercial não deve consistir este campo, somente armazená-lo para consulta ou agrupamento de transações. Pelo mesmo motivo, é recomendado não preencher este campo no arquivo de solicitação para os comandos CRT e ADM. Caso seja preenchido, o PayGo processará a transação através da rede informada, sem apresentar o menu de seleção da Rede Adquirente.
011-000	Tipo de transação	n2	Venda ou cancelamento (de acordo com o campo 000-000): 10: Cartão de crédito – à vista 11: Cartão de crédito – parcelado pelo Estabelecimento 12: Cartão de crédito – parcelado pelo Emissor 20: Cartão de débito – à vista 22: Cartão de débito – parcelado pelo Estabelecimento 21: Cartão de débito – pré-datado 24: Cartão de débito – pré-datado forçada 30: PIX/Carteira digital 40: CDC / débito parcelado pelo Emissor 60: Voucher / PAT 30: Outro tipo de cartão 99: Não definido (a operação não foi concluída) Operação administrativa: 13: Pré-autorização com cartão de crédito 41: Consulta CDC / débito parcelado pelo Emissor 70: Consulta de cheque 71: Garantia de cheque 01: Fechamento / Finalização 00: Outra operação administrativa Este campo é obsoleto, foi substituído pelos campos 730-000, 731-000 e 732-000.
012-000	NSU	a..40	Identificador único da transação, atribuído pela Rede Adquirente. Por motivo de compatibilidade com versões anteriores desta especificação, a Automação deve sinalizar através do campo 706-000 que suporta o tamanho de 40 caracteres para este campo. Caso contrário, se a Rede Adquirente retornar um valor com mais de 12 caracteres, somente os 12 últimos serão considerados, prejudicando o uso desta informação (tipicamente, para cancelamento).
013-000	Código de autorização	a..6	Código de autorização, atribuído pelo Emissor.
017-000	Tipo de parcelamento	n1	0: parcelado pelo Estabelecimento; 1: parcelado pelo Emissor. Este campo é obsoleto, foi substituído pelo campo 732-000.
018-000	Qtde. parcelas	n..2	Quantidade de parcelas, para transações parceladas.
022-000	Data no comprovante	n8	Formato DDMMAAAA
023-000	Hora no comprovante	n6	Formato hhmmss.
024-000	Data pré-datado	n8	Data de agendamento da transação. Formato DDMMAAAA.
025-000	NSU original	a..40	Campo 012-000 correspondente à transação original, para transação cancelada
026-000	Data/hora rede original	n10	Data/hora da transação original, para transação cancelada. Formato DDMMhhmmss.
027-000	Código de controle	a..30	Identificador único da transação gerado pelo PayGo.
028-000	Tamanho via única	n..3	Quantidade de linhas da via única do comprovante.
029-xxx	Via única do comprovante	a..40	Linha da via única do comprovante, entre aspas duplas. xxx indica o número da linha, de 001 até a quantidade total de linhas indicada pelo campo 028-000.
030-000	Mensagem operador	a..40	Mensagem de texto que deve ser apresentada ao operador do sistema pela Automação Comercial.
040-000	Nome do cartão ou da administradora	a..12	Nome do cartão ou do Emissor. O mesmo cartão pode ter nomes diferentes de acordo com a Rede Adquirente utilizada. Por motivo de compatibilidade, a Automação Comercial não deve consistir este campo, somente armazená-lo para consulta ou agrupamento de transações
702-000	Índice do Estabelecimento	n..2	Índice do Estabelecimento, iniciado em 0. Exclusivamente para instalações específicas onde um mesmo Checkout pode realizar transações para vários Estabelecimentos. Este número é acrescentado à porta TCP configurada no PayGo Cliente, para conexão ao PayGo Servidor.
706-000	Capacidades da Automação	n..3	Soma dos seguintes valores, identificando as funcionalidades suportadas pela Automação Comercial: 1: funcionalidade de troco (ver campo 708-000) 2: funcionalidade de desconto (ver campo 709-000) 4: valor fixo, sempre incluir 8: vias diferenciadas do comprovante para Cliente/Estabelecimento (campos 712-000 a 715-000) 16: cupom reduzido (campos 710-000 e 711-000) 32: funcionalidade de valor devido (ver campo 743-000) 64: funcionalidade de valor reajustado (ver campo 744-000) 128: suporta NSU com tamanho de até 40 caracteres (campos 012-000 e 025- 000) 256: suporta índice da aplicação com tamanho de até 4 caracteres (campo 739-000) Caso este campo não seja informado pela Automação Comercial (versões anteriores), considera-se que nenhuma das funcionalidades é suportada. Importante: na certificação da CIELO, é exigido que a Automação Comercial implemente a funcionalidade de desconto.
707-000	Valor original	n12	Valor original da transação informado pela Automação Comercial no campo 003-000 do arquivo de solicitação, em centavos da moeda identificada no campo 004-000. Este campo é informado pelo PayGo caso seja diferente do valor final da transação informado no campo 003-000 do arquivo de resposta. A regra abaixo deve ser considerada, caso o campo 744-000 (valor reajustado) não seja informado: Valor total (003-000) = Valor original (707-000) + Valor do troco (708-000) – Valor do desconto (709-000) – Valor devido (743-000)
708-000	Valor do troco	n12	Valor de retirada em dinheiro (saque no cartão) realizada em conjunto com a transação de venda, em centavos da moeda informada no campo 004-000. Este valor é acrescido ao valor original da transação, e deve ser registrado na Impressora Fiscal como “troco”.
709-000	Valor do desconto	n12	Valor do desconto concedido ao Cliente pela Rede Adquirente ou pelo Emissor para uma transação de venda, em centavos da moeda informada no campo 004-000. Este valor é retirado do valor original da transação, e deve ser registrado na Impressora Fiscal como “desconto”.
710-000	Tamanho cupom reduzido	n..3	Quantidade de linhas do cupom reduzido.
711-xxx	Cupom reduzido	a..40	Linha do cupom reduzido, entre aspas duplas. xxx indica o número da linha, de 001 até a quantidade total de linhas indicada pelo campo 710-000.
712-000	Tamanho via Cliente	n..3	Quantidade de linhas da via diferenciada do comprovante destinada ao Cliente.
713-xxx	Via Cliente do comprovante	a..40	Linha da via do Cliente, entre aspas duplas. xxx indica o número da linha, de 001 até a quantidade total de linhas indicada pelo campo 712-000
714-000	Tamanho via Estabelecimento	n..3	Quantidade de linhas da via diferenciada do comprovante destinada ao Estabelecimento.
715-xxx	Via Estabelecimento do comprovante	a..40	Linha da via do Estabelecimento, entre aspas duplas. xxx indica o número da linha, de 001 até a quantidade total de linhas indicada pelo campo 714-000.
716-000	Empresa da Automação	a..40	Razão social da empresa responsável pelo desenvolvimento da aplicação de Automação Comercial. Exemplo: KND SISTEMAS LTDA
717-000	Data/hora fiscal	n12	Data/hora registrada no cupom fiscal, no formato AAMMDDhhmmss Caso seja usada uma Impressora Fiscal, o preenchimento deste campo é obrigatório para transações de venda.
718-000	Número lógico do terminal	a..50	Identificação do terminal
719-000	Código do estabelecimento	a..50	Identificação do estabelecimento.
722-000	Dados adicionais #1	a..128	Informações adicionais sob controle da Automação Comercial, para registro no histórico de transações do PayGo. Caso a Rede Adquirente suporte esta funcionalidade, este dado aparece como “dado adicional do estabelecimento” no extrato eletrônico.
723-000	Dados adicionais #2	a..128	Informações adicionais sob controle da Automação Comercial, para registro no histórico de transações do PayGo.
724-000	Dados adicionais #3	a..128	Informações adicionais sob controle da Automação Comercial, para registro no histórico de transações do PayGo.
725-000	Dados adicionais #4	a..128	Informações adicionais sob controle da Automação Comercial, para registro no histórico de transações do PayGo
726-000	Idioma do Cliente	a2	Idioma a ser utilizado para a interface com o Cliente (especialmente para autoatendimento): pt: português (valor padrão) en: inglês es: espanhol
727-000	Taxa de serviço	n..12	Valor correspondente à taxa de serviço cobrada adicionalmente aos produtos adquiridos, tipicamente no setor de alimentação (gorjeta), em centavos da moeda informada no campo 004-000. Este valor é incluído no valor total informado no campo 003-000.
728-000	Taxa de embarque	n..12	Valor correspondente às taxas cobradas pelos aeroportos, portos, rodoviárias, etc. adicionalmente ao valor da passagem adquirida, em centavos da moeda informada no campo 004-000. Este valor é incluído no valor total informado no campo 003-000.
729-000	Status da confirmação	n1	Indica o status da confirmação da transação, para transações bem-sucedidas (campo 009-000 = 0): 1: transação não requer confirmação, ou já confirmada 2: transação requer confirmação Para manter compatibilidade com versões de especificação anteriores, caso este campo não esteja presente no arquivo de resposta, assumir que a transação requer confirmação se houver comprovantes a serem impressos.
730-000	Operação	n..2	1: venda (pagamento de mercadoria/serviço) 51: cancelamento de venda / reembolso 2: pré-autorização 52: cancelamento de pré-autorização 3: consulta do cartão (de saldo, financiamento, etc.) 4: consulta de cheque 5: garantia de cheque 6: saque 8: doação (em dinheiro) 9: doação (com cartão) 10: pagamento de conta/boleto/fatura (em dinheiro) 60: cancelamento de pagamento de conta (dinheiro) 11: pagamento de conta/boleto/fatura (com cartão) 61: cancelamento de pagamento de conta (cartão) 12: compra de créditos / recarga de celular pré-pago (em dinheiro) 13: compra de créditos / recarga de celular pré-pago (com cartão) 48: fechamento/finalização 49: outra operação administrativa Para manter compatibilidade com versões de especificação anteriores, caso este campo não esteja presente no arquivo de resposta, verificar o campo 011-000.
731-000	Tipo de cartão	n..2	Modalidade da transação com cartão: 0: qualquer / não definido (padrão) 1: crédito 2: débito 3: voucher Importante: para compatibilidade com evoluções futuras, caso a Automação Comercial capture esta informação antes de acionar o PayGo, sempre deve oferecer para o usuário uma opção “outro” que alimente este campo com o valor 0. Para manter compatibilidade com versões de especificação anteriores, caso este campo não esteja presente no arquivo de resposta, verificar o campo 011-000.
732-000	Tipo de financiamento	n..2	Modalidade de financiamento da transação: 0: qualquer / não definido (padrão) 1: à vista 2: parcelado pelo Emissor 3: parcelado pelo Estabelecimento 4: pré-datado 5: pré-datado forçado Para manter compatibilidade com versões de especificação anteriores, caso este campo não esteja presente no arquivo de resposta, verificar os campos 011-000 e 017-000.
733-000	Versão da interface	n..3	Valor fixo, identificando a versão deste documento implementada pela Automação Comercial (somente números, por exemplo, 210 para “v2.10”)
734-000	Grupo de transações	n..10	(reservado para uso futuro) Para pagamento com múltiplos cartões, este campo deve conter o mesmo valor do campo 001-000 da primeira transação, e ser repetido com estemesmo valor a cada nova transação enquanto não for finalizado o pagamento em curso. Para confirmar ou desfazer o grupo de transações, um único comando CNF ou NCN é gerado, incluindo nos campos 010-xxx e 027-xxx (e, eventualmente, 702-xxx) os valores correspondentes às transações sendo confirmadas/desfeitas, na ordem em que foram realizadas.
735-000	Nome da Automação	a..40	Nome da aplicação de Automação Comercial.
736-000	Versão da Automação	a..20	Versão da aplicação de Automação Comercial, conforme nomenclatura utilizada pelo desenvolvedor.
737-000	Vias de comprovantes	n1	Indica quais vias devem ser impressas: 0: não há comprovante 1: imprimir somente a via do Cliente 2: imprimir somente a via do Estabelecimento 3: imprimir ambas as vias do Cliente e do Estabelecimento Para manter compatibilidade com versões de especificação anteriores, caso este campo não esteja presente no arquivo de resposta, assumir o valor: 0 se o campo 028-000 estiver igual a zero; 3 se o campo 028-000 estiver diferente de zero.
738-000	Registro de Certificação	a..20	Código obtido junto à PayGo no início do processo de certificação da Automação Comercial.
739-000	Índice da Rede Adquirente	n3	Índice da Rede Adquirente para o PayGo Novas Redes Adquirentes são acrescentadas periodicamente no sistema, por isso a Automação Comercial não deve restringir valores deste campo. Pelo mesmo motivo, é recomendado não preencher este campo no arquivo de solicitação para os comandos CRT e ADM. Caso seja preenchido, o PayGo processará a transação através da rede informada, sem apresentar o menu de seleção da Rede Adquirente
740-000	Número do cartão	n..19	Número do cartão utilizado na transação, sempre mascarado. (A máscara varia de acordo com a Rede Adquirente.)
741-000	Nome do Cliente	a..40	Nome do Cliente, extraído do cartão ou informado pelo emissor.
742-000	Nome do Produto	a..40	Nome do produto enviado na transação pela rede adquirente: - Recarga de celular: TIMTURBO 7, CLARO R$10, etc. - Transações de venda: CREDITO, MASTERCARD DEBITO, etc.
743-000	Valor devido	n12	Valor restante a pagar, em centavos da moeda informada no campo 004-000. Somente parte do valor foi autorizado, e a Automação deve solicitar outra forma de pagamento para completar a venda.
744-000	Valor reajustado	n12	Valor reajustado pela Rede Adquirente, conforme acordos contratuais com o estabelecimento, em centavos da moeda informada no campo 004-000. Este campo é informado pelo PayGo caso o valor enviado pela Automação Comercial tenha sido reajustado para mais ou para menos pela Rede Adquirente, respeitando a regra abaixo: Valor total (003-000) = Valor reajustado (744-000) + Valor do troco (708-000) – Valor do desconto (709-000) – Valor devido (743-000)
745-000	Não utilizado
746-000	Não utilizado
747-000	Data vencimento	n4	Data de vencimento do cartão (MMAA). Se a transação for realizada via tarja magnética, este campo pode não ser retornado, caso o padrão da trilha magnética do cartão seja diferente do padrão ISO7813.
748-000	Nome do cartão padronizado	a..50	Nome do cartão padronizado, este campo poderá ser utilizado pela automação para gerar relatório com base no nome do cartão. Caso o intuito for esse, utilizar este campo ao invés do 040-000.
749-000	Forma de pagamento	n..2	Modalidade de pagamento: 1: cartão 2: dinheiro 4: cheque 8: carteira digita
750-000	Forma de identificação do portador da carteira digital	n..3	1: QRCode do checkout (lido pelo celular do portador) 2: CPF 4: QRCode dinâmico (PIX/Carteira digital) 128: outra
751-000	Split de pagamento - Quantidade	n..2	Quantidade de ocorrências de registros 752-XXX
752-XXX	Split de pagamento - Registros	a...62	Informações de quebra do pagamento, separados por vírgula: - Identificador da conta de destino para a rede adquirente ou para a entidade responsável pela liquidação da transação. - Valor a ser pago nesta conta de destino, em centavos. Importante: a soma de todos os valores destes registros deve ser igual ao conteúdo do campo 003-000. Exemplo: 752-001: ABCDE1234,8500 752-002: QW9887RR,3000
999-999	Registro finalizador	n1	Conteúdo fixo: 0 (zero)