Upload
others
View
3
Download
0
Embed Size (px)
Citation preview
Gerenciador de pagamentos por token
Guia de implementação - Troca de arquivos
Versão do documento 2.2
Conteúdo
1. HISTÓRICO DO DOCUMENTO........................................................................................................3
2. ENTRAR EM CONTATO COM O SUPORTE TÉCNICO............................................................... 4
3. PRINCÍPIO GERAL............................................................................................................................. 53.1. Apresentação do serviço..............................................................................................................................53.2. Princípio de funcionamento.........................................................................................................................5
4. GERAR OS ARQUIVOS DE PAGAMENTO.....................................................................................74.1. Gerar um arquivo de pagamento (REQ).....................................................................................................74.2. Registrar um arquivo de pagamento........................................................................................................... 94.3. Recuperar o arquivo de retorno................................................................................................................ 104.4. Analisar o arquivo de retorno (ANS)....................................................................................................... 10
5. NOTIFICAÇÕES................................................................................................................................. 135.1. URL de notificação no final do pagamento..............................................................................................135.2. E-mail de confirmação de pagamento.......................................................................................................13
6. TESTE DO PAGAMENTO POR TOKEN CARTÃO.....................................................................146.1. Conectar-se ao Back Office comerciante..................................................................................................146.2. Entender o princípio de funcionamento....................................................................................................14
Verificar o formato do arquivo............................................................................................................ 15Importar um arquivo de pagamento..................................................................................................... 17
6.3. O resultado do pagamento teste................................................................................................................18
7. DICIONÁRIO DE DADOS................................................................................................................20
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 3 / 41
1. HISTÓRICO DO DOCUMENTO
Versão Autor Data Comentário
2.2 Lyra Network 18/04/2019 • Precisão adicionada sobre o tamanho máximo aconselhadodos arquivos de entrada (REQ).
• Precisões adicionadas sobre o principio de funcionamento dosarquivos _ERROR e _DUPLICATE.
• Fuso horário mencionado na totalidade do documento.
• Correção da linha 14 do formato dos registros de detalhe noarquivo de retorno (ANS).
2.1 Lyra Network 07/01/2019 Adição de precisões sobre os códigos retorno no capítulo Analisaro arquivo de retorno
2.0 Lyra Network 02/01/2017 Adição de capítulos para o teste de pagamento por código (Token).
1.9 Lyra Network 30/03/2016 Correção local Informações sobre o pedido 3 capítulo Gerar umarquivo de pagamento.
1.8 Lyra Network 17/12/2015 Adição do capítulo Dicionário de dados.
1.7 Lyra Network 19/06/2015 Modificação do capítulo Gerar um arquivo de pagamento.
1.6 Lyra Network 28/05/2015 Versão inicial em formato DITA
1.5 Lyra Network 02/07/2013 Versão inicial
Este documento e o seu conteúdo são estritamente confidenciais. Ele não é contratual. Qualquerreprodução e/ou distribuição deste documento ou de uma parte dele para um terceiro é estritamente
proibida ou sujeita a uma autorização prévia de Lyra Network. Todos os direitos reservados.
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 4 / 41
2. ENTRAR EM CONTATO COM O SUPORTE TÉCNICO
Procurando por ajuda? Confira nossa FAQ em nosso site
https://payzen.io/pt-BR/faq/sitemap.html
Para perguntas técnicas ou solicitação de assistência, nossos serviços estão disponíveis de segunda a sexta,de 8h às 17h
por telefone no:+55 (11) 3336-9217 ou +55 (11) 3336-9209 desde oBrasil
por e-mail: [email protected]és do seu Back OfficeEstabelecimento:
menu Ajuda > Entrar em contato com o suporte
Para facilitar o atendimento das suas solicitações, você deverá informar seu Shop ID (número com 8dígitos) .
Esta informação aparece no e-mail de cadastro da sua loja, ou no Back Office Estabelecimento (menuConfiguração > Loja > Configuração).
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 5 / 41
3. PRINCÍPIO GERAL
3.1. Apresentação do serviço
O serviço de troca de arquivos do módulo de gerenciamento dos pagamentos por token permite aos sitesdos estabelecimentos comerciais realizar operações de débito nos cartões de crédito dos seus clientesassinantes.
Este serviço permite realizar estas operações com um “tratamento por lote”: o site do estabelecimentocomercial envia á plataforma uma sucessão de ordens sob a forma de arquivos. A plataforma depagamento processa estas ordens e gera por sua vez arquivos de relatórios.
3.2. Princípio de funcionamento
O protocolo de transferência de arquivos usado é SFTP.
Durante uma transação SFTP, a plataforma de pagamento tem a função do servidor, e o site doestabelecimento comercial do cliente.
O acesso ao repertório onde serão armazenados os arquivos é protegido por um nome de usuário e umasenha que você recebeu na abertura do serviço.
Permanência dos dados
Os arquivos registrados pelo estabelecimento comercial no servidor FTP, ou gerados pela plataforma depagamento, são compressados após 7 dias.
A extensão .gz é adicionada ao nome do arquivo.
Os arquivos são definitivamente apagados 15 dias após a data de criação deles.
Somente a plataforma de pagamento apagará os arquivos.
O serviço tem 3 fases:
Fase de scan dos arquivos registrados
Uma tarefa automática permite recuperar a totalidade dos arquivos registrados no servidor FTP paraenviar-los à plataforma de pagamento para validação.
Fase de validação
Diversos controles são realizados antes do tratamento dos arquivos.
• Regras específicas para nomear cada tipo de arquivo devem ser aplicadas. Se um arquivo não respeitarestas regras de nomeação, a validação encerrará e o sufixo _ERROR será adicionado ao nome doarquivo.
• Análise do tamanho do arquivo.
Se um arquivo tiver o tamanho de 0 byte, a validação encerrará e o sufixo _ERROR será adicionado aonome do arquivo.
• A plataforma de pagamento salva o nome dos arquivos válidos tratados.
Na presença de um arquivo já tratado, a validação encerra e o sufixo _DUPLICATE é adicionado aonome do arquivo.
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 6 / 41
• Os arquivos cujo nome possuir um sufixo _DUPLICATE, _ERROR ou a extensão ".gz" não sãoconsiderados.
Os arquivos inválidos permanecem na pasta depot até ser apagados pelo estabelecimento comercial ouaté ser apagados automaticamente.
Fase de tratamento
Durante o tratamento de um arquivo válido, o arquivo de entrada (REQ) é enviado no repertório id.
Um arquivo de resposta (ANS) é criado no repertório id.
Se uma anomalia for detectada durante o tratamento, um e-mail de alerta será enviado aoestabelecimento comercial.
Observação
Todos os horários mencionados neste documento são baseados no horário local de Paris.
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 7 / 41
4. GERAR OS ARQUIVOS DE PAGAMENTO
Algumas etapas são requeridas para usar o serviço de troca de arquivos.
Estas etapas são as seguintes:
• Gerar um arquivo de solicitação de pagamento
• Registrar um arquivo de solicitação de pagamento
• Recuperar um arquivo de resposta
• Analisar um arquivo de resposta
Estas etapas são apresentadas nos capítulos seguintes.
4.1. Gerar um arquivo de pagamento (REQ)
O arquivo de solicitações de pagamento será constituído por uma sucessão de registros.
Chama-se "registro" uma lista de parâmetros separados pelo dígito ";", e finalizada com a tecla enter.Temos portanto um registro por linha.
Este tipo de formato é geralmente chamado “CSV” (Comma Separated Values) e é compatível com o MSExcel.
O arquivo terá a estrutura seguinte:
• Um registro cabeçalho apresentando informações sobre a transmissão.
• Um número variável de registros com as informações dos pagamentos que devem ser feitos.
• Um registro fim, que permite garantir a coerência do arquivo transmitido.
A quantidade de registros presentes no arquivo impacta diretamente o tempo de tratamento do arquivo bem como aentrega do arquivo de retorno.
Acima de 2000 registros, recomendamos gerar mais de um arquivo de pagamento.
Exemplo:
Um arquivo de teste é registrado o dia 30/11/2018 para a loja 12345678. Contém duas solicitações depagamento, com os parâmetros:
Primeira pagamento por Token cartão:
• ID: ‘TOKEN CARTÃO-TESTE-1’
• Número da transação: 000001
• Valor: 935,99 BRL
Segunda pagamento por código:
• ID: ‘TOKEN CARTÃO-TESTE-2’
• Número da transação: 000002
• Valor: 75,90 BRL
1. Dê um nome ao arquivo conforme o formato <AAAAMMDD>.<siteID>.PAY.REQ.<z>.<xx>.
Ou:
• <AAAAMMDD> representa a data de geração do arquivo.
• <siteID> representa o número da loja que foi atribuída para você (vads_site_id).
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 8 / 41
• <z> toma o valor « T » para um arquivo em modo de TESTE, ou o valor « P » para um arquivo emmodo PRODUÇÃO.
• <xx> corresponde ao número de sequência do arquivo durante o dia, com 2 dígitos numéricos.
O arquivo do exemplo se chama então 20181130.12345678.PAY.REQ.T.01
2. Informe o registro de cabeçalho com os valores apresentados abaixo:
Pos. Descrição Formato Valores Equivalência
01 Código de registro n2 00
02 Tipo de arquivo PAY
03 Versão do arquivo n2 02
04 Código da loja n8 12345678 vads_site_id
05 Ambiente (TESTE ou PRODUÇÃO) TEST vads_ctx_mode
06 Data de criação n8 No formato AAAAMMJJ
07 Hora de criação n6 No formato HHMMSS
08 Data de execução solicitada. n8 Reservado para um uso futuro.Não preencher
3. Informar todos os registros de detalhe conforme o formato abaixo:
Pos. Descrição Formato Valores Equivalência
01 Código de registro n2 02
02 Número de sequência do registrodetalhe no arquivo
n..6 Inicia com 1
03 Data da transação n8 No formato AAAAMMJJ vads_trans_date
04 Hora da transação n6 No formato HHMMSS vads_trans_date
05 Código de transação n..6 Único para o dia ecompartilhado com os outrosmeios de pagamento
vads_trans_id
06 Tipo de transação a2 CD
07 Valor n..12 Na sua menor unidademonetária.
vads_amount
08 Código da moeda n3 Ex: 986 para o real do Brasil(BRL)
vads_currency
09 Data de captura solicitada n8 No formato AAAAMMDDVazio para informar a data dodia
10 Modo de validação n..1 0: para validação automática1: para validação manualVazio: para usar o modo devalidação configurado porpadrão
vads_validation_mode
11 Token Cartão ans..50 Token cartão a ser usado para odébito
vads_identifier
12 Contrato comercial a ser usado ans..250 Deixar vazio para usar o padrão vads_contract_used
13 Referência do pedido ans..32 Deixar vazio se não usado vads_order_id
14 Informações sobre o pedido 1 ans..255 Deixar vazio se não usado vads_order_info
15 Informações sobre o pedido 2 ans..255 Deixar vazio se não usado vads_order_info2
16 Informações sobre o pedido 3 ans..255 Deixar vazio se não usado vads_order_info3
4. Informar o registro de fim conforme o formato abaixo:
Pos. Descrição Formato Valores
01 Código registro n2 01
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 9 / 41
Pos. Descrição Formato Valores
02 Número de registros detalhe enviados n..6 Ex:2.Recomendamos não ultrapassar 2000registros por arquivo.
Exemplo de arquivo:
Nome do arquivo: 20181130.12345678.PAY.REQ.T.01
00;PAY;02;12345678;TEST;20181130;102008;02;1;20181130;102008;000001;CD;93599;986;;;TOKEN CARTÃO-TESTE-1;;;;;02;2;20181130;102008;000002;CD;7590;986;;;TOKEN CARTÃO-TESTE-1;;;;;01;2
Para ajudar você durante a fase de integração, uma interface de validação está disponível no Back OfficeEstabelecimento no menu: Gerenciamento > Pagamentos recorrentes de TESTE > Pedido de pagamento.
Permite:
• verificar a estrutura de um arquivo a ser registrado
• importar um arquivo de pagamento de TESTE
• criar pagamentos de TESTE a partir do arquivo importado.
4.2. Registrar um arquivo de pagamento
A plataforma de pagamento trata arquivos de pagamento enviados pelo site do estabelecimentocomercial, duas vezes por dia todos os dias : uma vez as 7h00 e uma vez as 13h00, no fuso horário Europa/Paris.
Recomendados registrar os arquivos no servidor FTP antes das 6h50 hora de Paris, para o primeirotratamento e antes das 12h50 hora de Paris, para o segundo.
1. Conecte-se ao servidor FTP:
Em SFTP:
• Host: sftp://vadftp.lyra-network.com
• port: 223
2. Registre seu arquivo na pasta [Shop ID] > depot.
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 10 / 41
4.3. Recuperar o arquivo de retorno
A plataforma de pagamento trata arquivos de pagamento enviados pelo site do estabelecimentocomercial, duas vezes por dia, todos os dias : uma vez as 7h00 e uma vez as 13h00, no fuso horário Europa/Paris.
1. Conecte-se ao servidor FTP.
2. Selecione o repertório [Código loja] >id.
O arquivo de resposta está disponível entre 8h00 e 9h00 e entre 14h00 e 15h00, no fuso horário Europa/Paris.
O arquivo de resposta associado é chamado da seguinte forma:
<AAAAMMJJ>.<siteID>.PAY.ANS.<z>.<xx>
Ou:
• <AAAAMMDD> representa a data de geração do arquivo.
• <siteID> representa o número da loja que foi atribuído para você.
• <z> toma o valor « T » para um arquivo em modo de TESTE, ou o valor « P » para um arquivo emmodo PRODUÇÃO.
• <xx> corresponde ao número de sequência do arquivo durante o dia, com 2 dígitos numéricos.
Verifique a presença de um arquivo de erro (_ERROR ou _DUPLICATE) no repertório depot se você nãoencontrar seu arquivo de retorno no repertório id.
4.4. Analisar o arquivo de retorno (ANS)
Há 2 categorias de erro:
• Os erros de formato e/ou de valorização de campo.
• Os erros relativos à execução dos pagamentos.
O tratamento realizado pela plataforma é operado em duas fases:
• A primeira fase verifica a integridade do arquivo e detecta os erros de formato e/ou de valorização. Emcaso de erro, o arquivo é recusado na íntegra.
Esta primeira fase somente realiza controles na globalidade do arquivo. Os casos de erro nos registrosdetalhe são tratados na segunda fase.
• A segunda fase realiza os pagamentos, linha por linha. Em caso de erro em um dos parâmetros(exemplo: código não encontrado, moeda incorreta, etc.), o código de tratamento terá o valor de 30no registro detalhe, e um campo adicional definirá a posição do dado em questão. Em caso de recusade pagamento, a procedência da recusa será informada no registro de detalhe.
No primeiro caso de erro, o arquivo de resultado somente conterá um registro no cabeçalho paramaterializar a ocorrência e um registro de fim. O estabelecimento comercial deverá apresentar de novo oarquivo após corrigí-lo e alterar o nome do arquivo enviado.
No segundo caso, o arquivo de resultado conterá o mesmo número de registros de detalhe que o arquivode solicitação. Somente os pagamentos com um erro em um dos parâmetros deverão ser apresentadosde novo pelo estabelecimento comercial.
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 11 / 41
Se ocorrer um incidente de funcionamento e que a plataforma não pôde processar o arquivo no devidotempo, os tratamentos faltando serão realizados após a volta em operação do serviço. Portanto, ospagamentos não tratados não devem ser apresentados de novo em um novo arquivo.
Segue a resposta a nosso arquivo de exemplo 20161130.12345678.PAY.REQ.T.01
O nome do arquivo de resposta é 20161130.12345678.PAY.ANS.T.01.
Seu conteúdo é:
00;PAY;02;0;;12345678;TEST;20161130;102008;20140922;14134902;1;20161130;102008;000001;CD;3299;986;20140922;0;MEU-CÓDIGO-TESTE-1;FR7630002005701234567890158;;;;;00;0;;FULL;20140922;141350;00;FR7630002005701234567890158_CRLYFRPP;2017092202;2;20161130;102008;000002;CD;790;986;20140922;0;MEU-CÓDIGO-TESTE-1;FR7630002005701234567890158;;;;;00;0;;FULL;20140922;141351;00;FR7630002005701234567890158_CRLYFRPP;2017092201;2;2;0
Formato de registro de cabeçalho:
Pos. Descrição Formato ValoresCorrespondência nodicionário de dados
01 Código registro n2 00
02 Tipo de arquivo PAY
03 Versão de arquivo n2 02
04 Código de retorno da primeira fase dotratamento
n1 0: Processamento realizado1: Erro de formato2: Erro de valorização
05 Informação sobre o erro ans..255 Complemento de informaçãosobre o erro, vazio se foirealizado com sucesso.
06 Shop ID n8 Igual solicitação se válido. vads_site_id
07 Ambiente Igual solicitação se válido. vads_ctx_mode
08 Data de criação n8 Igual solicitação se válido.
09 Hora de criação n6 Igual solicitação se válido.
10 Data de fim de tratamentoNo formato AAAAMMJJ
n8 20161130
11 Hora de fim de tratamento n6 130019
Formato dos registros de detalhe:
Pos. Descrição Formato ValoresCorrespondência nodicionário de dados
01 Código registro n2 02
02 Número de seqüência n..6 Idem solicitação
03 Data da transação (igual solicitação) n8 Idem solicitação vads_trans_date
04 Hora da transação (igual solicitação) n6 Idem solicitação vads_trans_date
05 Código de transação (igual solicitação) n..6 Idem solicitação vads_trans_id
06 Tipo de transação (igual solicitação) a2 CD
07 Valor (igual solicitação) n..12 Idem solicitação vads_amount
08 Moeda n3 Idem solicitação vads_currency
09 Valor em contravalor euro n..12 Idem solicitação vads_effective_amount
10 Moeda em contravalor n3 Idem solicitação
11 Data de captura solicitada n8 Idem solicitação
12 Modo de validação n1 0 se validação automática1 se validação manual
vads_validation_mode
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 12 / 41
Pos. Descrição Formato ValoresCorrespondência nodicionário de dados
13 Código de cartão ans..50 Idem solicitação vads_identifier
14 Número de contrato n7 Número de contrato usado paratratar a solicitação
15 Referência do pedido ans..32 Idem solicitação vads_order_id
16 Informações de transação 1 ans..255 Idem solicitação vads_order_info
17 Informações de transação 2 ans..255 Idem solicitação vads_order_info2
18 Informações de transação 3 ans..255 Idem solicitação vads_order_info3
19 Código retorno do tratamento Exemplos:
• 00: Realizado com sucesso -Pagamento aceito
• 05: Realizado com sucesso -Pagamento recusado
• 30: Erro de parâmetro.Um complemento deinformação está disponívelno campo 25
• 96: Erro técnico
vads_result
20 Código retorno de autorização an..2 Valor retornado pelo servidorde autorização.Ver a lista dos códigos nocapítulo dicionário de dados.Vazio se não aplicável.
vads_auth_result
21 Número de autorização retornadopelo adquirente
n6 não aplicável vads_auth_number
22 Modo de autorização FULL vads_auth_mode
23 Data de autorização n8 No formato AAAAMMJJ
24 Hora de autorização n6 No formato HHMMSS
25 Código retorno adicional ans..255 Contém o retorno do módulode controle dos riscos (secontratado), ou o local docampo incorreto em caso deerro 30.Ver a lista dos códigos nocapítulo dicionário de dados.Vazio se não aplicável.
vads_extra_result
26 Número do meio de pagamento (nº decartão ou nº IBAN e BIC
an..36 Parte do número do meio depagamento. (ex: IBAN_BIC)O BIC é opcional, portanto, onúmero pode ser somente oIBAN.
vads_card_number
27 Data de vencimento n8 No formato AAAAMMDD Vaziose não aplicável
Formato de registro de fim:
Pos. Descrição Formato Valores
01 Código registro n2 01
02 Número total de registros detalhe enviados n..6
03 Número de pagamentos realizados com sucesso n..6
04 Número de pagamentos falhados n..6
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 13 / 41
5. NOTIFICAÇÕES
5.1. URL de notificação no final do pagamento
A url de notificação não será chamada durante o tratamento do arquivo.
Somente a análise do arquivo de resposta (disponível no repertório /id) permitirá ao estabelecimentocomercial atualizar seu sistema de informação.
5.2. E-mail de confirmação de pagamento
Nenhum e-mail de confirmação será enviado pela plataforma de pagamento ao comprador ou aoestabelecimento comercial se o pagamento foi aceito.
Nenhum e-mail de advertência será enviado ao estabelecimento comercial se o pagamento foi recusado.
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 14 / 41
6. TESTE DO PAGAMENTO POR TOKEN CARTÃO
6.1. Conectar-se ao Back Office comerciante
Seu Back Office está acessível no seguinte URL:
https://secure.payzen.com.br/vads-merchant/
1. Digite seu login.
Você recebeu seu login por e-mail, com o assunto Dados de conexão - [nome da sua loja].
2. Digite sua senha.
Você recebeu sua senha por e-mail, com o assunto Dados de conexão - [nome da sua loja].
3. Clique em Validar.
Após 3 erros de digitação da senha, a conta usuário será bloqueada. Clique então no link Esqueceu asenha ou conta bloqueada para redefinir.
6.2. Entender o princípio de funcionamento
Os arquivos registrados no servidor FTP são tratados 2 vezes por dia.
Para não dificultar a implementação da solução de pagamentos por Token Cartão em modo arquivo, oestabelecimento comercial pode testar mediante solicitação seus arquivos de pagamento em modo TESTEno Back Office Estabelecimento.
1. Clique no menu Gerenciamento > Pagamentos recorrentes de TESTE
A página das assinaturas de TESTE abre.
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 15 / 41
2. Clique em Pedido de pagamento
Duas ações podem ser escolhidas:
• Verificar o formato do arquivo.
• Importar um arquivo de pagamento.
Verificar o formato do arquivo
Esta opção permite aplicar diversos controles na estrutura do seu arquivo.
Quando você seleciona Verificar o formato do arquivo, a caixa de diálogo de importação abre.
1. Clique em Navegar
2. Selecione o arquivo para importar.
O tamanho do arquivo não deve ultrapassar 1 ko.
O arquivo é de tipo CSV e seu nome deve respeitar a regra estabelecida no capítulo Gerar um arquivode pagamento. Exemplo : 20161229.91335531.PAY.REQ.T.01
3. Clique em Verificar
Se a estrutura do arquivo estiver correta, a mensagem aparecerá.
Se a estrutura do arquivo estiver incorreta, um relatório abrirá e indicará a linha do erro detectado.
Exemplo :
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 16 / 41
Os quadros abaixo apresentam os diferentes tipos relativos à estrutura.
• Erro de formato do arquivo
Mensagem de erro Descrição
O tamanho do arquivo especificado ultrapassa o máximoautorizado
O tamanho do arquivo não deve ultrapassar 1 ko.Recomendamos portanto criar o arquivo a partir desoftwares tais como Bloco de notas, Notepad++, etc.
Tipo de arquivo incorreto Seu arquivo não respeita as regras de atribuição de nomeapresentados no capítulo Gerar um arquivo de pagamento
• Erros na linha Registro de cabeçalho
Mensagem de erro Descrição
Tipo header esperado (código registro 00)
Header mal colocado (deveria estar na primeira linha)
A primeira linha do arquivo corresponde ao registro decabecalho e deve iniciar por 00
Quantidade de coluna inválida O registro de cabeçalho deve ter 8 colunas.
PAY não presente no header (null) O campo n°2 do registro de cabeçalho deve ter o valor de PAY
Versão de header incorreto (null) O campo n°3 deve ter o valor 01
Identificação loja incorreto (null) O shop ID deve ter 8 dígitos
Ambiente incorreto (null) Dois valores possíveis: TESTE ou PRODUÇÃO
Somente as transações em modo TESTE são possíveis Você não pode registrar um arquivo de pagamento em modoPRODUÇÃO
Data ou hora de criação incorreta A data deve ter o formato aaaaMMdd.A hora deve ter o formato HHmmSS.
Data de execução não vazia Este campo não deve ser preenchido. Deve permanecervazio.
Header não corresponde ao nome arquivo O header e o nome do arquivo devem ter os mesmos valores:
• de shop ID,
• de ambiente,
• de data de criação.
Exemplo:Nome de arquivo: 20161229.91335531.PAY.REQ.T.01Header :
00;PAY;02;91335531;TEST;20161229;140800;
• Erros na linha Registro de detalhe
Mensagem de erro Descrição
Número de seqüência incorreto (campo 2) Deve obrigatoriamente iniciar por 1.Já que o formato (n..6) da sequência é de 6 dígitos,aconselhamos escolher os números 000001, 000002, etc.para evitar erros.
Quantidade de coluna inválida Cada registro de detalhe deve ter 16 colunas.
• Erros na linha Registro de fim
Mensagem de erro Descrição
Sem trailer (código registro 01) A última linha do arquivo deve conter o trailer e iniciar por 01.
Quantidade de coluna inválida O registro de fim deve ter 2 colunas.
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 17 / 41
Mensagem de erro Descrição
Número de registros incorreto Deve corresponder à quantidade exata de registros enviados.Quando o registro de detalhe tiver:
• uma linha de registro, o valor é 1.
• duas linhas de registro, o valor é 2.
• três linhas de registro, o valor é 3.
• etc.
• Outros erros técnicos
Mensagem de erro Descrição
Tipo de linha não reconhecida Nenhuma linha do arquivo presente antes o registro finalpode estar vazia. Todas as linhas devem iniciar por 00 ou 01ou 02.
Dados após fim de arquivo Nenhuma linha (vazia ou não) pode estar presente após oregistro final.
Importar um arquivo de pagamento
Esta opção permite aplicar diversos controles de estrutura e o conteúdo do seu arquivo para realizarpagamentos a partir das informações contidas nele.
Uma vez o arquivo importado e processado, a plataforma gera um arquivo de resposta que será enviadopor e-mail ao endereço especificado durante a importação.
Advertência : Se o arquivo apresentar erros de estrutura, ele será recusado e nenhum relatório serágerado. É portanto importante realizar a fase inicial de verificação do arquivo.
Quando você seleciona Importar um arquivo de pagamento, a caixa de diálogo abre.
1. Clique em Navegar
2. Selecione o arquivo para importar.
O tamanho do arquivo não deve ultrapassar 1 ko.
O arquivo é de tipo CSV e seu nome deve respeitar a regra estabelecida no capítulo Gerar um arquivode pagamento. Exemplo : 20161229.91335531.PAY.REQ.T.01
3. Digite o endereço e-mail que vai receber o resultado dos pagamentos.
4. Clique em Importar
Se a estrutura e o conteúdo estiverem corretos, o detalhe do pagamento abrirá sem nenhum errodetectado.
Se a estrutura e/ou o conteúdo do arquivo estiverem incorretos, um relatório abrirá e indicará a linha doerro detectado.
Exemplo :
Os quadros abaixo apresentam os diferentes tipos relativos à estrutura e/ou ao conteúdo.
• Erros na linha Registro de cabeçalho
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 18 / 41
Mensagem de erro Descrição
Loja desconhecida O número de loja especificado no arquivo deve correspondera um das lojas que você gerencia via sua conta de acesso aoBack Office.
• Erros na linha Registro de detalhe
Mensagem de erro Descrição
Erro de formato em DATA_TRANSAÇÂO A data deve ter o formato aaaaMMdd.
Erro de formato em HORA-TRANSAÇÃO A hora no formato HHmmSS
Erro de formato em ID_TRANSAÇÂO O formato deste campo deve ter 6 dígitos numéricos.
O código de transação informado já está sendo usado O número de transação deve ser único a cada dia e a cadaloja.
Erro de formato em TIPO_TRANSAÇÂO Deve ter o valor de CD.
Erro de formato em VALOR (campo 7) O valor deve ser apresentado na menor unidade da moeda.Ex: 3000 para 30,00 BRL
Erro de formato em MOEDA (campo 8) Código numérico de 3 dígitos conforme a norma ISO 4217.Ex: 986 para o real do Brasil (BRL)
Erro de formato em DATA_CAPTURA (campo 9) A data deve ter o formato aaaaMMdd.
Erro de formato em MODO_VALIDAÇÃO Valores possíveis:
• 0 (validação automática),
• 1 (validação manual),
• vazio (configuração padrão como definido no Back OfficeEstabelecimento)
O código do cartão especificado é desconhecido Os códigos especificados devem constar no modo Assinaturade TESTE.
Erro de formato em CÓDIGO_CARTÃO O código não pode estar vazio.
O contrato especificado é desconhecido (campo 12) Este campo facultativo deve ser valorizado.
• Erros na linha Registro de fim
Mensagem de erro Descrição
Sem trailer (código registro 01) A última linha do arquivo deve conter o trailer e iniciar por 01.
Quantidade de coluna inválida O registro de fim deve ter 2 colunas.
Número de registros incorreto Deve corresponder à quantidade exata de registros enviados.Quando o registro de detalhe tiver:
• uma linha de registro, o valor é 1.
• duas linhas de registro, o valor é 2.
• três linhas de registro, o valor é 3.
• etc.
• Outros erros técnicos
Mensagem de erro Descrição
Tipo de linha não reconhecida Nenhuma linha do arquivo presente antes o registro finalpode estar vazia. Todas as linhas devem iniciar por 00 ou 01ou 02.
Dados após fim de arquivo Nenhuma linha (vazia ou não) pode estar presente após oregistro final.
6.3. O resultado do pagamento teste
Uma vez o arquivo importado e tratado, a plataforma gera um arquivo de resposta que será enviado emanexo de e-mail ao endereço especificado durante a importação.
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 19 / 41
O arquivo recebido é de tipo CSV e seu tamanho máximo é de 1 ko. É nomeado conforme a regraestabelecida no capítulo Recuperar o arquivo de retorno. Exemplo : 20161229.91335531.PAY.ANS.T.01
O corpo do e-mail apresenta o resultado da transação após sua solicitação de pagamento por arquivo deToken Cartão.
O resultado do pagamento é exibido na aba Transações em andamento das transações de teste doseu Back Office Estabelecimento. Você pode visualizar o detalhe da transação clicando duas vezes natransação.
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 20 / 41
7. DICIONÁRIO DE DADOS
Esta capítulo apresenta a lista dos campos que podem ser usados para um pagamento por troca de arquivo.
Para ver todos os campos existentes, favor consultar o Guia de implementaçãoAPI Formulário disponívelno site de documentações e suporte : https://payzen.io/pt-BR/.
vads_amount
Descrição Valor da transação apresentado na menor unidade da moeda (o centavo para o realbrasileiro)..
Exemplo : para uma transação de 10 BRLe 28 centavos, lo valor do parâmetro é 1028.
O formulário de pagamento será recusado nos seguintes casos:
• Um valor igual a zero [vads_amount=0],
• Um valor negativo [vads_amount=-100],
• Um valor composto de decimais ou de pontos [vads_amount=100.50],
• Um formulário sem o campo vads_amount (ausência de valor).
Uma mensagem de incidente técnico será associada a um código retorno 09(vads_extra_result).
Campo de entrada e de saída, retornado na resposta (IPN e URL de retorno).
Formato n..12
Código de erro 09
Categoria Informações sobre a transação.
vads_auth_number
Descrição Número de autorização devolvido pelo servidor do banco, se disponível (se nãovazio).
Campo de saída, retornado na resposta (IPN e URL de retorno).
Formato an..6
Categoria Informações sobre a transação.
vads_auth_mode
Descrição Especifica de que maneira é realizada a solicitação de autorização.
Campo de saída, retornado na resposta (IPN e URL de retorno).
Formato enum
Valores possíveisFULL: corresponde a uma autorização do valor total da transação.
Valor usado no caso de um pagamento à vista, se o tempo entre a data de capturapedida e a data do dia vigente for exatamente inferior ao tempo de validade daautorização.
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 21 / 41
MARK : corresponde a uma autorização de 1 BRL.
Valor usado no caso de um pagamento pré-datado, se o tempo entre a data decaptura pedida e a data do dia vigente for exatamente superior ao tempo de validadeda autorização.
Categoria Informações sobre a transação.
vads_auth_result
Descrição Código retorno da solicitação de autorização devolvida pelo banco emissor, sedisponível.
Campo de saída, retornado na resposta (IPN e URL de retorno).
Formato an..3
Valores possíveis
Código Descrição
000 Aprovada
001 Aprovada com documento de identidade
002 Autorização parcial (Somente cartões pré-pagos)
100 Recusada
101 Cartão vencido / Data de vencimento inválida
106 Número de tentativas autorizadas de digitação do NIP ultrapassado
107 Favor entrar em contato com o emissor
109 Vendedor inválido
110 Valor inválido
111 Conta inválida / MICR inválido
115 Função solicitada não suportada
117 NIP inválido
119 Titular não inscrito / não autorizado
122 Código de segurança do cartão inválido (token cartão NIC/C4C)
125 Data de entrada em vigor inválida
181 Erro de formato
183 Código da moeda inválido
187 Recusada - Novo cartão emitido
189 Recusada - Conta cancelada
200 Recusada - Retirar Cartão
900 Aceita - Sincronização ATC
909 Desfuncionamento do sistema (erro criptográfico)
912 Emissor não disponível
Tabela 1 : Códigos retornados pelo adquirente Amex Global
Código Descrição
0 Transação aprovada ou realizada com sucesso
2 Limite ultrapassado
4 Guardar o cartão
5 Não honrar
96 Mau funcionamento do sistema
97 Prazo de tempo limite de segurança global
Tabela 2 : Códigos retornados pelo adquirente American Express
Código Descrição Rechamada autorizada
1 Transação não autorizada. Transação referida.
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 22 / 41
Código Descrição Rechamada autorizada
2 Transação não autorizada. Transação referida.
3 Transação não permitida. Erro no cadastro do código do estabelecimento no arquivode configuração do TEF
Sim
4 Transação não autorizada. Cartão bloqueado pelo banco emissor. Sim
5 Transação não autorizada. Cartão inadimplente (Do not honor). Sim
6 Transação não autorizada. Cartão cancelado.
8 Transação não autorizada. Código de segurança inválido.
12 Transação inválida, erro no cartão. Sim
13 Transação não permitida. Valor da transação Inválido. Sim
14 Transação não autorizada. Cartão Inválido Sim
15 Banco emissor indisponível ou inexistente. Sim
19 Faça de novo a transação ou tente novamente mais tarde.
22 Parcelamento inválido. Número de parcelas inválidas.
23 Transação não autorizada. Valor da prestação inválido.
24 Quantidade de parcelas inválida.
25 Pedido de autorização não enviou número do cartão
28 Arquivo temporariamente indisponível.
30 Transação não autorizada. Decline Message
39 Transação não autorizada. Erro no banco emissor.
41 Transação não autorizada. Cartão bloqueado por causa de perda. Sim
43 Transação não autorizada. Cartão bloqueado por causa de roubo. Sim
51 Transação não autorizada. Limite excedido/sem saldo.
52 Cartão com dígito de controle inválido.
53 Transação não permitida. Cartão poupança inválido
55 Transação não autorizada. Senha inválida
57 Transação não permitida para o cartão Sim
58 Transação não permitida. Opção de pagamento inválida.
59 Transação não autorizada. Suspeita de fraude. Sim
60 Transação não autorizada.
61 Banco emissor indisponível.
62 Transação não autorizada. Cartão restrito ao uso doméstico
63 Transação não autorizada. Violação de segurança Sim
64 Transação não autorizada. Valor abaixo do mínimo exigido pelo banco emissor.
65 Transação não autorizada. Quantidade excedida de transações para o cartão.
67 Transação não autorizada. Cartão bloqueado para compras hoje.
70 Transação não autorizada. Limite excedido/sem saldo.
74 Transação não autorizada. A senha está vencida.
78 Transação não autorizada. Cartão bloqueado primeiro uso.
80 Transação não autorizada. Divergência na data de transação/pagamento.
82 Transação não autorizada. Cartão inválido.
83 Transação não autorizada. Erro no controle de senhas
85 Transação não permitida. Falha da operação.
86 Transação não permitida. Falha da operação.
89 Erro na transação.
90 Transação não permitida. Falha da operação.
91 Transação não autorizada. Banco emissor temporariamente indisponível.
92 Transação não autorizada. Tempo de comunicação excedido.
93 Transação não autorizada. Violação de regra - Possível erro no cadastro.
96 Falha no processamento
97 Valor não permitido para essa transação.
98 Sistema/comunicação indisponível.
99 Sistema/comunicação indisponível.
999 Sistema/comunicação indisponível.
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 23 / 41
Código Descrição Rechamada autorizada
AC Transação não permitida. Cartão de débito sendo usado com crédito. Use a funçãodébito.
AF Transação não permitida. Falha da operação.
AG Transação não permitida. Falha da operação.
AH Transação não permitida. Cartão de crédito sendo usado com débito. Use a funçãocrédito.
AI Transação não autorizada. Autenticação não foi realizada.
AJ Transação não permitida. Transação de crédito ou débito em uma operação quepermite apenas Private Label. Tente novamente selecionando a opção Private Label.
AV Transação não autorizada. Dados Inválidos
BD Transação não permitida. Falha da operação.
BL Transação não autorizada. Limite diário excedido.
BM Transação não autorizada. Cartão Inválido
BN Transação não autorizada. Cartão ou conta bloqueado.
BO Transação não permitida. Falha da operação.
BP Transação não autorizada. Conta corrente inexistente.
CF Transação não autorizada.C79:J79 Falha na validação dos dados.
CG Transação não autorizada. Falha na validação dos dados.
DA Transação não autorizada. Falha na validação dos dados.
DF Transação não permitida. Falha no cartão ou cartão inválido.
DM Transação não autorizada. Limite excedido/sem saldo.
DQ Transação não autorizada. Falha na validação dos dados.
DS Transação não permitida para o cartão.
EB Transação não autorizada. Limite diário excedido.
EE Transação não permitida. Valor da parcela inferior ao mínimo permitido.
EK Transação não permitida para o cartão.
FC Transação não autorizada. Ligue Emissor
FG Transação não autorizada. Ligue AmEx.
GD Transação não permitida.
HJ Transação não permitida. Código da operação inválido.
IA Transação não permitida. Indicador da operação inválido.
JB Transação não permitida. Valor da operação inválido.
KA Transação não permitida. Falha na validação dos dados.
KB Transação não permitida. Opção selecionada incoerente.
KE Transação não autorizada. Falha na validação dos dados.
N7 Transação não autorizada. Código de segurança inválido.
R1 Transação não autorizada. Cartão inadimplente (Do not honor).
U3 Transação não permitida. Falha na validação dos dados.
Tabela 3 : Códigos retornados pelo adquirente Cielo
CódigoDescrição Código Descrição
1 Consulte o emissor do cartão 82 CVV incorreto
2 Consulte o emissor do cartão , condição especial 85 Não há razão para recusar um pedido de verificaçãode número de conta, verificação de endereço ,verificação CVV2 , ou um retorno voucher de créditoou mercadoria
3 Estabelecimento inválido 86 Não é possível verificar PIN
4 Transação não autorizada pelo emissor do cartão -Reter cartão
91 Emissor indisponível ou inoperante
5 Não Autorizada pelo emissor do cartão 92 Destino não pode ser encontrado para o roteamento
6 Erro 93 Transação não pode ser concluída ; Violação da lei
7 Transação não autorizada pelo emissor do cartão,condição especial
96 Mau funcionamento do sistema
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 24 / 41
CódigoDescrição Código Descrição
12 Transação inválida B1 Sobretaxa quantidade não permitida em cartões Visa( adquirentes dos EUA somente)
13 Valor inválido ou valor superior ao limite do cartão E0 Recusada (estrutura inválida mensagem ouincompatibilidade de tipo)
14 Cartão inválido E1 Recusada (Credenciais do Estabelecimento inválido)
15 Emissor sem comunicação E2 Recusada (Estabelecimento não habilitado)
19 Refaça a transação E3 Recusada (Transação não encontrada)
21 Transação capturada não localizada E4 Recusada (Transação não duplicada)
25 Não foi possível localizar registro no arquivo ounúmero de conta está faltando no inquérito
E5 Recusada (tipo de transação não é suportado oudisponível / habilitada para o estabelecimento)
28 Arquivo está temporariamente indisponível E6 Recusada (Inconsistência / Valor inválido / outras deregras de negócio)
41 Transação não autorizada pelo emissor do cartão -Reter cartão
E7 Recusada (status de transação não permite a operaçãosolicitada)
43 Transação não autorizada pelo emissor do cartão -Reter cartão
E8 Recusada (falta campos necessários / obrigatório)
51 Transação não autorizada pelo emissor do cartão -Limite excedido
EX Transação Expirada (O tempo para este tipo detransação foi expirado)
52 Sem conta corrente N0 Força STIP
53 Não tem conta poupança N3 Serviço de caixa não disponível
54 Cartão expirado N4 Cashback pedido excede o limite de emissor
55 PIN incorreto N7 Declínio para o fracasso CVV2
57 Transação não permitida para o cartão ND Transação Recusada
58 Transação não permitida para o terminal P2 Informações faturamento inválido
59 Suspeitas de fraude P5 PIN Alterar / pedido Desbloquear
61 Transação negada - Limite excedido P6 PIN inseguro
62 Cartão restrito Q1 Autenticação de cartão falhou
63 Violação de Segurança R0 Pare Ordem de Pagamento
64 Transação não cumpriu a exigência AML R1 Revogação da autorização Order
65 Limite de contagem de Atividade excedido R3 Revogação de todas as autorizações Order
75 Senha bloqueada. Excedeu tentativas de cartão. SU Sistema Temporariamente Indisponível (se persistir,entre em contato Elavon)
76 Não foi possível localizar mensagem anterior(Problemas com o número de referência datransação)
TO Timed out (Se persistir, contate Elavon)
77 Mensagem original localizada para uma repetiçãoou cancelamento, porém os dados da repetição/cancelamento não conferem com os dados damensagem original.
UE Erro inesperado (Se ele persistir, contate Elavon)
78 " Bloqueado , usado pela primeira vez " - Atransação é de um novo titular do cartão e o cartãonão foi devidamente desbloqueado.
XA Encaminhar ao emissor
80 Transações Visa : Emissor indisponível . Private labele aceitação de verificação : Data inválida
XD Encaminhar ao emissor
81 PIN encontrado erro de criptografia (erroencontrado pelo módulo de segurança VIC durante adescriptografia PIN)
Z3 Incapaz de ir on-line ; declinou
Tabela 4 : Códigos retornados pelo adquirente Elavon
Código Descrição Código Descrição
1 Transação referida. Solicite ao cliente contatar oemissor
N5 Transação não aprovada. Solicite ao cliente contatar oemissor
2 Transação referida. Solicite ao cliente contatar oemissor
N6 Transação não aprovada. Solicite ao cliente contatar oemissor
3 Estabelecimento invalido N7 Cvv2 invalido
4 Transação não aprovada. Solicite ao clientecontatar o emissor
N8 Transação não aprovada. Solicite ao cliente contatar oemissor
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 25 / 41
Código Descrição Código Descrição
5 Transação não aprovada. Solicite ao clientecontatar o emissor
N9 Transação não aprovada. Solicite ao cliente contatar oemissor
6 Erro no processamento O0 Sistema do emissor indisponivel. Tente novamente
8 Transação aprovada sob identificacao O1 Sistema do emissor indisponivel. Tente novamente
10 Transação não autorizada O2 Valor invalido. Tente novamente
12 Transação invalida O3 Transação não aprovada. Solicite ao cliente contatar oemissor
13 Valor da transação invalido O4 Transação não aprovada. Solicite ao cliente contatar oemissor
14 Cartão invalido O5 Senha invalida. Tente novamente
15 Cartão não pertence a rede getnet O6 Numero do cartão invalido
19 Emissor temporariamente fora de operacao O7 Transação não aprovada. Solicite ao cliente contatar oemissor
23 Cartão excedeu o limite para parcelamento O8 Transação não aprovada. Solicite ao cliente contatar oemissor
27 Transação não permitida p/ produto. Ligue getnet O9 Solicite ao cliente contatar o emissor
28 Quantidade de parcelas não permitida p/produto. Ligue getnet
P0 Solicite ao cliente contatar o emissor
30 Erro de formato. Tente novamente P1 Limite de saque excedido
31 Instituicao não pertence a rede getnet P2 Solicite ao cliente contatar o emissor
33 Transação não aprovada. Solicite ao clientecontatar o emissor
P3 Solicite ao cliente contatar o emissor
36 Transação não aprovada. Solicite ao clientecontatar o emissor
P4 Solicite ao cliente contatar o emissor
38 Excedido numero de tentativas do pin P5 Solicite ao cliente contatar o emissor
41 Cartão extraviado P6 Solicite ao cliente contatar o emissor
43 Transação não autorizada. Solicite ao clientecontatar o emissor
P7 Valor invalido. Tente novamente
51 Transação não autorizada. Solicite ao clientecontatar o emissor
P8 Numero do cartão invalido
54 Cartão vencido P9 Limite de saque excedido
55 Senha incorreta Q0 Transação não completada. Tente novamente
56 Erro nos dados informados Q1 Transação não completada. Tente novamente
57 Transação não permitida. Solicite ao clientecontatar o emissor
Q2 Transação não completada. Tente novamente
58 Transação não permitida. Entre em contato coma getnet
Q3 Transação não aprovada. Solicite ao cliente contatar oemissor
61 Limite de retirada excedido Q4 Transação não aprovada. Solicite ao cliente contatar oemissor
62 Cartão restrito Q5 Transação não aprovada. Solicite ao cliente contatar oemissor
64 Parcelado não permitido para cartão Q6 Transação não aprovada. Solicite ao cliente contatar oemissor
65 Quantidade de saques excedida Q7 Transação não aprovada. Solicite ao cliente contatar oemissor
68 Transação não completada. Tente novamente(time out)
Q8 Transação não aprovada. Solicite ao cliente contatar oemissor
75 Senha bloqueada Q9 Transação não aprovada. Solicite ao cliente contatar oemissor
76 Cartão bloqueado R6 Transação não aprovada. Solicite ao cliente contatar oemissor
78 Transação não autorizada. Solicite ao clientecontatar o emissor
R7 Transação não aprovada. Solicite ao cliente contatar oemissor
82 Cvv invalido. R8 Transação não aprovada. Solicite ao cliente contatar oemissor
84 Numero do cartão invalido S4 Solicite ao cliente contatar o emissor
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 26 / 41
Código Descrição Código Descrição
85 Sistema do emissor indisponivel. Tentenovamente
S8 Solicite ao cliente contatar o emissor
86 Transação não completada. Tente novamente S9 Solicite ao cliente contatar o emissor
87 Transação não completada. Tente novamente T0 Produto não habilitado
88 Sistema do emissor indisponivel. Tentenovamente
T1 Valor invalido. Tente novamente
89 Bandeira não pertence a rede getnet T2 Erro nos dados informados. Tente novamente
94 Transmissao duplicada. Tente novamente T3 Cartão não pertence a rede getnet
N0 Sistema do emissor indisponivel. Ligue emissor T4 Solicite ao cliente contatar o emissor
N1 Numero do cartão invalido T5 Transação não aprovada. Solicite ao cliente contatar oemissor
N2 Limite de saque excedido T6 Solicite ao cliente contatar o emissor
N3 Transação não aprovada. Solicite ao clientecontatar o emissor
T7 Transação não aprovada. Solicite ao cliente contatar oemissor
N4 Transação não aprovada. Solicite ao clientecontatar o emissor
T8 Cartão invalido
Tabela 5 : Códigos retornados pelo adquirente GetNet
CódigoDescrição Código Descrição
101 Expired card 182 Transaction error: debit card used in a credittransaction
102 Contact the issuer 190 Transaction not authorized
104 Unauthorized transaction 191 Invalid date of expiration
107 Contact the issuer 208 Contact the issuer
110 Invalid value 209 Contact the issuer
120 Transaction denied by the purchaser 290 Contact the issuer
125 Card not enabled 904 System error. CONTACT THE GLOBAL PAYMENTS
129 Safety code (cvv2 / cvc2) incorrect 909 System error.
167 Contact the issuer 912/0012Transaction not authorized.
180 Contact the issuer Anyothervalue
Transaction not authorized
181 Transaction error: credit card used in a debttransaction
Tabela 6 : Códigos retornados pelo adquirente Global Payments
Código Descrição
0 Pagamento realizado.
1 Status do pagamento não finalizado.
2 Erro durante o processamento da solicitação.
3 Pagamento não encontrado.
4 Boleto emitido com sucesso.
5 Pagamento realizado, compensação em andamento.
6 Pagamento sem compensação.
Tabela 7 : Códigos retornados pelo adquirente Itau
CódigoDescrição Código Descrição
51 Produto ou serviço não habilitado para oestabelecimento. Entre em contato com a Rede
72 Contate o emissor
53 Transação não permitida para o emissor. Entre emcontato com a Rede
74 Falha na comunicação. Tente novamente
56 Erro nos dados informados. Tente novamente. 79 Cartão expirado. Transação não pode ser resubmetida.Contate o emissor
57 Estabelecimento inválido 80 Transação não autorizada. Contate o emissor. (SaldoInsuficiente)
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 27 / 41
CódigoDescrição Código Descrição
58 Transação não autorizada. Contate o emissor 81 Produto ou serviço não habilitado para o emissor(AVS)
65 Senha inválida. Tente novamente 82 Transação não autorizada para cartão de débito
69 Transação não permitida para este produto ouserviço
83 Transação não autorizada. Problemas com cartão.Contate o emissor
84 Transação não autorizada. Transação não pode serresubmetida. Contate o emissor
Tabela 8 : Códigos retornados pelo adquirente Rede (e.rede)
CódigoDescrição Código Descrição
20 Parâmetro obrigatório ausente 61 Transação não autorizada
21 Número de filiação em formato inválido 62 Transação não autorizada
22 Número de parcelas incompatível com a transação 63 Problemas com o cartão
23 Problemas no cadastro do estabelecimento. 64 Transação não autorizada
24 Problemas no cadastro do estabelecimento. 65 Problemas com o cartão
25 Formatação incorreta da transação. 66 Transação não autorizada
26 Formatação incorreta da transação. 67 Transação não autorizada
27 Cartão inválido. 68 Transação não autorizada
28 CVC2 em formato inválido. 69 Problemas com o cartão
29 Operação não permitida. Número do pedido dereferência da transação IATA maior que 13 posições
70 Transação não autorizada
30 Parâmetro AVS ausente. 71 Transação não autorizada
31 Número do pedido maior que o permitido (16posições).
72 Problemas com o cartão
32 Código IATA inválido ou inexistente. 73 Transação não autorizada
33 Código IATA inválido. 74 Instituição sem comunicação - Resposta AVS
34 Distribuidor inválido ou inexistente. 75 Transação não autorizada
35 Problemas no cadastro do estabelecimento. 76 Refaça Transação
36 Operação não permitida. 77 Problemas com o cartão
37 Distribuidor inválido ou inexistente. 78 Transação não autorizada
38 Operação não permitida no ambiente de teste. 79 Transação não autorizada
39 Operação não permitida para o código IATAinformado.
80 Transação não autorizada
40 Código IATA inválido ou inexistente. 81 Banco não pertence à rede
41 Problemas no cadastro do estabelecimento. 82 Transação não autorizada
42 Problemas no cadastro do usuário doestabelecimento.
83 Transação não autorizada
43 Problemas na autenticação do usuário. 84 Transação não autorizada
44 Usuário incorreto para testes. 85 Transação não autorizada
45 Problemas no cadastro do estabelecimento paratestes.
87 Transação não autorizada
50 Transação não autorizada 89 Transação não autorizada
51 Estabelecimento Inválido 90 Transação não autorizada
52 Transação não autorizada 91 Transação não autorizada
53 Transação Inválida 92 Estabelecimento Inválido
54 Transação não autorizada 93 Transação não autorizada
55 Transação não autorizada 94 Transação não autorizada
56 Dados Inválidos. 95 Transação não autorizada
56 Refaça Transação 96 Problemas com o cartão
57 Transação não autorizada 96 Refaça Transação
58 Problemas com o cartão 97 Transação não autorizada
59 Transação não autorizada 98 Estabelecimento Inválido
60 Valor Inválido 99 Transação não autorizada
Tabela 9 : Códigos retornados pelo adquirente Rede (komerci)
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 28 / 41
Código Descrição
0 Transação autorizada
1 Transação autorizada
2 Approved for partial amount
1000 Não aprovado
1001 Cartão vencido
1002 Suspeita de fraude
1003 Estabelecimento entrar em contato com emissor
1004 Cartão com restrição
1005 Estabelecimento entrar em contato com departamento de segurança do adquirente
1006 Tentativas de senha excedidas
1007 Consultar o emissor
1008 Consultar as condições especiais do emissor
1009 Estabelecimento inválido
1010 Valor inválido
1011 Cartão inválido
1012 Senha necessária
1014 Nenhuma conta do tipo selecionado
1015 Função selecionada não suportada
1016 Saldo insuficiente
1017 Senha inválida
1019 Transação não permitida para o portador
1020 Transação não permitida para o terminal
1021 Limite de valor para saque excedido
1022 Violação de segurança
1023 Limite de quantidade de saques excedido
1024 Violação da lei
1025 Cartão bloqueado
1026 Dados de senha inválidos
1027 Erro no tamanho da senha
1028 Erro de sincronia de chave de senha
1029 Suspeita de cartão falso
1030 Moeda inaceitável para o emissor
1032 Cartão perdido ou roubado
1035 Conta encerrada
1036 Conta poupança encerrada ou bloqueada para encerramento
1037 Conta de crédito encerrada ou bloqueada para encerramento
1039 Conta corrente encerrada ou bloquada para encerramento
1041 Status ruim para conta de origem
1042 Status ruim para conta de destino
1045 Código de segurança inválido
1047 Troca de senha necessária
1048 Nova senha inválida
1057 Data de pagamento inválida
1060 Transação não completou normalmente no terminal
1061 Transação não suportada pelo emissor
1062 Saque fácil não disponível
1063 Limite de saque fácil excedido
1064 Negado offline pelo terminal
1065 Negado, não foi possível processar offline
2000 Não aprovado
2001 Cartão vencido
2002 Suspeita de fraude
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 29 / 41
Código Descrição
2003 Estabelecimento entrar em contato com emissor
2004 Cartão com restrição
2005 Estabelecimento entrar em contato com departamento de segurança do adquirente
2006 Tentativas de senha excedidas
2007 Condições especiais
2008 Cartão perdido
2009 Cartão roubado
2010 Suspeita de cartão falso
2011 Limite de quantidade de saques excedido
2012 Limite de valor para saque excedido
9100 Erro no formato da mensagem
9102 Transação inválida
9103 Tente novamente
9105 Adquirente não suportado pelo switch
9107 Emissor fora de operação
9108 Não foi possível enviar a transação para o destinatário
9109 Erro no sistema
9110 Emissor se desconectou
9111 Emissor não respondeu em tempo
9112 Emissor indisponível
9113 Transmissão duplicada
9114 Não foi possível encontrar a transação original
9116 MAC incorreto
9117 Erro de sincronização de chave de MAC
9118 Nenhuma chave de comunicação disponível
9119 Erro de sincronização de chave de encriptação
9120 Erro de segurança de software/hardware, tente novamente
9121 Erro de segurança de software/hardware
9122 Número da mensagem fora de sequência
9123 Requisição em progresso
9124 Código de segurança inválido
9125 Erro no banco de dados
9132 Erro nos dados de recorrência
9133 Atualização não permitida
9350 Violação de acordo comercial
9900 (IMSG) Mensagem Invalida – A mensagem enviada possui um formato inválido.
9901 (INTP) SAK Invalido – O SAK enviado não foi reconhecido
9902 (RCPP) Destinatario Invalido – O local para aonde a mensagem foi enviada esta invalida
9903 (DPMG) Mensagem Duplicada – Esta mensagem já foi recebida pela Stone.
9904 (VERS) Protocolo – A versão do protocolo enviada não é suportada.
9905 (MSGT) Tipo da Mensagem – o Message Type enviado não é reconhecido.
9906 (PARS) Erro na leitura da mensagem – Algum campo obrigatório não esta sendo enviado
9907 (UNPR) Não Foi possível processar – Não foi possível processar a mensagem. Tente novamente.
9908 (SECU) Segurança – Algum erro no processo de segurança. A chave de criptografia pode não estar presente noterminal.
9999 Erro não especificado
Tabela 10 : Códigos retornados pelo adquirente Stone
Código Descrição
0 Transacción aprobada.
1 Rechazo de transacción.
2 Transacción debe reintentarse.
3 Error en transacción.
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 30 / 41
Código Descrição
4 Rechazo de transacción.
5 Rechazo por error de tasa.
6 Excede cupo máximo mensual.
7 Excede límite diario por transacción.
8 Rubro no autorizado.
Tabela 11 : Códigos de retorno autorização do adquirente TransBank
Código Descrição
0 Approved or Completed Successfully
1 Refer to Card Issuer
3 Invalid Merchant
4 Capture Card
5 Denegado
12 Invalid Transaction
13 Invalid Amount
14 Invalid Card Number
15 Invalid Issuer
30 Format Error
41 Lost Card
43 Stolen Card
45 Tarj.Es Cuotas
51 Insufficient Funds/Over Credit Limit
54 Expire Card
57 Transaction not Pemitted to Issuer/Cardholder
58 Transaction not Permitted to Acquirer/Terminal
61 Exceeds Withdrawal Amount Limit
62 Restrited Card
63 Security Violation
65 Exceeds Withdrawal Count Limit
76 Invalid/Non existent To Account Specified
77 Invalid/Non Existent From Account Specified
78 Invalid/Non Existent Account Specified (General)
84 Invalid Authorization Life Cycle
91 Authorization System or Issuer System Inoperative
92 Unable to Route Transaction
94 Duplicate Transmission Detected
96 System Error
101 ND Sistema No disponible
102 PD Permiso Denegado
103 KD Llave Denegada
104 NR Numero de Referencia Invalido.
105 NE Ud. debe Ingresar El mes y el Año de Expiración de su Tarjeta de Credito
106 IM Moneda Invalida
107 FI Fecha Invalida
108 HI Hora Invalida
109 ID Diferido Invalido
110 IC - Cuota Invalida
111 IA - El monto no debe exceder de 10 caracteres
112 CC - Nro de Tarjeta no es valido
113 MC - Codigo Comercio Invalido
114 SM - Secure Code Mensaje(Ver O16)
115 EC - Error Criptografico
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 31 / 41
Código Descrição
116 HM - Hash Inválido
117 BI - Ingresar Marca
118 AI - Ingresar Monto
119 PI - Proceso Inválido
120 RE - El Num. de Referencia no debe exceder de 15 caracteres ni debe ser menor a 5caracteres.
121 TI - Usted debe ingresar el Nro. de Tarjeta
122 DR - Numero de Referencia Duplicada
123 EP - Error de Procesamiento Txn
124 EV - Error de Validacion
125 DI - El tipo de proceso debe tener 2 caracteres
126 CI - El numero de caracteres del código cliente no debe ser menor a 5 ni mayor a 20
127 VI - El CVC debe ser entero y debe tener 3 o 4 digitos
128 FE - El formato a ingresar debe ser mes y año (MMAA)
129 FM - El formato del monto es incorrecto
130 VM - El monto ingresado no es valido ( solo numeros y punto decimal son permitidos)
131 CM - El numero de cuotas debe ser entero y menor que 36
132 EF - Enviar Comercio Facilitador
998 Lote cerrado, la cancelación ya no es posible.
999 Error not referenced. Please refer to external message
Tabela 12 : Códigos retornados pelo adquirente Processos
Código Descrição
0 Operação autorizada.
101 Operação recusada. Cartão vencido.
102 Operação recusada. Entrar em contato com o emissor.
104 Operação recusada. Operação não autorizada para este cartão.
106 Operação recusada. Limite de tentativas de digitação de senha ultrapassado.
107 Operação recusada. Entrar em contato com o emissor.
108 Operação recusada. Atividade excedida.
109 Operação recusada. Identificação do estabelecimento inválida.
110 Operação recusada. Operação não autorizada para este cartão.
111 Operação recusada. O valor da transação ultrapassa o valor máximo autorizado para operaçõesvirtuais.
112 Operação recusada. Senha requerida.
116 Operação recusada. Fundos insuficientes.
117 Operação recusada. Senha incorreta.
118 Operação recusada. Cartão inválido.
119 Operação recusada. Limite de tentativas de digitação de senha ultrapassado.
121 Operação recusada.
126 Operação recusada. Senha inválida.
129 Operação recusada. Cartão não operacional.
180 Operação recusada. Cartão inválido.
181 Operação recusada. Cartão com restrições de Débito.
182 Operação recusada. Cartão com restrições de Crédito.
183 Operação recusada. Erro de sistema.
190 Operação recusada. Entrar em contato com o emissor.
191 Operação recusada. Entrar em contato com o emissor.
192 Operação recusada. Entrar em contato com o emissor.
199 Operação recusada.
201 Operação recusada. Cartão vencido.
202 Operação recusada. Entrar em contato com o emissor.
204 Operação recusada. Operação não autorizada para este cartão.
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 32 / 41
Código Descrição
206 Operação recusada. Limite de tentativas de digitação de senha ultrapassado.
207 Operação recusada. Entrar em contato com o emissor.
208 Operação recusada. Cartão perdido.
209 Operação recusada. Cartão roubado.
263 Operação recusada. Erro de envio de parâmetros.
264 Operação recusada. Emissor não disponível para realizar a autenticação.
265 Operação recusada. Senha do cartão incorreta.
266 Operação recusada. Cartão vencido.
280 Operação recusada. Senha errada.
290 Operação recusada. Entrar em contato com o emissor.
300 Operação recusada. Número de pedido da transação duplicado. Favor não atender.
306 Operação recusada. Entrar em contato com o emissor.
401 Operação recusada. Loja não habilitada.
402 Operação recusada.
403 Operação recusada. Cartão não autenticado.
404 Operação recusada. O valor da transação ultrapassa o valor máximo autorizado.
405 Operação recusada. O cartão ultrapassou a quantidade máxima de transações por dia.
406 Operação recusada. A loja ultrapassou a quantidade máxima de transações por dia.
407 Operação recusada. O valor da transação não atinge o valor mínimo autorizado.
408 Operação recusada. CVV2 não coincide.
409 Operação recusada. CVV2 não processado pelo emissor.
410 Operação recusada. CVV2 não processado por não ter sido informado.
411 Operação recusada. CVV2 não processado pelo emissor.
412 Operação recusada. CVV2 não reconhecido pelo emissor.
413 Operação recusada. Entrar em contato com o emissor.
414 Operação recusada.
415 Operação recusada.
416 Operação recusada.
417 Operação recusada.
418 Operação recusada.
419 Operação recusada.
420 Operação recusada. Cartão não é VISA.
421 Operação recusada. Entrar em contato com o emissor.
422 Operação recusada. Loja não configurada para usar este meio de pagamento.
423 Operação recusada. O pagamento foi cancelado.
424 Operação recusada. Entrar em contato com o emissor.
666 Operação recusada. Problemas de comunicação. Tente mais tarde.
667 Operação recusada. Transação sem autenticação. Início do processo de pagamento.
668 Operação recusada.
669 Operação recusada.
670 Operação recusada. Módulo antifraude.
672 Operação recusada. Transação sem resposta de Antifraude.
673 Operação recusada. Transação sem resposta de Autorização.
674 Operação recusada e Ticket inválido.
675 Início da transação.
676 Operação recusada. Não ativa a opção Revisar. Enviar para Autorização.
677 Operação recusada. Resposta Antifraude com parâmetros não válidos.
678 Operação recusada. Valor ECI inválido.
679 Operação recusada. Seu cartão aceita parcelas.
682 Operação recusada. Tentativa de Pagamento ultrapassou o tempo autorizado.
683 Operação Recusada Registro Incorreto de E-Ticket
684 Operação Recusada Registro Incorreto Antifraude
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 33 / 41
Código Descrição
685 Operação Recusada Registro Incorreto Autorização
904 Operação recusada. Formato de mensagem incorreto.
909 Operação recusada. Erro de sistema.
910 Operação recusada. Erro de sistema.
912 Operação recusada. Emissor não disponível.
913 Operação recusada. Envio duplicado.
916 Operação recusada. Entrar em contato com o emissor.
928 Operação recusada. Entrar em contato com o emissor.
940 Operação recusada. Transação cancelada anteriormente.
941 Operação recusada. Transação já cancelada anteriormente.
942 Operação recusada.
943 Operação recusada. Dados originais diferentes.
945 Operação recusada. Referência repetida.
946 Operação recusada. Operação de cancelamento em andamento.
947 Operação recusada. Comunicação duplicada.
948 Operação recusada. Entrar em contato com o emissor.
949 Operação recusada. Entrar em contato com o emissor.
965 Operação recusada. Entrar em contato com o emissor.
9997 Lote não fechado. Você pode somente cancelar.
9998 Lote fechado. Você pode somente reembolsar.
Tabela 13 : Códigos retornados pelo adquirente VisaNet
Outros códigosretorno
Para meios de pagamento diferentes dos que foram apresentados acima, favor:
• consultar a documentação técnica específica ao meio de pagamento.
ou
• entrar em contato com o suporte técnico para maiores detalhes.
Categoria Informações sobre a transação.
vads_capture_delay
Descrição Indica o prazo em número de dias antes da captura no banco.
Se este parâmetro não for enviado, então o valor padrão definido no Back OfficeEstabelecimento será usado. Este último pode ser configurado no Back OfficeEstabelecimento por todas as pessoas devidamente autorizadas.
Observações:
• O valor de vads_capture_delay não é levado em conta no caso de umpagamento parcelado MULTI_EXT.
• Se o prazo anterior à captura for superior a 365 dias na solicitação depagamento, ele será automaticamente redefinido a 365 dias.
Campo de entrada.
Formato n..3
Código de erro 06
Categoria Informações sobre a transação.
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 34 / 41
vads_card_number
Descrição • Número do cartão oculto. Contém os 6 primeiros números, seguido por"XXXXXX" e finalmente os 4 últimos números.
• IBAN e BIC (se for informado) usados para o pagamento, separados por um "_"no caso de um pagamento por débito no cartão de crédito.
O BIC é opcional, portanto, o número pode ser somente o IBAN.
Campo de saída, retornado na resposta (IPN e URL de retorno).
Formato an..36
Categoria Informações sobre o meio de pagamento.
vads_currency
Descrição Código numérico da moeda a ser usada para o pagamento, segundo a norma ISO4217 (código numérico).
Para selecionar uma moeda para um pagamento, é imprescindível ter um contratoaberto com esta moeda. O comprador apresenta o contrato ao vendedor com aou as moedas suportadas e a plataforma leva em conta estas informações durantea criação do contrato.
Campo de entrada e de saída, retornado na resposta (IPN e URL de retorno).
Formato n3
Código de erro 10
Valores possíveis Moeda Codificação ISO 4217Quantidade de númerosapós o separador decimal
Peso argentino (ARS) 032 2
Peso chileno (CLP) 152 0
Peso mexicano (MXN) 484 2
Sol peruano (PEN) 604 2
Dólar dos Estados-Unidos (USD) 840 2
Peso Uruguaio (UYU) 858 2
Real do Brasil (BRL) 986 2
Categoria Informações sobre a transação.
vads_ctx_mode
Descrição Parâmetro obrigatório.
Estabelecer o modo de solicitação da plataforma de pagamento
Influência a escolha da chave a ser usada (chave de teste ou chave de produção)para o cálculo da assinatura.
O modo TEST está sempre disponível, mesmo depois da criação da chave deprodução.
Se você estiver criando um novo site de e-commerce (ou possuir um ambiente ondefatura), você poderá realizar seus testes sem impacto para o site atualmente emfuncionamento.
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 35 / 41
Campo de entrada e de saída, retornado na resposta (IPN e URL de retorno).
Formato enum
Código de erro 11
Erros frequentes:
• O modo não foi enviado para a plataforma de pagamento.
• Não codificar PROD no lugar de PRODUCTION
• Não codificar o valor em minúsculas (teste ou produção). Este campo esperaexclusivamente valores em maiúsculas e sem abreviações.
Valores possíveis TEST, PRODUCTION
Categoria Informações técnicas.
vads_expiry_month
Descrição Mês de vencimento do cartão usado para o pagamento.
Campo de saída, retornado na resposta (IPN e URL de retorno).
Formato n..2
Categoria Informações sobre o meio de pagamento.
vads_expiry_year
Descrição Ano de vencimento do cartão usado para o pagamento.
Campo de saída, retornado na resposta (IPN e URL de retorno).
Formato n4
Categoria Informações sobre o meio de pagamento.
vads_extra_result
Descrição Código complementar de resposta A significação dela depende do valor informadoem vads_result.
• Quando vads_result vale 30 (erro de solicitação), então vads_extra_resultcontém o código numérico do campo que apresenta um erro de preenchimentoou de formato. Este valor pode ser preenchido a 99 no caso de um errodesconhecido na solicitação.
Exemplo: se vads_extra_result contém o valor 09, isto significa que o valorespecificado em vads_amount não está correto.
• Quando vads_result vale 05 (recusado) ou 00 (aceito), então vads_extra_resultcontém o código numérico do resultado dos controles de riscos.
Code Descrição
Vazio Nenhum controle efetuado.
00 Todos os controles ocorreram com sucesso.
02 O cartão excedeu o limite autorizado.
03 O cartão pertence à lista cinza do vendedor.
04 O país emissor do cartão pertence à lista cinza do vendedor.
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 36 / 41
Code Descrição
05 O endereço IP pertence à lista cinza do vendedor.
06 O código BIN pertence à lista cinza do vendedor.
07 Detecção de um e-carte bleue.
08 Detecção de um cartão comercial nacional.
09 Detecção de um cartão comercial estrangeiro
14 Detecção de um cartão com autorização sistemática.
20 Controle de coerência: nenhum país corresponde (país IP, país cartão, país docomprador).
30 O país do endereço IP pertence à lista cinza.
99 Problema técnico servidor durante o tratamento dos controles locais.
Campo de saída, retornado na resposta (IPN e URL de retorno).
Categoria Informações técnicas
vads_identifier
Descrição Código único (Token Cartão ou referência única de mandato) associado a um meiode pagamento.
• Ou este código será gerado pela plataforma.
Neste caso, este parâmetro não deve ser informado.
• Ou este código será gerado pelo site de e-commerce.
Neste caso, este parâmetro deve ser informado com o valor do código desejado.Cuidado, cabe ao site de e-commerce garantir o caráter único dos códigosde usuários. Toda solicitação de registro contendo um código de usuário jáexistente será recusada e será exibido uma mensagem de erro.
Campo de entrada e de saída, retornado na resposta (IPN e URL de retorno).
Formato Deux formats possibles :
• an32 : lorsque l'identifiant est généré par la plateforme
• ans..50 : lorsque l'identifiant est généré par le marchand
Código de erro 30
Categoria Informações sobre a assinatura.
vads_order_id
Descrição Número de pedido. Número de pedido relembrado no e-mail de confirmação depagamento enviado para o comprador.
Campo no formato alfanumérico. Somente o símbolo especial "-" é autorizado.
Se ele tiver um símbolo especial (&, ;, @, etc...), a plataforma de pagamentoretornará um erro.
Campo de entrada e de saída, retornado na resposta (IPN e URL de retorno).
Formato ans..64
Código de erro 13
Categoria Informações sobre o pedido.
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 37 / 41
vads_order_info
Descrição Descrição do pedido.
Campo de entrada e de saída, retornado na resposta (IPN e URL de retorno).
Formato an..255
Código de erro 14
Categoria Informações sobre o pedido.
vads_payment_config
Descrição Designa o tipo de pagamento: à vista ou parcelado.
• Para um pagamento simples, o valor deve ser igual a SINGLE.
• Para um pagamento parcelado com valores e datas fixas, o valor deve ser iguala MULTI: seguido dos pares chave=valor separados por « ; ».
Os parâmetros são os seguintes:
• « first » indica o valor do primeiro pagamento (apresentado na menorunidade da moeda).
• « count » indica o número total do parcelas.
• « period » indica o intervalo em quantidade de dias entre 2 pagamentos.
A ordem dos campos associados a MULTI é imposta.
• Para um pagamento parcelado, com um calendário de pagamento, o valor deveser igual a MULTI_EXT: seguido dos pares data=valor separados por « ; ».
As datas não podem ser vencidas.
O uso do valor MULTI_EXT precisa da ativação da opção Pagamento parceladoadiantado.
Observação: O valor de vads_capture_delay não é levado em conta no caso de umpagamento parcelado MULTI_EXT.
Campo de entrada e de saída, retornado na resposta (IPN e URL de retorno).
Formato enum
Código de erro 07
Valores possíveis • SINGLE
• MULTI:first=valor_initial;count=Qtde_parcelas;period=intervalo_em_dias
• MULTI_EXT:data1=valor1;data2=valor2;data3=valor3
Exemplo 1 MULTI permite definir um pagamento parcelado.
O valor de cada prestação corresponde ao valor divido pela quantidade de parcelas.
O valor da primeira prestação pode ser diferente e especificado no parâmetro first.
Se houver um valor sobrando sobra diferente de zero, será recolocado sobre ovalor da última parcela.
Solicitação de pagamento:
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 38 / 41
• vads_capture_delay=2
• vads_currency=986
• vads_amount=20000
• vads_payment_config=MULTI:first=10000;count=4;period=30
Resultado :
Um primeiro pagamento de 100 ,00 BRL será capturado no banco a D+2(vads_capture_delay).
Um segundo pagamento de 33,33 BRL será realizado a D+32 (vads_capture_delay+ period).
Um terceiro pagamento de 33,33 BRL será realizado a D+62.
Um quarto e último pagamento de 33,34 BRL será realizado a D+92.
O total é de 200,00 BRL (vads_amount= 20000). O restante foi acrescentado aovalor da última parcela.
Esta instrução permite criar imediatamente 4 pagamentos com o mesmonúmero de transação mas com uma quantidade de parcelas diferentes(vads_sequence_number).
Exemplo 2 MULTI_EXT permite definir um pagamento personalizado. Você poderá definir adata e o valor de cada parcela.
Solicitação de pagamento MULTI_EXT :
• vads_currency=986
• vads_amount=10000
• vads_payment_config= MULTI_EXT:20150601 =5000; 20150701 =2500;20150808 =2500
Resultado :
O primeiro pagamento ocorrerá dia 1° de junho de 2015, de um valor de 50,00 BRL.
O segundo pagamento ocorrerá dia 1° de julho de 2015, de um valor de 25,00 BRL.
O último pagamento ocorrerá dia 8 de agosto de 2015, de um valor de 25,00 BRL.
Observação:
A soma total dos valores deve ser igual ao valor do campo vads_amount. Adata da última parcela não pode ser posterior a 12 mezes em relação à datade apresentação do formulário. Se a data da última parcela for posterior à datade vencimento do cartão, nenhum vencimento será salvo e o comprador seránotificado por uma mensagem escrita.
Categoria Informações sobre a transação.
vads_result
Descrição Código de retorno da ação solicitada.
Campo de saída, retornado na resposta (IPN e URL de retorno).
Formato n2
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 39 / 41
Valores possíveis Valor Descrição
00 Ação realizada com sucesso.
02 O vendedor deve entrar em contato com o banco do portador. Desvalorizado.
05 Ação recusada.
17 Cancelado pelo comprador
30 Erro de formato da solicitação. Associar com o preenchimento do campovads_extra_result.
96 Erro técnico.
Categoria Informações técnicas
vads_site_id
Descrição Parâmetro obrigatório.
Valor gerado durante o cadastro na plataforma de pagamento.
O valor pode ser consultado na interface do Back Office Estabelecimento no menuConfiguração > Loja > Chaves por todas as pessoas autorizadas.
No caso de um valor não correto, o comprador recebe, durante um pagamento,uma mensagem de erro exibida no navegador.
O pagamento fica então impossível e a transação é definitivamente interrompida.
Um e-mail de alerta é então enviado para o contato administrativo da loja. Elecontém a forma com a qual a plataforma não poderia lidar com o valor daassinatura.
Campo de entrada e de saída, retornado na resposta (IPN e URL de retorno).
Formato n8
Código de erro 02
Categoria Informações técnicas
vads_trans_date
Descrição Parâmetro obrigatório.
Corresponde à marcação do tempo no formato AAAAMMJJHHMMSS.
A marcação do tempo deve necessariamente estar em adequação com a data ea hora comum, no fuso horário GMT+0 (ou UTC) no formato horário 24h.
Observação: Se você usar os Web Services, a variávelvads_trans_date correspondeao campo transmissionDate. Nós aconselhamos salvar este valor na base paravalorizar corretamente o campo transmissionDate durante as suas chamadas viaos Web Services.
Campo de entrada e de saída, retornado na resposta (IPN e URL de retorno).
Formato n14
Código de erro 04
Erros frequentes:
• A data não é enviada no formato AAAAMMJJHHMMSS (ano, mês, dia, hora,minuto, segundo).
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 40 / 41
• A data não esta conforme ao fuso horário UTC (tempo universal coordenado).
Não esqueçam de usar funções data na sua linguagem de programação gerandouma hora UTC (gmdate em PHP por exemplo)
• A hora deve ser calculada na base de 24h e não de 12h.
• O comprador esperou tempo demais antes de clicar no botão Pagar.
• O comprador usou o histórico do navegador dele.
Categoria Informações sobre a transação.
vads_trans_id
Descrição Parâmetro obrigatório.
É constituído de 6 dígitos numéricos e deve ser único para cada transação para umloja dada por dia.
Observação: a unicidade do código de transação baseia-se na hora universal (UTC).
Cabe ao site de e-commerce garantir o caráter único por dia. Deve variar entre000000 e 899999.
A faixa 900000 e 999999 é reservada aos reembolsos e às operações realizadas noBack Office Estabelecimento.
Campo de entrada e de saída, retornado na resposta (IPN e URL de retorno).
Formato n6
Código de erro 03
Erros frequentes:
O formulário é recusado:
• se o valor enviado for inferior a 6 dígitos.
• se o valor for nulo.
• se o campo é ausente.
• se um número de transação idêntico já foi enviado o mesmo dia.
Se o comprador clicar no botão "Cancelar e voltar para a loja", o número detransação deverá ser diferente na próxima tentativa porque considera que elejá foi usado.
Caso contrário, a mensagem "A transação foi cancelada" será exibida.
Categoria Informações sobre a transação.
vads_validation_mode
Descrição Apresenta o modo de validação da transação.
Campo de entrada e de saída, retornado na resposta (IPN e URL de retorno).
Formato enum
Código de erro 05
Gerenciador de pagamentos por token - Versão do documento 2.2
Todos os direitos reservados - 41 / 41
Valores possíveisValor Descrição
Ausente ouvazio
Configuração padrão da loja escolhida (pode ser configurado no Back OfficeEstabelecimento).
0 Validação automática pela plataforma de pagamento.
1 Validação manual pelo estabelecimento.
Categoria Informações sobre a transação.