api formulário - documentation payzen · criar um formulÁrio de pagamento ... • adição do...

API Formulário

Guia de implementação

Versão do documento 3.20

Conteúdo

1. HISTÓRICO DO DOCUMENTO........................................................................................................4

2. ENTRAR EM CONTATO COM O SUPORTE TÉCNICO............................................................... 8

3. OS DIFERENTES TIPOS DE PAGAMENTO.................................................................................. 93.1. Pagamento à vista........................................................................................................................................93.2. Pagamento pré-datado................................................................................................................................. 93.3. Pagamento parcelado.................................................................................................................................103.4. Solicitação de autorização.........................................................................................................................10

4. ENTENDER O PROCESSO DE UM PAGAMENTO.....................................................................144.1. Definir as etapas de um pagamento - Visão do comprador......................................................................144.2. Definir as etapas de um pagamento - Visão do vendedor........................................................................ 174.3. Ciclo de vida das transações.....................................................................................................................18

5. ESTABELECER O DIÁLOGO COM A PLATAFORMA DE PAGAMENTO.............................. 255.1. Definir a URL da página de pagamento...................................................................................................255.2. Identificar-se durante as trocas................................................................................................................. 255.3. Escolher o modo de Teste ou de Produção.............................................................................................. 265.4. Gerenciar o diálogo com o site de e-commerce....................................................................................... 285.5. Gerenciar a segurança............................................................................................................................... 295.6. Gerenciar as configurações da sua loja por arquivo de configuração.......................................................31

6. CONFIGURAR AS NOTIFICAÇÕES............................................................................................... 326.1. Notificações dos diferentes status para um pagamento a vista.................................................................326.2. Notificações dos diferentes status para um pagamento pré-datado.......................................................... 336.3. Notificações dos diferentes status para as parcelas de um pagamento parcelado.....................................346.4. Configurar as notificações.........................................................................................................................35

Configurar a notificação no final do pagamento................................................................................. 35Configurar a notificação do resultado final de um pagamento pré-datado.......................................... 37Configurar a notificação se o comprador desistir ou cancelar.............................................................38Configurar a notificação em autorização por batch............................................................................. 39

6.5. Ativar a rechamada automática.................................................................................................................406.6. Rechamar manualmente a notificação...................................................................................................... 426.7. Configurar os e-mails enviados para o comprador................................................................................... 436.8. Configurar os e-mails enviados para o vendedor..................................................................................... 44

7. CRIAR UM FORMULÁRIO DE PAGAMENTO............................................................................ 467.1. Criar um pagamento à vista...................................................................................................................... 487.2. Criar um pagamento pré-datado................................................................................................................507.3. Criar um pagamento parcelado................................................................................................................. 527.4. Criar uma autorização sem captura...........................................................................................................54

8. USAR FUNÇÕES COMPLEMENTARES........................................................................................ 568.1. Definir o modo de captura no banco (automático / manual).................................................................... 578.2. Enviar os dados do comprador................................................................................................................. 598.3. Enviar os dados de entrega....................................................................................................................... 608.4. Enviar os dados do pedido........................................................................................................................628.5. Ativar / Desativar 3D Secure.................................................................................................................... 658.6. Definir o contrato comercial..................................................................................................................... 668.7. Gerenciar o retorno para o site de e-commerce........................................................................................678.8. Ativar o retorno automático para o site de e-commerce...........................................................................708.9. Sobrescrever a URL de notificação instantânea (IPN)............................................................................. 728.10. Criar um pagamento sem redirecionar para a página de pagamento...................................................... 73

9. PERSONALIZAR AS PÁGINAS DE PAGAMENTO.....................................................................759.1. Sobrescrever o modelo de personalização................................................................................................ 759.2. Gerenciar os meios de pagamento propostos ao comprador.....................................................................769.3. Mudar o idioma......................................................................................................................................... 779.4. Modificar os idiomas propostos ao comprador.........................................................................................789.5. Mudar o nome e a URL da loja............................................................................................................... 799.6. Mudar a denominação do botão "Voltar para a loja"............................................................................... 80

10. EXIBIR A PÁGINA DE PAGAMENTO EM UM IFRAME........................................................ 81

11. CALCULAR A ASSINATURA........................................................................................................8311.1. Exemplo de implementação em JAVA...................................................................................................8511.2. Exemplo de implementação em PHP......................................................................................................87

12. ENVIAR A SOLICITAÇÃO DE PAGAMENTO...........................................................................8812.1. Redirecionar o comprador para a página de pagamento.........................................................................8812.2. Gerenciar os erros....................................................................................................................................8812.3. Gerenciar os timeout............................................................................................................................... 89

13. ANALISAR O RESULTADO DO PAGAMENTO........................................................................9113.1. Recuperar os dados devolvidos na resposta............................................................................................9313.2. Calcular a assinatura................................................................................................................................9413.3. Comparar as assinaturas.......................................................................................................................... 9413.4. Analisar a natureza da notificação.......................................................................................................... 9513.5. Identificar o tipo de operação................................................................................................................. 9613.6. Tratar os dados da resposta.....................................................................................................................9713.7. Tratar os erros....................................................................................................................................... 102

14. TRATAR O RETORNO PARA A LOJA.................................................................................... 103

15. INICIAR A FASE DE TESTE......................................................................................................10415.1. Testar a URL de notificação instantânea (IPN)....................................................................................105

16. ATIVAR A LOJA EM MODO DE PRODUÇÃO....................................................................... 10616.1. Gerar a chave de produção................................................................................................................... 10616.2. Passar seu site de e-commerce em produção........................................................................................10616.3. Efetuar um primeiro pagamento em produção......................................................................................10616.4. Gerar de novo a chave de produção..................................................................................................... 107

17. DICIONÁRIO DE DADOS...........................................................................................................108

API Formulário - Versão do documento 3.20

Todos os direitos reservados - 4 / 223

1. HISTÓRICO DO DOCUMENTO

Versão Autor Data Comentário

3.20 Lyra Network 07/08/2019 • Adição do capítulo Exibir a página de pagamento em um iframe

• Atualização do capítulo Calcular a assinatura

• Dicionário de dados

• vads_payment_cards: atualização dos valores

• vads_payment_error: adição de novos códigos

• vads_theme_config: adição dos valores REGISTER_ON_PAYMENT,3DS_LOGOS et FORM_TARGET

• vads_contracts: atualização da descrição e dos valores possíveis

3.19 Lyra Network 19/06/2018 • Atualização do capítulo Calcular a assinatura

• Atualização do formato do campo vads_product_label

• Adição do campo vads_token_id

• Adição do capítulo Sobrescrever o modelo de personalização

• Atualização da definição e dos valores do campovads_theme_config

• Atualização da definição do campo vads_sequence_number

• Novo valor do campo vads_trans_status:SUSPENDED

3.18 Lyra Network 23/05/2018 • Atualização do capítulo Identificar-se durante as trocas: chave (certificado)alfanumérico

• Atualização do capítulo Calcular a assinatura: algoritmo de cálculo

• Atualização do capítulo Gerenciar os erros: adição de mensagens sobre os errosfrequentes

• Adição do capítulo Selecionar o algoritmo hash


• Adição de vads_avs_result

• Adição de vads_brand_management

• Atualização do formato de vads_acquirer_transient_data evads_payment_seq

• Adição de vads_url_post_wallet

3.17 Lyra Network 21/03/2018 • Atualização do capítulo Gerenciar a segurança: instalação do SHA-256

• Atualização do capítulo Calcular a assinatura.

• Atualização do capítulo Realizar a fase de teste.

• Adição do capítulo Gerenciar os timeout.

• Atualização da lista dos adquirentes e dos prazos de validade no capítuloSolicitação de autorização


• vads_currency : atualização da lista das moedas autorizadas

• vads_first_installment_delay : atualização da definição

• vads_auth_result : adição dos códigos de retorno dos adquirentes

• vads_contracts : atualização das redes.

• vads_payment_cards : atualização dos tipos de cartões

• vads_ext_info : definição do campo atualizado



Versão Autor Data Comentário• vads_risk_assessment_results : definição do campo atualizado

• correção de um erro de título de campo vads_url_refusal porvads_url_refused

• adição do campo vads_cust_address2

3.16 Lyra Network 12/12/2017 • Adição de uma observação no capítulo Ativar o retorno automático para o sitede e-commerce

• Atualização do capítulo Gerenciar os erros.

• Exclusão do capítulo FAQ - Perguntas mais frequentes e adição das informaçõesda FAQ no capítulo Entrar em contato com o suporte


• Atualização do campo vads_risk_analysis_result : adição dos valores Konduto

3.15 Lyra Network 04/09/2017 Modificação do vencimento das transações: a partir de agora, depende do prazo devalidade da autorização.Dicionário de dados

• Atualização da definição de "anos"

• Atualização do campo vads_action_mode : exclusão do valor webview

3.14 Lyra Network 17/07/2017 Dicionário de dados

• Correção do formato do campo vads_cust_address_number

• Atualização dos campos vads_sub_init_amount e vads_sub_amount

• Atualização do campo vads_theme_config


• Correção do formato dos campos vads_url_cancel,vads_url_error,vads_url_refused e vads_url_success (até 1025 caracteres alfanuméricos eespeciais)

• Adição dos campos vads_first_installment_delay, vads_card_holder_name,vads_proof_of_id_type e vads_proof_of_id_number

• Atualização do campo vads_acquirer_transient_data

• Correção do formato do campo vads_order_id

• vads_url_check_src : adição do valor BATCH e da sua descrição


• vads_action_mode : adição dos valores WEBVIEW e IFRAME

• vads_theme_config : adição do valor MODE_IFRAME

• vads_currency : adição de precisões sobre as moedas

• Adição de vads_acquirer_transient_data

3.11 Lyra Network 27/02/2017 • Capítulo Gerenciar os erros: adição de precisões sobre os códigos de erro

• Capítulo Exibir os parâmetros classificados por categoria: adição de uma colunaCódigo de erro nos quadros

Dicionário de dados

• novo campo: vads_authent_paypal_protection_eligibility

• vads_currency : adição da codificação alfa nos quadros

3.10 Lyra Network 30/01/2017 • vads_bank_product : adição de novos valores para os cartões MasterCard

• Adição do campo vads_effective_currency

• Modificação da rede AMEX por AMEXGLOBAL após a migração

3.9 14/09/2016 • vads_product_label : correção formato



Versão Autor Data Comentário

3.8 Lyra Network 16/08/2016 Precisões:

• Valor de vads_trans_status : CANCELLED e não CANCELED

• Valor de vads_risk_control : COMMERCIAL_CARD e não CARD_COMMERCIAL

• vads_url_check_src : adição do valor VOICE_ORDER

• Adição de observação sobre MULTI_EXT em vads_capture_delay evads_payment_config

• vads_contracts : adições de redes e esclarecimentos sobre a definição do contratocomercial

3.7 Lyra Network 05/2016 Novos esclarecimentos sobre os capítulos:

• Enviar os dados do pedido

• Ativar a rechamada automática

Dicionário de dados

• vads_payment_cards : adição de novos valores

• vads_theme_config : adição dos valores MERCHANT_MESSAGE,RESPONSIVE_MODEL e RESPONSIVE_MAIL_MODEL

3.6 Lyra Network 01/02/2016 Novas precisões sobre o meio de pagamento Itau Internet Banking (capítulovads_payment_cards do dicionário de dados).Dicionário de dados

• vads_auth_result : adição dos valores AMEX


• vads_payment_cards e vads_contracts : adição de valores

• Novas precisões sobre o formato dos campos:

• vads_cust_address

• vads_ship_to_street

• vads_ship_to_street2

• vads_trans_status : adição do status INITIAL na lista dos status possíveis

• vads_change_rate

• vads_recurrence_number


• Correção do formato do campo vads_product_labelN

• Correção do nome do campo vads_product_vatN

• Adição do campo:

• vads_cust_national_id

3.3a Lyra Network 24/07/2015 Capítulo adicional

• Configurar a notificação em autorização por batch

Modificação dos capítulos:

• Usar uma i-frame

• vads_trans_id

3.3 Lyra Network 07/07/2015 Capítulos adicionais

• Configurar os e-mails enviados para o comprador

• Configurar os e-mails enviados para o vendedor

Informações adicionais sobre a utilização de uma i-frameDicionário de dados

• Adição dos campos:

• vads_trans_uuid



Versão Autor Data Comentário• vads_risk_assessment_result

• vads_risk_analyzis_result : adição de valores

• vads_payment_cards : adição de valores

3.2 Lyra Network 27/04/2015 Dicionário de dadosCorreção de um erro no campo vads_ship_to_type

3.1 Lyra Network 02/03/2015 URL Servidor renomeado em URL de notificaçãoCapítulos adicionais

• Gerenciar as configurações da sua loja por arquivo de configuração

• Ativar a rechamada automática

• Re-chamar manualmente a notificação

Informações adicionais sobre a utilização de uma i-frame.Dicionário de dados

• Adição dos campos:

• vads_payment_seq

• vads_cust_legal_name

• vads_ship_to_legal_name

• Adição do valor E_CV na lista dos meios de pagamento (rede ANCV)

• Precisão sobre o campo vads_url_check

3.0 Lyra Network 21/11/2014 Refazer globalmente a documentação.

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.



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 o Brasil

por e-mail: [email protected]

Para facilitar o atendimento das suas solicitações, você deverá informar seu código de loja (número com8 dígitos) .

Esta informação aparece no e-mail de cadastro da sua loja, ou no Back Office (menu Configuração > Loja> Configurações).

https://payzen.io/pt-BR/faq/sitemap.html

mailto:[email protected]



3. OS DIFERENTES TIPOS DE PAGAMENTO

3.1. Pagamento à vista

Um pagamento é considerado como à vista se:

• o valor é debitado de uma vez só,

• o prazo de captura no banco é de 0 dia.

Uma solicitação de autorização para o valor global é efetuada. O pagamento esta entregue no banco assimque for possível.

3.2. Pagamento pré-datado

Um pagamento é considerado como pré-datado se:

• o valor for debitado de uma vez só,

• o prazo de captura no banco é estritamente superior a 0 dia.

A data da captura não pode ser superior a 12 meses em relação à data de registro do pagamento.

Existe dois tipos de pagamentos pré-datados:

• Prazo de captura menor em relação ao tempo de validade da autorização (ver seção Validade de umaautorização apresentada abaixo)

Uma solicitação de autorização para o valor global é efetuada. Sem modificações da parte do vendedor, opagamento é entregue na data de apresentação solicitada.

• Prazo de captura maior em relação ao tempo de validade da autorização (ver seção Validade de umaautorização apresentada abaixo)

Uma solicitação de informação será realizada se o prazo de captura for superior à duração de validade deuma solicitação de autorização.

A solicitação de informação procura conferir a validade do cartão. Para os adquirentes que não atendemas solicitações de informações, uma solicitação de autorização de 1 BRL será realizada.

Se esta autorização de 1 BRL for aceita, o pagamento será registrado.

D-1 na data de apresentação solicitada, uma solicitação de autorização para o valor global é efetuada.

O pagamento pode ser aceito ou recusado. O vendedor deve então ficar muito atento com este tipo depagamento antes de entregar um bem / um serviço para o comprador.



3.3. Pagamento parcelado.

Um pagamento é chamado "parcelado" desde que o comprador seja debitado pela sua compra em váriasparcelas.

A primeira parcela funciona da mesma forma que um pagamento à vista.

As seguintes parcelas funcionam da mesma forma que um pagamento pré-datado.

Somente a primeira parcela pode estar sujeita a uma garantia para o vendedor somente se a data deapresentação solicitada da primeira parcela for anterior a data de validade da autorização em função domeio de pagamento. (ver seção Validade de uma autorização apresentada abaixo)

3.4. Solicitação de autorização

A plataforma de pagamento envia uma mensagem para o emissor do cartão para ter o acordo dele paraefetuar o pagamento da transação.

De uma maneira geral, o débito é efetivo somente após a captura da transação no banco.

Alguns emissores de cartão pré-pagos ou de procedência espanhola e canadense debitam o valor daautorização em tempo real e o creditam de novo quando a autorização venceu (ver quadro abaixo).

Código Rede Meio de pagamentoTipo de cartões

(vads_payment_cards)Tempo de validade de

uma autorização (em dias)

AMEX American Express AMEX 7

AMEXGLOBAL American Express AMEX 7

BOLETO Boleto Bancário BOLETO 7

CIELOV3 American Express AMEX 28

CIELOV3 Aura AURA 28

CIELOV3 Diners DINERS 28

CIELOV3 Discover DISCOVER 28

CIELOV3 Elo ELO 4

CIELOV3 Hipercard HIPERCARD 29

CIELOV3 JCB JCB 28

CIELOV3 Maestro MAESTRO 0

CIELOV3 Mastercard MASTERCARD 28

CIELOV3 Visa VISA 28

CIELOV3 Visa Electron VISA_ELECTRON 0

CIELOV3 VPAY VPAY 0

EVO American Express AMEX 2

EVO Discover DISCOVER 2

EVO Maestro MAESTRO 0

EVO MasterCard MASTERCARD 14

EVO Visa VISA 2

EVO Visa Electron VISA_ELECTRON 0

FIRSTDATA_IPG Cabal CABAL 6

FIRSTDATA_IPG Elo ELO 6

FIRSTDATA_IPG Hiper HIPER 6

FIRSTDATA_IPG Hipercard HIPERCARD 6

FIRSTDATA_IPG Maestro MAESTRO 6

FIRSTDATA_IPG Mastercard MASTERCARD 6

FIRSTDATA_IPG Cordobesa MasterCard MC_CORDOBESA 6

FIRSTDATA_IPG Sorocred SOROCRED 6



Código Rede Meio de pagamentoTipo de cartões



FIRSTDATA_IPG Visa VISA 6

FIRSTDATA_IPG Visa Electron VISA_ELECTRON 6

FIRSTDATABR Cabal CABAL 4

FIRSTDATABR Mastercard MASTERCARD 15

FIRSTDATABR Sorocred SOROCRED 4

FIRSTDATABR Visa VISA 15

GETNET Amex AMEX 28

GETNET Elo ELO 4

GETNET Mastercard MASTERCARD 20

GETNET Visa VISA 20

GLOBAL PAYMENT Elo ELO 4

GLOBAL PAYMENT Hiper HIPER 29

GLOBAL PAYMENT Hipercard HIPERCARD 29

GLOBAL PAYMENT Mastercard MASTERCARD 30

GLOBAL PAYMENT Visa VISA 30

ITAU_IB Boleto Itaú ITAU_BOLETO 0

ITAU_IB Itaú Internet Banking ITAU_IB 0

JCB JCB JCB 7

KHIPU

MASTERPASS MasterPass MASTERPASS 0

PAYPAL PayPal PAYPAL 3

PAYPAL_SB PayPal- Modo sandbox PAYPAL_SB 3

PROCESOS

PROCESOS_WS

REDE Amex AMEX 28

REDE Diners DINERS 29

REDE Elo ELO 5

REDE Hiper HIPER 29

REDE Hipercard HIPERCARD 29

REDE Maestro MAESTRO 0

REDE Mastercard MASTERCARD 29

REDE Visa VISA 29

REDE Visa Electron VISA_ELECTRON 0

REDE VPAY VPAY 0

STONE Mastercard MASTERCARD 30

STONE Visa VISA 30

VISANET

WEBPAY

WEBPAY_COMPLETA

WEBPAY_NORMAL

Rede Meio de pagamentoTipo de cartão



BOLETO Boleto Bancário BOLETO 7

CIELO Amex AMEX 28

CIELO Aura AURA 28

CIELO Diners DINERS 28

CIELO Discover DISCOVER 28

CIELO Elo ELO 4

CIELO Hipercard HIPERCARD 29

CIELO JCB JCB 28

CIELO Maestro MAESTRO 0






CIELO Mastercard MASTERCARD 28

CIELO Visa VISA 28

CIELO Visa Electron VISA_ELECTRON 0

CIELO VPAY VPAY 0

CIELOV3 Amex AMEX 28

CIELOV3 Aura AURA 28

CIELOV3 Diners DINERS 28

CIELOV3 Discover DISCOVER 28

CIELOV3 Elo ELO 4

CIELOV3 Hipercard HIPERCARD 29

CIELOV3 JCB JCB 28

CIELOV3 Maestro MAESTRO 0

CIELOV3 Mastercard MASTERCARD 28

CIELOV3 Visa VISA 28

CIELOV3 Visa Electron VISA_ELECTRON 0

CIELOV3 VPAY VPAY 0

ITAU_IB Boleto Itaú ITAU_BOLETO 0

ITAU_IB Itaú Internet Banking ITAU_IB 0

ELAVONBR Diners DINERS 30

ELAVONBR Discover DISCOVER 30

ELAVONBR Maestro MAESTRO 4

ELAVONBR Mastercard MASTERCARD 30

ELAVONBR Visa VISA 30

ELAVONBR Visa Electron VISA_ELECTRON 4

ELAVONBR VPAY VPAY 4

FIRSTDATABR Cabal CABAL 4

FIRSTDATABR Mastercard MASTERCARD 15

FIRSTDATABR Sorocred SOROCRED 4

FIRSTDATABR Visa VISA 15

FIRSTDATA_IPG Visa VISA 6

FIRSTDATA_IPG Cordobesa MasterCard MC_CORDOBESA 6

FIRSTDATA_IPG Mastercard MASTERCARD 6

FIRSTDATA_IPG Sorocred SOROCRED 6

FIRSTDATA_IPG Cabal CABAL 6

FIRSTDATA_IPG Maestro MAESTRO 6

FIRSTDATA_IPG Elo ELO 6

FIRSTDATA_IPG Hiper HIPER 6

FIRSTDATA_IPG Hipercard HIPERCARD 6

FIRSTDATA_IPG Visa Electron VISA_ELECTRON 6

GETNET Amex AMEX 28

GETNET Elo ELO 4

GETNET Mastercard MASTERCARD 20

GETNET Visa VISA 20

GLOBAL PAYMENT Elo ELO 4

GLOBAL PAYMENT Hiper HIPER 29

GLOBAL PAYMENT Hipercard HIPERCARD 29

GLOBAL PAYMENT Mastercard MASTERCARD 30

GLOBAL PAYMENT Visa VISA 30

REDE Amex AMEX 28

REDE Diners DINERS 29

REDE Elo ELO 5






REDE Hiper HIPER 29

REDE Hipercard HIPERCARD 29

REDE Maestro MAESTRO 0

REDE Mastercard MASTERCARD 29

REDE Visa VISA 29

REDE Visa Electron VISA_ELECTRON 0

REDE VPAY VPAY 0

REDECARD Diners DINERS 29

REDECARD Hiper HIPER 29

REDECARD Hipercard HIPERCARD 29

REDECARD Maestro MAESTRO 4

REDECARD Mastercard MASTERCARD 29

REDECARD Visa VISA 29

REDECARD Visa Electron VISA_ELECTRON 4

REDECARD VPAY VPAY 4

STONE Mastercard MASTERCARD 30

STONE Visa VISA 30



4. ENTENDER O PROCESSO DE UM PAGAMENTO

O procedimento de um pagamento online tem uma abordagem diferente se você tomar o ponto de vistado comprador ou do vendedor.

4.1. Definir as etapas de um pagamento - Visão do comprador

O diagrama abaixo apresenta a cinemática das trocas do ponto de vista do comprador.

1. O comprador finaliza seu carrinho.

2. O site de e-commerce redireciona o comprador para a plataforma de pagamento.

Esse redirecionamento assumirá a forma de um formulário HTML POST em HTTPS.

Os parâmetros do formulário estão descritos no capítulo Gerar um formulário de pagamento.



3. A plataforma de pagamento, após verificação dos parâmetros e da sua assinatura irá apresentar apágina de seleção do meio de pagamento.

Figura 1 : Seleção do meio de pagamento

Se o meio de pagamento foi especificado no formulário, o comprador passa diretamente para na etapa6.

4. O comprador seleciona seu meio de pagamento.

5. Ele clica em Validar.

6. Ele informa o número e a data de vencimento do cartão.

Se o cartão possui um criptograma visual, este último deve ser informado.

Figura 2 : Digitar as informações do meio de pagamento

7. Ele confirma o que ele digitou clicando em Validar.

8. Se o vendedor e o cartão do comprador são afiliados no programa 3D Secure, uma autenticação 3DSecure ocorre.

9. Uma solicitação de autorização é feita para o banco do comprador, o emissor, além de controles defraudes internas da plataforma de pagamento.



10.Em caso de êxito, uma página de resumo será apresentada ao comprador resumindo as informaçõesda transação.

Um botão possibilitando o retorno para a loja aparece.

Figura 3 : Resumo da transação

Em caso de falha, aparece uma mensagem. O comprador é informado de que a solicitação de pagamentofoi recusada. Um botão que permite cancelar e retornar para a loja aparece.

Figura 4 : Página de resumo em caso de falhar da transação



4.2. Definir as etapas de um pagamento - Visão do vendedor

O pagamento online, do lado do vendedor, acontece da seguinte forma:

Figura 5 : Cinemática das trocas - Visão do vendedor

1. O comprador finaliza o pedido.

2. O site de e-commerce elabora o formulário a partir dos dados do carrinho do comprador.

3. O site de e-commerce redireciona o comprador para a plataforma de pagamento. Esseredirecionamento assumirá a forma de um formulário HTML POST em HTTPS. Os parâmetros doformulário são descritos no capítulo Gerar um formulário de pagamento.

4. Depois que o comprador digitou os dados do meio de pagamento, a plataforma efetua o pagamento.

5. Segundo a configuração da loja (ver capítulo Configurar as notificações), uma chamada automáticasubmete o resultado do pagamento ao site de e-commerce.

6. O site de e-commerce analisa e trata o resultado do pagamento.

7. Inicia a atualização da sua base de dados (status do pedido, estoque, etc.).

8. O comprador recebe o resultado do pagamento na plataforma. Se ele decide voltar para o site de e-commerce, este último o agradece e exibe o status do pedido.



4.3. Ciclo de vida das transações

Em todos os seguintes esquemas, a legenda seguinte é adotada:

Ação do vendedor necessária - manual (Back Office) ou automática (serviço web)

Modo de validação automática

Ciclo de vida de uma transação de pagamento à vista

Na sequência da solicitação de pagamento, certos controles são automaticamente iniciados:

• A autenticação3D Secure.

• Diferentes controles locais efetuados diretamente pela plataforma de pagamento (eles podem incluiros controles vinculados a contratação do serviço adicional de controles antifraude).

• Uma solicitação de autorização é também efetuada no banco do comprador, no mesmo dia da data depagamento, seja qual for a data pedida de captura no banco.

Se um dos controles falhar, a solicitação de pagamento será recusada. O comprador é informado darecusa. No Back Office, pode consultar a transação com o status Recusado.

Caso contrário, o status da transação será Aguardando captura.

O comprador é informado se a solicitação de pagamento dele foi aceita e recebe um e-mail deconfirmação. A transação será entregue automaticamente no dia pedido pelo vendedor.

Na espera desta captura , o vendedor pode mudar a data de captura assim como o valor (modificaçãodo valor somente para um valor menor, este caso corresponde a uma entrega parcial do vendedor).

Se for preciso, ele pode também cancelar a transação, que terá então o status Cancelado.



Ciclo de vida de uma transação de pagamento pré-datado

Prazo de captura menor que o tempo de validade da autorização

(ver diagrama ciclo de vida de uma transação de pagamento a vista).

Prazo de captura maior que o tempo de validade da autorização

Qualquer transação de pagamento pré-datado efetuada com o modo de validação automática, com umasolicitação de autorização de 1 BRL efetuada com sucesso, pode ser consultada no Back Office com o statusAguardando autorização.

A solicitação de autorização é efetuada automaticamente:

• processo padrão: o dia da data desejada de captura no banco,

• processo com autorização antecipada: em função do meio de pagamento selecionado, a D-X (verquadro ilustrando a validade de uma autorização) antes da data desejada de captura no banco.

Entre em contato com o suporte técnico se você deseja ativar a funcionalidade de autorizaçãoantecipada.

Em caso de uma recusa de tipo não frauduloso (ver quadro), a autorização será repetida todo dia atéD-2 antes da data de captura no banco. Durante a espera, o vendedor pode cancelar a transação oumodificar o valor desta última (somente para um valor menor) e/ou a data de captura.

O diagrama seguinte apresenta os diferentes status de um pagamento adiado:



Ciclo de vida de uma transação de pagamento parcelado

A primeira prestação do pagamento parcelado seguirá exatamente as mesmas regras que uma transaçãode pagamento à vista ou uma transação de pagamento pré-datado em função da sua data de captura nobanco.

As seguintes parcelas são por padrão posicionadas no status Autorização em andamento. O banco docomprador poderá recusar a solicitação de autorização. A plataforma de pagamento informará em seguidapor e-mail que a transação foi recusada.

As solicitações de autorização das seguintes parcelas estão automaticamente efetuadas como para umatransação de pagamento pré-datado, ou seja, com duas datas possíveis:

• processo padrão: o dia da data desejada de captura no banco,

• processo com autorização antecipada: em função do meio de pagamento selecionado, a D-X (verquadro ilustrando a validade de uma autorização) antes da data desejada de captura no banco.

As parcelas posteriores seguem o diagrama de status seguinte (caso de uma solicitação de autorizaçãoque não foi lançada de novo):

O cancelamento de uma parcela não diz em nenhum caso que as seguintes parcelas a serem capturadasno banco serão canceladas.



Modo de validação manual

Ciclo de vida de uma transação de pagamento à vista

Na sequência da solicitação de pagamento, certos controles são automaticamente iniciados:

• A autentificação 3D Secure.

• Diferentes controles locais efetuados diretamente pela plataforma de pagamento (eles podem incluiros controles vinculados a contratação do serviço adicional de controles antifraude).

• Uma solicitação de autorização esta sendo efetuada no banco do comprador.

Se um dos controles falha, a solicitação de pagamento é recusada. O comprador é informado da recusa.No Back Office, pode consultar a transação com o status Recusado.

Caso contrário o pagamento é aceito e a transação pode ser consultada no Back Office com o status AValidar.

O vendedor deve então obrigatoriamente validar a transação antes da data de captura solicitada. Casocontrário, a transação terá o status Expirado e não poderá mais ser capturada no banco.

Assim que uma transação for validada, terá o status Aguardando captura.

Pode também cancelar a transação se for necessário. A transação terá então o status Cancelado.



Ciclo de vida de uma transação de pagamento pré-datado

Prazo de captura menor que o tempo de validade da autorização

(ver diagrama ciclo de vida de uma transação de pagamento à vista).

Prazo de captura maior que o tempo de validade da autorização

Qualquer transação de pagamento pré-datado efetuada com o modo de validação manual, com umasolicitação de autorização de 1 BRL efetuada com sucesso, pode ser consultada no Back Office com o statusPara validar e para autorizar.

A solicitação de autorização é automaticamente efetuada no dia da captura solicitado no banco, sobreserva que o vendedor tenha anteriormente validado a transação.

Enquanto espera a captura, o vendedor pode cancelar a transação ou modificar o valor desta última e/oua data de captura. Estas transações seguem o diagrama de status seguinte:



Ciclo de vida de uma transação de pagamento parcelado

A primeira prestação do pagamento parcelado seguirá exatamente as mesmas regras que uma transaçãode pagamento à vista ou uma transação de pagamento pré-datado, em função da data de captura nobanco solicitada.

As parcelas posteriores são por padrão posicionadas no status Para validar e autorizar enquanto a primeiraparcela não for validada pelo vendedor. A quitação destas últimas não esta garantida para o vendedor. Defato, o banco do comprador pode recusar a solicitação de autorização.

A validação da 1a parcela vale como validação de todas as parcelas seguintes. Porém, o cancelamentode uma parcela não provoca o cancelamento das parcelas posteriores.



Pontos específicos vinculados às autorizações antecipadas.

Entre em contato com o suporte técnico se você deseja ativar as autorizações antecipadas.

Este processo aplica-se somente para as solicitações de autorização:

• do pagamento pré-datado,

• das parcelas, que não seja a primeira, para um pagamento parcelado.

O inicio da autorização será efetuado a D-Δ (ver quadro de validade de uma autorização para cada meiode pagamento) antes da data de captura no banco desejada.

Se foi recusado pelo servidor de autorização do banco do comprador, exclusivamente por um motivo nãofrauduloso (ver quadro), um processo retoma automaticamente as solicitações de autorização até D-2.

Se foi recusado por um motivo frauduloso, a transação é considerada como definitivamente recusada.



5. ESTABELECER O DIÁLOGO COM A PLATAFORMA DEPAGAMENTO

O diálogo entre o site de e-commerce e a plataforma de pagamento realiza-se via uma troca de dados.

Para criar um pagamento, estes dados são enviados em um formulário HTML via o navegador docomprador.

No final do pagamento, o resultado será enviado ao site de e-commerce de duas maneiras:

• automaticamente com notificações chamadas URL de notificação instantânea (também chamada IPNpara Instant Payment Notification), ver capítulo Configurar as notificações.

• pelo navegador quando o comprador clica no botão para voltar no site de e-commerce, ver capítuloGerenciar o retorno para o site de e-commerce.

Para garantir a segurança das trocas, os dados são assinados com uma chave (anteriormente chamada“certificado”) somente conhecida pelo vendedor e pela plataforma de pagamento.

5.1. Definir a URL da página de pagamento

O site de e-commerce comunica com a plataforma de pagamento redirecionando o comprador para a URLabaixo:

https://secure.payzen.com.br/vads-payment/

5.2. Identificar-se durante as trocas

Para dialogar com a plataforma de pagamento, o vendedor precisa de duas informações:

• Código da loja: permite identificar o site de e-commerce durante as trocas. Seu valor for enviado parao campo vads_site_id.

• A chave: anteriormente chamado “certificado”, permite calcular a assinatura alfanumérica enviada nocampo assinatura.

Para resgatar estes valores:

1. Conecte-se ao seu Back Office : https://secure.payzen.com.br/vads-merchant/

2. Clique sobre Configuração > Loja.

3. Selecionar a aba Certificados.

Figura 6 : Aba Certificados

Dois tipos de chave (certificado) são disponibilizados:

• A chave (certificado) de teste que permite gerar a assinatura de um formulário em modo de teste.


https://secure.payzen.com.br/vads-merchant/



• A chave (certificado) de produção que permite gerar a assinatura de um formulário em modo deprodução.

Estas chaves podem ser numéricas ou alfanuméricas.

Para uma segurança máxima, recomendamos usar um certificado alfanumérico.

Para mudar o formato da sua chave de teste, clique no botão Gerar de novo um certificado de teste, eselecione em seguida o formato (“ALFANUMÉRICO” ou “NUMÉRICO”).

Para mudar o formato da sua chave de produção, clique no botão Gerar de novo um certificado deprodução, e selecione “ALFANUMÉRICO” ou “NUMÉRICO”.

5.3. Escolher o modo de Teste ou de Produção

A escolha do modo de TEST ou PRODUCTION realiza-se usando o campo vads_ctx_mode (Ver capítuloCriar um formulário de pagamento).

• O modo TEST permite efetuar pagamentos de teste.

Está sempre disponível, mesmo depois de gerar a chave (certificado) de produção.

Se você estiver criando um novo site de e-commerce (ou possuir ambiente onde fatura), você poderárealizar seus testes sem impacto para o site atualmente em funcionamento.

As transações de TESTE estão disponíveis no Back Office no menu Gerenciador > Transações de Teste



• O modo PRODUCTION estará disponível somente uma vez que a chave (certificado) de produção forgerada (ver capítulo Ativar a loja em modo de PRODUÇÃO).

Ele permite efetuar pagamentos reais.

As transações de PRODUÇÃO estão disponíveis no Back Office no menu Gerenciador > Transações.



5.4. Gerenciar o diálogo com o site de e-commerce

A gestão do diálogo com o site de e-commerce é realizada graças a dois tipos de URL:

• Url de notificação instantânea, também chamada IPN (Instant Payment Notification),

• Url de retorno para o site de e-commerce.

Url de notificação instantânea - IPN (Instant Payment Notification)

A plataforma de pagamento notifica automaticamente o resultado do pagamento ao site de e-commerce.Os dados são enviados em modo POST.

A plataforma é capaz de entrar em contato com o site de e-commerce seja qual for o protocolo usado(http ou https).

As notificações são enviadas a partir de um endereço IP que consta na faixa 194.50.38.0/24 em modo deTeste e em modo de Produção.

Para tratar essas notificações, o vendedor deve criar uma página no seu site que:

• analisa os dados recebidos em modo POST,

• garante a integridade das informações recebidas calculando a assinatura,

• verifica que não se trate de uma dupla notificação (reenvio da notificação a partir do Back Office porexemplo),

• inicia a atualização da sua base de dados (status do pedido, estoque, etc.),

• envia e-mails para o comprador (fatura, acompanhamento de pedido, etc.).

O tempo de processamento impacta diretamente o prazo para a visualização da página de resumo dopagamento. Quanto mais o processamento demorar, mais longo o tempo de espera antes de visualizar.

Para receber as notificações, o vendedor deve configurar as regras de notificações no seu Back Office (vercapítulo Configurar as notificações).

Em caso de problema de comunicação com o site de e-commerce, a plataforma de pagamento envia ume-mail para o administrador da loja, destacando o motivo da falha (erro http. etc.) bem como os passos aseguir para enviar de novo a notificação no Back Office.

Url de retorno para o site de e-commerce

O vendedor pode configurar no Back Office as URL de retorno "padrões" no menu Configurações > Loja> aba Configuração):

Figura 7 : Especificações dos URL de retorno

Pode configurar uma URL de retorno para a loja diferente segundo o modo.

O padrão é que o comprador seja redirecionado para a URL de retorno, seja qual for o resultado.

Se por acaso nenhuma URL estiver configurada neste nível, então o redirecionamento usará a URL principalda loja (campo URL definido no quadro Detalhes da loja).



O vendedor tem a possibilidade de sobrescrever esta configuração no seu formulário de pagamento (vercapítulo Definir as URL de retorno).

Observação:

O status da regra "URL de notificação instantânea no final do pagamento" (IPN) está disponível nesta tela.Se esta última não estiver configurada, favor configurar-la (ver capítulo Configurar as notificações) .

5.5. Gerenciar a segurança

Diferentes meios são implementados para garantir a segurança das transações de pagamento em linha.

Garantir a integridade das trocas

A integridade das informações trocadas é garantida por uma troca de assinaturas alfanuméricas entre aplataforma de pagamento e o site de e-commerce.

O diálogo entre a plataforma de pagamento e o site de e-commerce realiza-se via apresentação deformulários HTML.

Um formulário contém uma lista de campos específicos (ver capítulo Gerar um formulário de pagamento)usados para gerar um string.

Este string será em seguida convertido em um string de menor tamanho graças à função hash (SHA-1,HMAC-SHA-256).

O vendedor poderá escolher o algoritmo hash no seu Back Office (ver capítulo Selecionar o algoritmohash).

O string obtido é chamado pegada (digest em inglês) do string inicial.

A pegada deve ser transmitida no campo assinatura (ver capítulo Calcular a assinatura).

Modelização dos mecanismos de segurança:

Figura 8 : Diagrama mecanismo de segurança

1. O site de e-commerce recupera os dados do formulário e calcula a assinatura.

2. O site de e-commerce submete o formulário para a plataforma.

3. A plataforma recupera os dados do formulário e calcula a assinatura.

4. A plataforma compara a assinatura calculada com a assinatura enviada pelo site de e-commerce.

5. Se as assinaturas forem diferentes, a solicitação de pagamento será recusada.



Se não, a plataforma efetuará o pagamento.

6. A plataforma recupera os dados do resultado e calcula a assinatura da resposta.

7. Segundo a configuração da loja (ver capítulo Configurar as notificações), a plataforma submete oresultado do pagamento ao site de e-commerce.

8. O site de e-commerce recupera os dados e calcula a assinatura. Ele compara a assinatura calculadacom a assinatura enviada pela plataforma.

9. Se as assinaturas forem diferentes, o vendedor analisará a origem do erro (erro de cálculo, tentativade fraude etc.)

Se não, o site de e-commerce atualizará a sua base de dados (estado do estoque, estado do pedido etc.).

Selecionar o algoritmo hash

No menu Configurações > Loja > Configuração, o vendedor pode escolher a função hash que será usadapara gerar as assinaturas.

Por padrão, o algoritmo HMAC-SHA-256 será aplicado.

Importante

Você pode selecionar um algoritmo diferente para o modo Teste e para o modo Produção.

Porém, certifique-se de usar o mesmo método para gerar seus formulários de pagamento e para analisaros dados enviados nas notificações.

Guardar a chave de produção

Assim que o primeiro pagamento foi efetuado com um cartão físico, a chave (certificado) de produção éoculta por razões de segurança.

Aconselhamos fortemente guardar esta chave em um lugar seguro (arquivo criptografado, base de dadosetc.).

Em caso de perda, o vendedor terá a possibilidade de gerar uma nova chave desde seu Back Office.

Para lembrança, a chave de produção esta disponível no Back Office no menu Configuração > Loja > abaCertificados.

Gerenciar os dados sensíveis

Regras estritas regem as transações de pagamento online (Certificação PCI-DSS).

Como vendedor, você tem que ter certeza de nunca divulgar dados não criptografados que poderiam sersemelhantes a um número de cartão bancário. Seu formulário seria recusado (código 999 - Sensitive datadetected).

Evite particularmente os números de pedidos de um comprimento entre 13 e 16 símbolos numéricos ecomeçando por 3, 4 ou 5.



5.6. Gerenciar as configurações da sua loja por arquivo de configuração

A utilização de uma arquivo de configuração permite evitar inserir valores manualmente ou via macrosno código.

Os arquivos de configuração podem conter:

• a URL da página de pagamento,

• As chaves de teste e de produção,

• o código da loja,

• etc.

Estes arquivos permitem caracterizar os dados que devem ser salvos.

O programa que gera o formulário de pagamento chamará o arquivo de configuração com o parâmetropara usar o valor.

Cabe ao vendedor garantir:

• Que tenha direitos sobre o arquivo para que ninguém indevido o acesse.

• Responder às especificidades vinculadas à linguagem de programação usada.

Exemplo de arquivo de configuração “conf.txt”:

vads_site_id = 11111111TEST_key = 2222222222222222PROD_key = 3333333333333333vads_ctx_mode = TEST

Exemplo de chamada de configuração no formulário de pagamento :

$conf_txt = parse_ini_file("conf.txt"); if ($conf_txt['vads_ctx_mode'] == "TEST") $conf_txt['key'] = $conf_txt['TEST_key']; if ($conf_txt['vads_ctx_mode'] == "PRODUCTION") $conf_txt['key'] = $conf_txt['PROD_key'];



6. CONFIGURAR AS NOTIFICAÇÕES

O Back Office permite gerenciar os eventos que vão gerar uma chamada para o site de e-commerce econfigurar a URL da página que deve ser solicitada.

Os seguintes esquemas ilustram, para cada evento, o status da transação enviado na notificação.

A legenda escolhida para cada um é a seguinte:

Ação do vendedor necessária - manual (Back Office) ou automática (serviço web)

Ação do comprador

6.1. Notificações dos diferentes status para um pagamento a vista

Figura 9 : Diagrama de fluxo - Pagamento a vista

Evento Status notificado Nome da regra para ser configurada

O comprador desistiu ABANDONEDURL de notificação ao cancelamento emcancelamento

Cancelado pelo vendedor CANCELLEDURL de notificação sobre uma operaçãoproveniente do Back Office

Resposta ao pedido de autorizaçãoAUTHORISED_TO_VALIDATE,AUTHORISED, REFUSED

URL de notificação no final do pagamento

Tabela 1 : Regras de notificação a serem ativadas para um pagamento a vista



6.2. Notificações dos diferentes status para um pagamento pré-datado

Figura 10 : Diagrama de fluxo - Pagamento pré-datado

Δ : tempo de validade de autorização.


O comprador desistiu ABANDONEDURL de notificação ao cancelamentoem cancelamento

Cancelado pelo vendedor CANCELLEDURL de notificação sobre umaoperação proveniente do Back Office

Validação pelo vendedor WAITING_AUTHORISATIONURL de notificação sobre umaoperação proveniente do Back Office

Resposta à solicitação deautorização de 1 BRL

REFUSED, WAITING_AUTHORISATION,WAITING_AUTHORISATION_TO_VALIDATE

URL de notificação no final dopagamento

Resposta ao pedido de autorizaçãoAUTHORISED, REFUSED,AUTHORISED_TO_VALIDATE

URL de notificação sobre umaautorização por lote

Tabela 2 : Regras de notificação a serem ativadas para um pagamento pré-datado



6.3. Notificações dos diferentes status para as parcelas de um pagamentoparcelado

Figura 11 : Diagrama de fluxo - Vencimentos de um pagamento parcelado

Δ : tempo de validade de autorização.


Cancelado pelo vendedor CANCELLEDURL de notificação sobre uma operaçãoproveniente do Back Office

Resposta ao pedido de autorização AUTHORISED, REFUSEDURL de notificação sobre umaautorização por lote

Tabela 3 : Regras de notificação a serem ativadas para um pagamento parcelado



6.4. Configurar as notificações

Diversos tipos de notificações estão disponíveis no Back Office. Elas possibilitam gerenciar os eventos (ocomprador desistiu da compra, cancelamento pelo vendedor, validação pelo vendedor...) que gerarão umachamada para o site de e-commerce e configurar a URL da página a contatar.

Para acessar ao gerenciamento das regras de notificação:

1. Conecte-se a: https://secure.payzen.com.br/vads-merchant/.

2. Ir para o menu: Configuração > Regras de notificações.

Figura 12 : Regras de notificações

Configurar a notificação no final do pagamento

Esta notificação é imprescindível para comunicar o resultado de uma solicitação de pagamento.

Para configurar esta notificação:

1. Fazer um click direito na linha URL de notificação no final do pagamento.

2. Selecionar Ativar a regra.

3. Clique direito de novo na URL de notificação no final do pagamento.

4. Selecionar Gerenciar a regra.

5. Informar a URL da sua página nos campos URL para chamar em modo de TESTE e URL para chamarem modo de PRODUÇÃO.

6. Preencher o campo Endereço(s) de e-mail(s) para avisar em caso de falha.

7. Para especificar vários endereços e-mails, separe os e-mails por um ponto e vírgula.

8. Configurar a Re-chamada automática em caso de falha.

Esta opção permite enviar de novo e automaticamente a notificação para o site de e-commerce sehouver falhar, até 4 vezes

Para maiores informações, ver capítulo Ativar a re-chamada automática

https://secure.payzen.com.br/vads-merchant/



9. Salve suas modificações.

Se a plataforma não conseguir entrar em contato com a URL da sua página, um e-mail será enviado parao endereço e-mail especificado.

Contém:

• O código HTTP do erro encontrado

• Elementos de análise em função do erro

• As suas consequências

• Os passos a seguir a partir do Back Office para enviar de novo a solicitação para a URL definida acima.



Configurar a notificação do resultado final de um pagamento pré-datado

Esta notificação é imprescindível para comunicar o resultado de um pagamento pré-datado:

• Se o pagamento foi aceito.

• Se o pagamento foi recusado.

Permite ao site de e-commerce ser notificado quando há uma solicitação de autorização.

Exemplo:

Para um pagamento pré-datado com prazo de 60 dias, a solicitação de autorização não é efetuadadurante o pagamento. O site e-commerce será contactado durante o pedido de autorização pela regraURL de notificação sobre uma autorização por batch.

Esta regra esta desativada por padrão.


1. Fazer um clique direito na linha URL de notificação sobre uma autorização por batch.


3. Informar a URL de sua página nos campos URL para chamar em modo de TESTE e URL para chamarem modo de PRODUÇÃO.

Figura 13 : Configure a notificação em autorização por batch





Para maiores informações, ver capítulo Ativar a re-chamada automática.


8. Ativar a regra, fazendo um clique direito em URL de notificação sobre uma autorização por batch eselecione Ativar a regra.


Contém:







Configurar a notificação se o comprador desistir ou cancelar

A plataforma de pagamento pode notificar sistematicamente o site de e-commerce:

• Se o comprador desistir ou cancelar, com o botão Cancelar e Voltar para a loja.

• Quando o comprador não finalizou o pagamento antes do fim da sessão de pagamento.

O tempo máximo de uma sessão de pagamento é de 10 minutos.


1. Fazer um click direito na linha URL de notificação em cancelamento.


3. Informar a URL da sua página nos campos URL para chamar em modo de TESTE e URL para chamarem modo de PRODUÇÃO.








Contém:







Configurar a notificação em autorização por batch

A plataforma de pagamento pode notificar sistematicamente o site de e-commerce quando uma transaçãocom um status À validar for vencido. O vencimento dispara a notificação. O status Expirado é definitivo.

Recomendamos ativar esta notificação com transações PayPal (mode Order) para ser notificado dacaptura.

Esta regra esta desativada por padrão.


1. Clique direito na linha URL de notificação em autorização por batch.


3. Informar a URL da sua página nos campos URL a ser chamada em modo TEST e URL a ser chamadaem modo de PRODUÇÃO.







8. Ativar a regra, fazendo um clique direito em URL de notificação em modificação por batch eselecione Ativar a regra.


Contém:







6.5. Ativar a rechamada automática

Esta opção permite enviar de novo e automaticamente a notificação para o site de e-commerce se houverfalhar, até 4 vezes

Uma autenticação será considerada em falha se o código de retorno HTTP retornado pelo servidorvendedor não constar na lista seguinte: 200, 201, 202, 203, 204, 205, 206, 301, 302.

Os códigos de retorno HTTP são padronizados pelo W3C no RFC 2616.

A rechamada automática não se aplica às notificações enviadas manualmente a partir do Back Office.

Para ativar a rechamada automática:

1. No Back Office, ir no menu: Configuração > Regras de notificações.

2. Clique direito em uma das regras de notificações exibidas.


Figura 14 : URL de notificação no final do pagamento




As tentativas de chamadas são programadas a horários fixos a cada 15 minutos (00, 15, 30, 45).Após cada tentativa não sucedida, um e-mail de alerta será enviado para o endereço informadoanteriormente.

O título do e-mail de aviso apresenta o número da tentativa de envio da notificação. Ele éapresentado sob a forma attempt # seguido do número de tentativa.

Exemplo de título de um e-mail recebido após a primeira falha de notificação no final de umpagamento:

[MODE TEST] Minha loja - Tr. ref. 067925 / FALHA durante a chamada da sua URL de notificação [unsuccessful attempt #1]

Exemplo de título de e-mail recebido após uma segunda falha:


Exemplo de título de e-mail recebido após uma terceira falhar:




Para notificar ao site de e-commerce a falha da última tentativa de notificação, o título do e-mailapresentará a menção attempt #last.

Exemplo de título de e-mail recebido após a última tentativa:

[MODE TEST] Minha loja - Tr. ref. 067925 / FALHA durante a chamada da sua URL de notificação [unsuccessful attempt #last]

Para cada um dos e-mails recebidos, o conteúdo do e-mail apresentará:

• o problema encontrado

• elementos de análise em função do erro

• as suas consequências

• os passos a seguir a partir do Back Office para enviar de novo a solicitação para a URL definida naetapa 4

Observação:

Após a quarta tentativa, pode-se também chamar de novo a URL de notificação. Pode ser feitomanualmente no seu Back Office.

Atenção, durante a rechamada automática, toda chamada manual para a URL de notificação vaiafetar o número de tentativas automáticas.

• uma chamada manual realizada com sucesso encerra a rechamada automática

• um chamada manual em falha não terá impacto na rechamada automática em andamento.


Observação:

Durante a rechamada automática, algumas informações não são registradas no banco de dados ou sãomodificadas.

Exemplos de campos não disponíveis / não salvos em banco de dados:

• vads_page_action

• vads_payment_config

• vads_action_mode

Exemplos de campos enviados com valores diferentes:

• vads_url_check_src tem o valor RETRY.

• vads_trans_status. O status da transação após esta operação muda em função do seu status na horaque a URL é chamada (ver capítulo Ciclo de vida das transações)

• vads_hash valorizado de outra forma conforme os novos valores

• signature valorizado de outra forma conforme os novos valores



6.6. Rechamar manualmente a notificação

Esta opção permite executar de novo manualmente a URL de notificação no Back Office quando umatransação estiver em falha.

1. No Back-Office, procure a transação para qual você deseja re-chamar manualmente a notificação.

2. Clique direito na transação e selecione Executar a URL de notificação.

Se sua aplicação estiver de novo disponível, uma mensagem lhe informará que a solicitação foirealizada com sucesso.

De qualquer forma, você poderá visualizar o resultado da sua ação no histórico dos eventos datransação e analizar as mensagens de erro se o problema persistir.

Durante a rechamada automática no Back Office, algumas informações não são registradas no banco dedados ou são modificadas.

Exemplos de campos não disponíveis / não salvos em banco de dados:




Exemplos de campos enviados com valores diferentes:

• vads_url_check_src tem o valor BO.

• vads_trans_status. O status da transação após esta operação muda em função do seu status na horaque a URL é chamada (ver capítulo Ciclo de vida das transações)

• vads_hash valorizado de outra forma conforme os novos valores.

• signature valorizado de outra forma conforme os novos valores.



6.7. Configurar os e-mails enviados para o comprador

O Back-Office permite que o vendedor configure e-mails destinados ao comprador:

• E-mail de confirmação da assinatura.

• E-mail de confirmação de pagamento.

• E-mail de confirmação de cadastro.

Para configurar estes e-mails:


2. Selecione a aba E-mail enviado para o comprador.

3. Clique direito na denominação de um e-mail e selecione Ativar a regra.

Para personalizar um e-mail:

4. Clique direito na denominação de um e-mail que tenha a regra ativada e selecione Gerenciar a regra.

Três abas estão disponíveis.

• Configuração

Permite personalizar o e-mail que será enviado.

• Condições da regra

Permite criar uma lista (pode ser vazia) de condições de execução da regra (segundo o evento quedispara). Uma condição é constituída de uma variável, de um operador de comparação e de umvalor de referência.

Exemplo: "modo = TESTE", "valor superior a 1000". Quando uma regra for executada, o valor davariável será resgatado e comparado com o valor de referência. Todas as condições devem servalidadas para que a regra seja executada.

• Informações

Exibe um resumo da regra.

5. Selecione a aba Configuração.

6. Personalizar o conteúdo do e-mail segundo suas necessidades.

a. Clique em Configuração e-mail comprador para exibir o conteúdo do e-mail "padrão" comum atodos os vendedores que utilizam a plataforma de pagamento.

b. Selecione a aba que corresponde ao idioma do e-mail que você deseja personalizar.

c. Clique em Personalizar valores de texto por padrão.

d. Modificar o texto do e-mail.

e. Clique em Campos para incluir para exibir a lista dos campos disponíveis para personalizar o e-mail.

f. Selecione os campos que você deseja incluir no e-mail. Um resumo detalhado do tratamento dasolicitação será acrescentado ao conteúdo do e-mail.

7. Clique em Salvar.



6.8. Configurar os e-mails enviados para o vendedor

A plataforma de pagamento pode notificar o vendedor por padrão nos casos seguintes:

• E-mail de confirmação de pagamento

• E-mail de recusa de pagamento agendado

• E-mail de confirmação de cadastro cliente

• E-mail de recusa parcelas de pagamento em x vezes

• E-mail de confirmação da assinatura

• E-mail de re-geração da chave de produção

Para configurar estes e-mails:


2. Selecione a aba E-mail enviado para o vendedor.

3. Clique direito na denominação de um e-mail e selecione Ativar a regra.

Para personalizar um e-mail:

4. Clique direito na denominação de um e-mail que tenha a regra ativada e selecione Gerenciar a regra.

Três abas estão disponíveis.

• Configuração

Permite personalizar o e-mail que será enviado.

• Condições da regra

Permite criar uma lista (pode ser vazia) de condições de execução da regra (segundo o evento quedispara). Uma condição é constituída de uma variável, de um operador de comparação e de umvalor de referência.

Exemplo: "modo = TESTE", "valor superior a 1000". Quando uma regra for executada, o valor davariável será resgatado e comparado com o valor de referência. Todas as condições devem servalidadas para que a regra seja executada.

• Informações

Exibe um resumo da regra.

5. Selecione a aba Configuração.

6. Personalizar o conteúdo do e-mail segundo suas necessidades.

a. Clique em Configuração geral para especificar o endereço e-mail para ser notificado e em opção,o gerente da empresa e/ou o contato técnico da empresa e/ou o gerente da loja.

b. Clique em Configuração e-mail para exibir o conteúdo do e-mail "padrão" comum a todos osvendedores que utilizam a plataforma de pagamento.

c. Selecione a aba que corresponde ao idioma do e-mail que você deseja personalizar.

d. Clique em Personalizar valores de texto por padrão.

e. Modificar o texto do e-mail.

f. Clique em Campos para incluir para exibir a lista dos campos disponíveis para personalizar o e-mail.



g. Selecione os campos que você deseja incluir no e-mail. Um resumo detalhado do tratamento dasolicitação será acrescentado ao conteúdo do e-mail.

Observação:

Para visualizar antes as modificações efetuadas, clique em Pré-visualizar o e-mail localizado em baixoda caixa de diálogo.




7. CRIAR UM FORMULÁRIO DE PAGAMENTO

Para criar uma solicitação de pagamento, você deve montar um formulário html da seguinte forma:

<form method="POST" ação="https://secure.payzen.com.br/vads-payment/"> <input type="hidden" name="parametre1" value="valor1" /> <input type="hidden" name="parametre2" value="valor2" /> <input type="hidden" name="parametre3" value="valor3" /> <input type="hidden" name="assinatura" value="signature"/> <input type="submit" name="pagar" value="Pagar"/></form>

Contém:

Os elementos técnicos seguintes:

• As marcas <form> e </form> que permitem criar um formulário HTML.

• O atributo method="POST" que especifica o método usado para enviar os dados.

• O atributo action="https://secure.payzen.com.br/vads-payment/" que especifica onde enviar os dadosdo formulário.

Os dados do formulário:

• O código da loja.

• As características do pagamento em função do caso de uso(ver capítulos seguintes).

• As informações complementares em função das suas necessidades (ver capítulo Usar funçõescomplementares ).

• A assinatura que garante a integridade do formulário (ver capítulo Calcular a assinatura).

Estes dados são acrescentados ao formulário usando o tag <input> :

<input type="hidden" name="parametro1" value="valor1" />

Para valorizar os atributos name e value, ver o capítulo Dicionário de dados.

Todos os dados do formulário devem ser codificados em UTF-8.

Os símbolos especiais (acentos, pontuação etc...) serão assim devidamente interpretados pela plataformade pagamento. Caso contrário, o cálculo de assinatura estará errado e o formulário será recusado.

O botão Pagar vai permitir o envio dos dados:

<input type="submit" name="pagar" value="Pagar"/>





Casos de uso são apresentados nos capítulos seguintes. Eles permitem montar um formulário depagamento segundo suas necessidades.

Os campos necessários para implementar estes casos de uso são apresentados na forma de quadros,mencionando particularmente o formato que deve ser usado (ver a codificação abaixo)

Notação Descrição

a Símbolos alfabéticos (de "A" a "Z" e de "a" a "z")

n Símbolos numéricos

s Símbolos especiais

an Símbolos alfanuméricos

ans Símbolos alfanuméricos e especiais (com exceção de "<" e ">")

3 Comprimento fixo até 3 símbolos

..12 Comprimento variável até 12 símbolos

json JavaScript Object Notation.Objeto contendo pares de chave/valor separados por uma virgula.Começa por uma chaveta esquerda " { e acaba com uma chaveta direita " }".Cada par de chave/valor possui o nome da chave entre aspas duplas seguido por " : ", seguido por um valor.O nome da chave deve ser alfanumérico.O valor pode ser:

• Um string de caracteres (neste caso ele deve ficar entre aspas duplas)

• um número

• um objeto

• um quadro

• um booliano

• Vazio

Exemplo: {"name1":45,"name2":"value2", "name3"=false}

enum Caracteriza um campo que possui um número infinito de valores.A lista dos valores possíveis é dada na definição do campo.

Lista de enum Lista de valores separados por um " ; ".A lista dos valores possíveis é dada na definição do campo.Exemplo: vads_payment_cards=VISA;MASTERCARD

map Lista de pares chave/valor separados por um " ; ".Todo par chave/valor contém o nome da chave seguido por " = ", seguido por um valor.O valor pode ser:

• um string de caracteres

• um booliano

• um objeto json

• um objeto xml

A lista dos valores possíveis para cada par de chave/valor é dada na definição do campo.Exemplo: vads_theme_config=SIMPLIFIED_DISPLAY=true;RESPONSIVE_MODEL=Model_1



7.1. Criar um pagamento à vista

Em modo de pagamento à vista, o comprador paga a totalidade da sua compra de uma vez.

O pagamento é apresentado no banco no mesmo dia.

1. Informar a totalidade dos campos do quadro que segue para montar seu formulário de pagamento.

Nome do campo Descrição Formato Valor

vads_site_id Código da loja n8 Ex: 12345678

vads_ctx_mode Modo de comunicação com aplataforma de pagamento

enumTEST ouPRODUCTION

vads_trans_id Número da transação n6 Ex: 123456

vads_trans_date Data e hora do formulário depagamento no fuso horário UTC

n14Ex: 20170701130025

vads_amount Valor do pagamento (na suamenor unidade monetária)

n..12Ex: 3000 para 30,00 BRL

vads_currency Código numérico da moeda aser usada para o pagamento,segundo a norma ISO 4217(código numérico)

n3

Ex: 986 para o real do Brasil (BRL)

vads_action_mode Modo de aquisição dos dados docartão

enumINTERACTIVE

vads_page_action Ação a ser realizada enum PAYMENT

vads_version Versão do protocolo de trocacom a plataforma de pagamento

enumV2

vads_payment_config Tipo de pagamento enum SINGLE

vads_capture_delay Prazo antes da captura no banco n..3 0

vads_validation_mode Modo de validação n1 0 (Automático)

Tabela 4 : Lista dos campos - Pagamento à vista

2. Preencher o campo vads_payment_config a SINGLE.

3. Preencher o campo vads_capture_delay a 0.

4. Preencher o campo vads_validation_mode a 0 para validar automaticamente (o pagamento seráapresentado automaticamente para o banco).

5. Preencher o campo vads_currency com o código da moeda desejada usando o quadro das moedas(Ex: 986 para o real do Brasil (BRL)).

6. Acrescentar campos opcionais segundo suas necessidades (ver capítulo Usar funçõescomplementares).

7. Calcule o valor do campo signature usando a totalidade dos campos do seu formulário, com o nomecomeçando por vads_ (ver capítulo Calcular a assinatura).



Exemplo de formulário para o pagamento à vista:

<form method="POST" action="https://secure.payzen.com.br/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="3000" /><input type="hidden" name="vads_capture_delay" value="0" /><input type="hidden" name="vads_ctx_mode" value="TEST" /><input type="hidden" name="vads_currency" value="986" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value="SINGLE" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20140526101407" /><input type="hidden" name="vads_trans_id" value="239848" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="0WaYrONo3L0VZqMcvyVf8vT/g8KfZKJ+1jqiAs3Ehiw="/><input type="submit" name="pagar" value="Pagar"/></form>




7.2. Criar um pagamento pré-datado

Um pagamento pré-datado é um pagamento que será debitado de um vez só e cuja captura no banco éexatamente superior a 0 dia.

Uma solicitação de informação será efetuada se o prazo de captura for superior à duração de validade deuma solicitação de autorização (ver quadro).

A solicitação de informação procura conferir a validade do cartão. Para os adquirentes que não atendemas solicitações de informações, uma solicitação de autorização de 1 BRL será realizada (ver quadro).








n14Ex: 20170701130025


n..12Ex: 3000 para 30,00 BRL


n3



enumINTERACTIVE



enumV2


vads_capture_delay Prazo antes da captura no bancocujo valor deve ser superior a 0

n..3Ex: 3

vads_validation_mode Apresenta o modo devalidação da transação(manualmente pelo vendedorou automaticamente pelaplataforma)

n1

0 ou 1 ou ausente ou vazio

Tabela 5 : Lista dos campos - Pagamento pré-datado

2. Preencher o campo vads_payment_config a SINGLE.

3. Preencher o campo vads_capture_delay com um valor superior a 0.

4. Preencher o campo vads_validation_mode a 0 para uma validação automática (o pagamentoserá entregue automaticamente no banco) ou a 1 para uma validação manual (o pagamento seráentregue no banco após uma validação manual no Back Office).

5. Preencher o campo vads_currency com o código da moeda desejada usando o quadro das moedas(Ex: 986 para o real do Brasil (BRL)

6. Acrescente os campos em opção em função das suas necessidades (ver capítulo Usar funçõescomplementares).

7. Calcular o valor do campo signature usando a totalidade dos campos do seu formulário, com o nomecomeçando por vads_ (ver capítulo Calcular a assinatura).



Exemplo de formulário de pagamento pré-datado:

<form method="POST" action="https://secure.payzen.com.br/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="3000" /><input type="hidden" name="vads_capture_delay" value="3" /><input type="hidden" name="vads_ctx_mode" value="TEST" /><input type="hidden" name="vads_currency" value="986" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value="SINGLE" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20140129130025" /><input type="hidden" name="vads_trans_id" value="130025" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="NrHSHyBBBc+TtcauudspNHQ5cYcy4tS4IjvdC0ztFe8="/><input type="submit" name="pagar" value="Pagar"/></form>




7.3. Criar um pagamento parcelado

Este modo de pagamento permite ao vendedor oferecer uma facilidade de pagamento para o comprador.

O formulário de pagamento estabelece o número de parcelas e o intervalo que os separa.

A primeira parcela funciona da mesma forma que um pagamento à vista.

As seguintes parcelas funcionam da mesma forma que um pagamento pré-datado.

Atenção:

As regras de notificações devem ser ativadas. Ver capítulo Configurar as notificações para maioresdetalhes.

Precisões:

No dia do pagamento, o vendedor não é creditado da totalidade do valor e a garantia de pagamento nãopode ser aplicada nas parcelas futuras.

A data da última parcela não pode ser superior a 1 ano em relação à data de apresentação do formulário.Caso contrário, uma mensagem de erro é exibida e o formulário será recusado.

1. Informar a totalidade dos campos presentes abaixo para montar seu formulário de pagamento.







n14Ex: 20170701130025


n..12Ex: 3000 para 30,00 BRL


n3



enumINTERACTIVE



enumV2

vads_payment_config Tipo de pagamento enum ver etapa 2.


vads_validation_mode Apresenta o modo devalidação da transação(manualmente pelo vendedorou automaticamente pelaplataforma)

n1

0 ou 1 ou ausente ou vazio

Tabela 6 : Lista dos campos - Pagamento parcelado

2. Preencher o campo vads_payment_config respeitando a seguinte sintaxe:

• Valores e datas de parcelas fixas :

MULTI:first=1000;count=3; period=30:

"first" corresponde o valor do pagamento (na sua menor unidade monetária) do primeiropagamento feito no dia do pagamento,

"count" representa o número total de parcelas,

"period" determina o intervalo entre cada parcela.

• Valores e datas de parcelas personalizadas:



MULTI_EXT:data1=valor 1;data2=valor 2;data3=valor3 ou:

data1=valor1 estabelece a data e o valor da primeira transferência.

Os valores são apresentados na menor unidade da moeda. A soma de todos os valores deve serigual ao valor do campo vads_amount.

As datas são apresentadas no formato YYYYMMDD.

3. Preencher o campo vads_capture_delay a 0. O primeiro pagamento será entregue no banco omesmo dia.

4. Preencher o campo vads_validation_mode a 0 para uma validação automática (o pagamento seráentregue automaticamente no banco) ou a 1 para uma validação manual (operação manual efetuadapelo Back Office).

O modo de validação se aplica para todas as parcelas.



7. Calcular o valor do campo signature usando a totalidade dos campos do seu formulário, com o nomecomeçando por vads_ (ver capítulo Calcular a assinatura)

Exemplo de formulário de pagamento parcelado (Valores e datas de parcelas fixas):

<form method="POST" action="https://secure.payzen.com.br/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="3000" /><input type="hidden" name="vads_ctx_mode" value="TEST" /><input type="hidden" name="vads_currency" value="986" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value="MULTI:first=1000;count=3;period=30"/><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20140129180150" /><input type="hidden" name="vads_trans_id" value="180150" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value= "zrhUNkAciZSEl6mS4BbhV3qkYUBB9RYJQCdg1kU0ELU="/><input type="submit" name="pagar" value="Pagar" /></form>

Exemplo de formulário de pagamento parcelado (Valores e datas de parcelas fixas):

<form method="POST" action="https://secure.payzen.com.br/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="3000" /><input type="hidden" name="vads_capture_delay" value="0" /><input type="hidden" name="vads_ctx_mode" value="TEST" /><input type="hidden" name="vads_currency" value="986" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value=" MULTI_EXT:20140201=1000;20140301=1000;20140401=1000" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20140129130025" /><input type="hidden" name="vads_trans_id" value="130025" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="7Sds6Z+R1Q1axRsblpChyQh5OU3oCle5FOirD4V/Bzk="/><input type="submit" name="pagar" value="Pagar"/></form>





7.4. Criar uma autorização sem captura

Este modo de pagamento permite garantir a validade dos dados do cartão do comprador sem fazer débito.

Se for preciso, o vendedor poderá aplicar um débito neste cartão do valor desejado usando a funçãoDuplicar pelo Back Office. Para isso:

• o modo de validação manual é usado,

• o vendedor não deve validar manualmente as transações.








n14Ex: 20170701130025


n..12Ex: 100 pour 1 BRL


n3



enumINTERACTIVE



enumV2



vads_validation_mode Modo de validação n1 1 (Manual)

Tabela 7 : Lista dos campos - Autorização sem captura

2. Preencher o campo vads_amount com um valor baixo. Não vai prejudicar o limite do cartão.

3. Preencher o campo vads_validation_mode a 1.






Exemplo de formulário para uma autorização sem captura:

<form method="POST" action="https://secure.payzen.com.br/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="100" /><input type="hidden" name="vads_capture_delay" value="0" /><input type="hidden" name="vads_ctx_mode" value="TEST" /><input type="hidden" name="vads_currency" value="986" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_validation_mode" value="1"/><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20141008073753" /><input type="hidden" name="vads_trans_id" value="346738" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value= "DvltInRYXRroOZ/KnNdJSlpVr++29ZGty4nj1Y7yczU="/><input type="submit" name="pagar" value="Pagar" /></form>




8. USAR FUNÇÕES COMPLEMENTARES

Para ter um formulário personalizado e adaptado as suas necessidades, você pode usar funçõescomplementares dentre da lista abaixo:

• Configurar a modo de captura no banco (modo de validação)

• Enviar informações sobre o comprador (estado civil, endereço e-mail..)

• Enviar informações sobre a entrega (endereço...)

• Enviar informações sobre o pedido (referência, conteúdo do carrinho...)

• Ativar ou desativar 3D Secure

• Definir o contrato comercial que será usado para o pagamento

• Sobrescrever a url de notificação instantânea (também chamada IPN)

• Gerenciar as URL de retorno para o site de e-commerce

• Ativar o retorno automático para o site de e-commerce no final do pagamento

• Efetuar um pagamento sem redirecionar o comprador para a página de pagamento

Estas funcionalidades são apresentadas nos capítulos seguintes. Estes capítulos vão ajudar a montar semdificuldades seu formulário de pagamento.



8.1. Definir o modo de captura no banco (automático / manual)

O vendedor pode configurar pelo Back Office como serão enviados os pagamentos para o banco (MenuConfigurações > Loja > aba Configuração):

Figura 15 : Definir o modo de captura no banco

• Automático: Nenhuma ação necessária, os pagamentos são capturados no banco quando o prazo decaptura vence.

• Manual : o vendedor deve obrigatoriamente validar cada pagamento no Back Office para que sejacapturado no banco, e isso, antes da data de vencimento da solicitação de autorização.

Toda transação que não foi validada no devido prazo é considerada como vencida e nunca serácapturada no banco.

Por padrão, o Back Office esta configurado para que todos os pagamentos sejam capturadosautomaticamente no banco.

O vendedor pode sobrescrever esta configuração no seu formulário de pagamento.

Deverá implementar os critérios da sua escolha (status do estoque, prazo de reabastecimento, etc.)para poder decidir se a transação deve ser capturada automaticamente no banco ou não.

1. Preencher a totalidade dos campos necessários ao seu caso de uso (ver capítulo Gerar um formuláriode pagamento) para montar seu formulário de pagamento.

2. Preencher o campo vads_validation_mode para configurar o modo de captura no banco datransação (manual ou automático).

Este campo será reenviado na resposta com o valor enviado no formulário.

Valor Descrição

Ausente ou vazio Toma o valor definido no Back Office.

0 Captura automática no banco.

1 Captura manual no banco.

Tabela 8 : Valores associados a vads_validation_mode




Exemplo de formulário de pagamento com definição do modo de captura no banco em modo SILENT:

<form method="POST" action="https://secure.payzen.com.br/vads-payment/"><input type="hidden" name="vads_action_mode" value="SILENT" /><input type="hidden" name="vads_amount" value="4000" /><input type="hidden" name="vads_capture_delay" value="0" /><input type="hidden" name="vads_card_number" value="4970100000000000" /><input type="hidden" name="vads_ctx_mode" value="TEST" /><input type="hidden" name="vads_currency" value="986" /><input type="hidden" name="vads_cvv" value="123" /><input type="hidden" name="vads_expiry_month" value="5" /><input type="hidden" name="vads_expiry_year" value="2017" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value="SINGLE" /><input type="hidden" name="vads_payment_cards" value="VISA" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20140326164147" /><input type="hidden" name="vads_trans_id" value="164147" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="vads_validation_mode" value="1" /><input type="hidden" name="signature" value="8oUTs2G8kjWnTmuccMobDyAISCSdM4WbxQTp9kchHwM= /><input type="submit" name="pagar" value="Pagar"/></form>

Exemplo de formulário de pagamento com definição do modo de captura no banco em modo INTERACTIVE:

<form method="POST" action="https://secure.payzen.com.br/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="4000" /><input type="hidden" name="vads_capture_delay" value="0" /><input type="hidden" name="vads_ctx_mode" value="TEST" /><input type="hidden" name="vads_currency" value="986" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value="SINGLE" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20140326164147" /><input type="hidden" name="vads_trans_id" value="164147" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="vads_validation_mode" value="1" /><input type="hidden" name="signature" value="cJFhNTLXQ4o6BgbW1pMMoM2yMilw90OIqmFjJ6DeUmA= /><input type="submit" name="pagar" value="Pagar"/></form>

Observação:

Os campos requeridos variam em função do modo de aquisição das informações do meio de pagamento(SILENT ou INTERACTIVE).

Quando o campo vads_action_mode tiver o valor SILENT, as informações do meio de pagamento passama ser obrigatórias.





8.2. Enviar os dados do comprador

O vendedor pode enviar informações sobre o comprador (endereço, e-mail, estado civil, número detelefone etc.). Estes dados constituirão as informações para o faturamento.

Todos os dados que serão transmitidos via o formulário de pagamento serão exibidos no Back Officequando consultar o detalhe da transação (aba Comprador).


2. Preencher os campos facultativos abaixo segundo suas necessidades. Estes campos serão reenviadosna resposta com o valor enviado no formulário.


vads_cust_email Endereço e-mail do comprador ans..150 Ex: [email protected]

vads_cust_id Referência do comprador no sitede e-commerce

an..63Ex: C2383333540

vads_cust_title Estado civil do comprador an..63 Ex: Senhor

vads_cust_status Statusenum

PRIVATE: para uma pessoa físicaCOMPANY para uma pessoa jurídica

vads_cust_first_name Nome anos..63 Ex: Thiago

vads_cust_last_name Sobrenome anos..63 Do vale

vads_cust_legal_name Razão social do comprador an..100 Ex: D. & Cie

vads_cust_cell_phone Número de telefone celular an..32 Ex: 9 1234-5678

vads_cust_address_number Número de rua ans..64 Ex: 1560

vads_cust_address Caixa postal ans..255 Ex: Av. Queiroz Filho

vads_cust_address2 Segunda linha do endereço ans..255 Ex: Torre Beija Flor – 4° andar

vads_cust_district Bairro ans..127 Ex: Vila Leopoldina

vads_cust_zip CEP an..64 Ex: 05319-000

vads_cust_city Cidade an..128 Ex: São Paulo

vads_cust_state UF / Região ans..127 Ex: Vila Leopoldina

vads_cust_country Código país seguindo a normaISO 3166 alpha-2

a2Ex: BR para o Brasil, US para osEstados-Unidos.




8.3. Enviar os dados de entrega

O vendedor pode enviar os dados de entrega do comprador (endereço, e-mail, número de telefone etc.).

Estes dados serão exibidos no Back Office quando consultar o detalhe da transação (aba Entrega).


2. Preencher os campos facultativos abaixo segundo suas necessidades.

Estes campos serão reenviados na resposta com o valor enviado no formulário.


vads_ship_to_city Cidade an..128 Ex: Salvador

vads_ship_to_country Código país segundo a normaISO 3166

a2Ex: BR

vads_ship_to_district Bairro ans..127 Ex: Barra

vads_ship_to_first_name Nome anos..63 Ex: Jao

vads_ship_to_last_name Sobrenome anos..63 Ex: Do Vale

vads_ship_to_legal_name Razão social an..100 Ex: D. & Cie

vads_ship_to_phone_num Número de telefone ans..32 Ex: 11 6526-9200

vads_ship_to_state UF / Região ans..127 Ex: Bahia

vads_ship_to_status Define o tipo de endereço deentrega.

enum

PRIVATE: para uma entrega parauma pessoa físicaCOMPANY para uma entrega parauma pessoa jurídica

vads_ship_to_street_number Número de rua ans..64 Ex: 2

vads_ship_to_street Caixa postal ans..255 Ex: Rua Alfonso Camargo

vads_ship_to_street2 Segunda linha do endereço ans..255

vads_ship_to_zip CEP an..64 Ex: 40020-010

Tabela 9 : Lista dos campos - Detalhes de entrega

3. Calcule o valor do campo signature usando a totalidade dos campos do seu formulário, com o nomecomeçando por vads_ (ver capítulo Calcular a assinatura).



Exemplo de formulário de pagamento com informações sobre a entrega

<form method="POST" action="https://secure.payzen.com.br/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="4000" /><input type="hidden" name="vads_capture_delay" value="0" /><input type="hidden" name="vads_ctx_mode" value="PRODUCTION" /><input type="hidden" name="vads_currency" value="986" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value="SINGLE" /><input type="hidden" name="vads_ship_to_city" value="cidade de entrega" /><input type="hidden" name="vads_ship_to_country" value="BR" /><input type="hidden" name="vads_ship_to_name" value="o nome do local de entrega" /><input type="hidden" name="vads_ship_to_street" value="a rua para realizar a entrega" /><input type="hidden" name="vads_ship_to_street_number" value="10" /><input type="hidden" name="vads_ship_to_zip" value="31670" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20140327143509" /><input type="hidden" name="vads_trans_id" value="561095" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="bOIxHAgm4vYUq3oIDCdEPKOWgrB9bHzkfDBEAr1i10A="/><input type="submit" name="pagar" value="Pagar"/></form>




8.4. Enviar os dados do pedido

O vendedor pode mencionar no seu formulário de pagamento se ele deseja enviar as informações dopedido (número de pedido, descrição, conteúdo do carrinho etc.).

Estes dados serão exibidos no Back Office quando consultar o detalhe da transação (aba Carrinho).


2. Preencher os campos facultativos abaixo segundo suas necessidades. Estes campos serão reenviadosna resposta com o valor enviado no formulário.


vads_order_id Número de pedido ans..64 Ex: 2-XQ001

vads_order_info Informações adicionais sobre opedido

an..255

vads_order_info2 Informações adicionais sobre opedido

an..255

vads_order_info3 Informações adicionais sobre opedido

an..255

vads_nb_products Quantidade de artigos presentesno carrinho

n..12Ex: 2

vads_product_labelN Denominação do artigo. Ncorresponde ao índice do artigo(0 para o primeiro, 1 para osegundo...) an..255

Ex:vads_product_label0 = "tee-shirt"

vads_product_label1 = "Biscuit"

vads_product_label2 = "sandwich"

vads_product_amountN Valor do artigo. N correspondeao índice do artigo (0 para oprimeiro, 1 para o segundo...) n..12

Ex:vads_product_amount0 = "1200"

vads_product_amount1 = "800"

vads_product_amount2 = "950"

vads_product_typeN Tipo do artigo. N correspondeao índice do artigo (0 para oprimeiro, 1 para o segundo...)

enum

Ex:vads_product_type0 = "CLOTHING_AND_ACCESSORIES"

vads_product_type1 = "FOOD_AND_GROCERY"

vads_product_type2 = "FOOD_AND_GROCERY"

vads_product_refN Referência do artigo. Ncorresponde ao índice do artigo(0 para o primeiro, 1 para osegundo...) an..64

Ex:vads_product_ref0 = "CAA-25-006"

vads_product_ref1 = "FAG-B5-112"

vads_product_ref2 = "FAG-S9-650"

vads_product_qtyN Quantidade de artigo. Ncorresponde ao índice do artigo(0 para o primeiro, 1 para osegundo...)

n..12

Ex:vads_product_qty0 = "1"

vads_product_qty1 = "2"

vads_product_qty2 = "2"

Tabela 10 : Lista dos campos - Detalhes do pedido

3. Preencher o campo vads_nb_products com a quantidade de artigos contidos no carrinho.

Observação:

Este campo é obrigatório para que o carrinho seja levado em conta.

Quando preencher este campo, a aba Carrinho será exibida nos detalhes de transação do Back Office.



No entanto, se os outros campos começando por vads_product_ não forem preenchidos, a aba nãoconterá informação. Por esta razão, ao preencher vads_nb_products, valorizar os outros camposcomeçando por vads_product_ passa a ser obrigatório.

4. Preencher o campo vads_product_amountN com o valor dos diferentes artigos contidos no carrinhona menor unidade da moeda.

N corresponde ao índice do artigo (0 para o primeiro, 1 para o segundo...).

5. Preencher o campo vads_product_typeN com o valor correspondente ao tipo do artigo.


Valor Descrição

FOOD_AND_GROCERY Produtos alimentares e de mercadinho

AUTOMOTIVE Automóvel / Moto

ENTERTAINMENT Lazer / Cultura

HOME_AND_GARDEN Casa e jardim

HOME_APPLIANCE Equipamentos para a casa

AUCTION_AND_GROUP_BUYING Leilões e compras em grupo

FLOWERS_AND_GIFTS Flores e presentes

COMPUTER_AND_SOFTWARE Computadores e softwares

HEALTH_AND_BEAUTY Saúde e beleza

SERVICE_FOR_INDIVIDUAL Serviços para pessoa física

SERVICE_FOR_BUSINESS Serviços para pessoa jurídica

SPORTS Esportes

CLOTHING_AND_ACCESSORIES Roupas e acessórios

TRAVEL Viagem

HOME_AUDIO_PHOTO_VIDEO Som, imagem e vídeo

TELEPHONY Telefonia

Tabela 11 : Valores associados a vads_product-type0

6. Preencher o campo vads_product_labelN com a denominação dos artigos contidos no carrinho.


7. Preencher o campo vads_product_qtyN com a quantidade de cada um dos artigos contidos nocarrinho.


8. Preencher o campo vads_product_refN com a referência de cada um dos artigos contidos nocarrinho.


9. Verificar o valor do campo vads_amount. Deve corresponder ao valor total do pedido.

10.Calcule o valor do campo signature usando a totalidade dos campos do seu formulário, com o nomecomeçando por vads_ (ver capítulo Calcular a assinatura).



Exemplo de formulário de pagamento com descrição do carrinho:

<form method="POST" action="https://secure.payzen.com.br/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="11000" /><input type="hidden" name="vads_capture_delay" value="0" /><input type="hidden" name="vads_ctx_mode" value="PRODUCTION" /> <input type="hidden" name="vads_currency" value="986" /><input type="hidden" name="vads_nb_products" value="2"/><input type="hidden" name="vads_product_amount0" value="5000" /><input type="hidden" name="vads_product_label0" value="produit1" /><input type="hidden" name="vads_product_qty0" value="2" /><input type="hidden" name="vads_product_ref0" value="ref1" /><input type="hidden" name="vads_product_amount1" value="1000" /><input type="hidden" name="vads_product_label1" value="produit2" /><input type="hidden" name="vads_product_qty1" value="1" /><input type="hidden" name="vads_product_ref1" value="ref2" /><input type="hidden" name="vads_order_id" value="CD100000857" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value="SINGLE" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20140327145218" /><input type="hidden" name="vads_trans_id" value="571381" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="xYw1UnU3BACGhf3UEyqbQzpwuvZDEkCAWAE5fgbtfxI="/><input type="submit" name="pagar" value="Pagar"/></form>




8.5. Ativar / Desativar 3D Secure

Para esta funcionalidade precisa ativar a opção 3D Secure seletivo.

O vendedor pode indicar no formulário de pagamento dele se ele deseja ativar ou desativar afuncionalidade 3D Secure.

O vendedor deverá implementar os critérios da sua escolha (valor, país, região de entrega etc.) para poderdecidir se a transação deve ser submetida ou não ao 3DS.

Para os cartões de débito (Visa, Electron, Maestro e Cielo Elo) o 3D Secure é obrigatório. Se a opção 3DSecure seletivo não foi ativada durante a criação do seu contrato, o 3DS funcionará mesmo assim paraestes cartões de débito.

Para os cartões de débito, o 3D Secure é facultativo.


2. Preencher o campo vads_threeds_mpi para ativar ou desativar 3D Secure.

Valor Descrição

ausenteou vazio

Autenticação 3DS gerada pela plataforma de pagamento (configuração do vendedor).

0 Autenticação 3DS gerada pela plataforma de pagamento (configuração do vendedor).

1 Autenticação 3DS integralmente gerada pelo vendedor somente se vads_card_number foi preenchido(digitação dos dados cartões no site do vendedor).Os dados que resultam da autenticação 3D Secure efetuada pelo MPI do vendedor devem agora serenviados para os campos do formulário previstos para isso (vads_threeds_enrolled, vads_threeds_cavv,vads_threeds_eci, vads_threeds_xid, vads_threeds_ cavvAlgorithm, vads_threeds_status).

2 Autenticação 3DS desativada para a transação, seja qual for a configuração padrão do vendedor.


Exemplo de ativação do 3DS em função do valor:

if (vads_amount < 300,00 BRL){ then vads_threeds_mpi = 2 // 3DS disabled else vads_threeds_mpi = 0 // 3DS enabled}

Exemplo de ativação do 3DS em função da região:

if (vads_cust_zip = 92 ) or (vads_cust_zip = 93 ){ then vads_threeds_mpi = 0 // 3DS enabled else vads_threeds_mpi = 2 // 3DS disabled}

Exemplo de formulário de pagamento com o 3DS desativado:

<form method="POST" action="https://secure.payzen.com.br/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="4000" /><input type="hidden" name="vads_capture_delay" value="0" /><input type="hidden" name="vads_ctx_mode" value="TEST" /><input type="hidden" name="vads_currency" value="986" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value="SINGLE" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_threeds_mpi" value="2" /><input type="hidden" name="vads_trans_date" value="20140327145218" /><input type="hidden" name="vads_trans_id" value="571381" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="1Ivhuhh20ETt78SxJDuymDbu+6ZynaJ71JvcJMDeVKM="/><input type="submit" name="pagar" value="Pagar"/></form>




8.6. Definir o contrato comercial

O vendedor pode especificar no formulário de pagamento dele o valor do contrato comercial que seráusado.

Esta funcionalidade será útil somente se você possuir vários contratos numa mesma rede de aceitação.


2. Preencher o campo facultativo vads_contracts para definir o contrato comercial usado.

Exemplo:

Valor Descrição

Ausente ou vazio Uso do contrato definido por ordem de prioridade no BackOffice (Menu Configuração > Loja > aba Contratos).

VISA=1231231 Comprador VISA

MASTERCARD=2323123 Comprador MASTERCARD

AMEXGLOBAL=949400444000 Rede American Express

Para definir uma lista de contratos, separe os valores por um ponto e virgula ";".

Para excluir uma rede, é preciso adicionar nome da rede=NO


Exemplo:

Você tem a disposição:

• dois contratos VISA : 1231230 e 1231231

• dois contratos AMEXGLOBAL : 949400444000 e 949400444001

Para escolher o contrato que será usado para estas duas redes, vads_contracts deverá ser informado damaneira seguinte: vads_contracts= VISA=1231231; AMEXGLOBAL=949400444000

Para propor um pagamento somente para o contrato 1231231 e não para um dos contratos AMEXGLOBAL,os valores de vads_contracts serão:

vads_contracts= VISA=1231231; AMEXGLOBAL=NO

Exemplo de formulário de pagamento definindo o contrato comercial usado:

<form method="POST" action="https://secure.payzen.com.br/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="4000" /><input type="hidden" name="vads_capture_delay" value="0" /><input type="hidden" name="vads_ctx_mode" value="TEST" /><input type="hidden" name="vads_contracts" value="VISA=1231231;AMEXGLOBAL=949400444000" /><input type="hidden" name="vads_currency" value="986" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value="SINGLE" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20140327145218" /><input type="hidden" name="vads_trans_id" value="571381" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="7mjGsUAcl4Ox6p5WZ8RNN7ROsxlJ0py3SMtSzdfbHEM="/><input type="submit" name="pagar" value="Pagar"/></form>




8.7. Gerenciar o retorno para o site de e-commerce

No final do pagamento, o comprador tem a possibilidade de voltar para o site de e-commerce em umapágina chamada URL de retorno.

Não confundir com a URL de notificação instantânea (também chamada IPN) (ver capítulo Gerenciar odialogo para o site de e-commerce).

Definir as URL de retorno

No formulário de pagamento, o vendedor pode sobrescrever a configuração do Back Office. Para isso elepode:

• Usar 4 URL diferentes em função do resultado do pagamento:

• Pagamento aceito

• Pagamento recusado

• Desistiu do pagamento

• Pagamento em falha

• Usar somente uma URL seja qual for o resultado do pagamento.

Definir as URL de retorno em função do resultado do pagamento:


2. Preencher os campos facultativos apresentados abaixo para elaborar o formulário de pagamentoadaptado as suas necessidades.

Se nenhuma URL for informada no formulário, o valor configurado no Back Office será selecionado.


vads_url_cancel URL para qual seráredirecionado o compradordepois de clicar em "cancelar evoltar para a loja" antes de terefetuado o pagamento

ans..1024

Ex: http://demo.com/cancel.php

vads_url_error URL para qual seráredirecionado o comprador emcaso de erro de tratamento pelaplataforma de pagamento.

ans..1024

Ex: http://demo.com/error.php

vads_url_refused URL para qual seráredirecionado o comprador, se opagamento for recusado, depoisde clicar em "voltar para a loja"

ans..1024

Ex: http://demo.com/refused.php

vads_url_success URL para qual seráredirecionado o comprador, se opagamento for aceito, depois declicar em "voltar para a loja"

ans..1024

Ex: http://demo.com/success.php

3. Calcular o valor do campo signature usando a totalidade dos campos do seu formulário, com o nomecomeçando porvads_ (ver capítulo Calcular a assinatura).



Exemplo de formulário de pagamento com definição de URL de retorno em função do resultado dopagamento:

<form method="POST" action="https://secure.payzen.com.br/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="3000" /><input type="hidden" name="vads_capture_delay" value="0" /><input type="hidden" name="vads_ctx_mode" value="PRODUCTION" /><input type="hidden" name="vads_currency" value="986" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value="SINGLE" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20140526101407" /><input type="hidden" name="vads_trans_id" value="239848" /><input type="hidden" name="vads_url_cancel" value="http://demo.com/cancel.php" /><input type="hidden" name="vads_url_error" value="http://demo.com/error.php" /><input type="hidden" name="vads_url_refused" value="http://demo.com/refused.php" /><input type="hidden" name="vads_url_success" value="http://demo.com/success.php" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="lZIHzigiwCc6+uLStp8I5DQnbSqXu63Jtfo6Saeq3Mc="/><input type="submit" name="pagar" value="Pagar"/></form>

Definir uma URL de retorno única seja qual for o resultado do pagamento

1. Preencher a totalidade dos campos necessários a seu caso de uso (ver capítulo Gerar um formuláriode pagamento) para montar seu formulário de pagamento.

2. Usar o campo facultativo vads_url_return para definir a URL de redirecionamento no final dopagamento.

Se nenhuma URL for informada no formulário, o valor configurado no Back Office será selecionado.


Exemplo de formulário de pagamento com uma URL de retorno única seja qual for o resultado dopagamento:

<form method="POST" action="https://secure.payzen.com.br/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="3000" /><input type="hidden" name="vads_capture_delay" value="0" /><input type="hidden" name="vads_ctx_mode" value="PRODUCTION" /><input type="hidden" name="vads_currency" value="986" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value="SINGLE" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20140526101407" /><input type="hidden" name="vads_trans_id" value="239848" /><input type="hidden" name="vads_url_return" value="http://demo.com/return.php" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="ZI/GhI0GbeqqoXGeoZuPOy55SKQSYzRO1i6r5ku6vOs="/><input type="submit" name="pagar" value="Pagar"/></form>





Definir o método de recepção dos dados

Por padrão, o site de e-commerce não recebe nenhum parâmetro.

Para recuperar informações na página de retorno (tracking, estatísticas, personalização das mensagenspara o comprador, etc.), o vendedor pode sobrescrever esta configuração no seu formulário depagamento.


2. Preencher o campo facultativo vads_return_mode para indicar o método de envio dos dados para osite de e-commerce.

Valor Descrição

Ausente, vazio ou NONE Nenhum dado é transmitido à URL de retorno.

GET Os dados são transmitidos na URL da página de retorno

POST Os dados são enviados para a página de retorno sob a forma de um formulário HTTP POST.

O método GET permite evitar a exibição de uma mensagem de alerta quando o retorno é feito numambiente não seguro (http).


Exemplo de formulário de pagamento com definição do modo de envio dos dados:

<form method="POST" action="https://secure.payzen.com.br/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="3000" /><input type="hidden" name="vads_capture_delay" value="0" /><input type="hidden" name="vads_ctx_mode" value="PRODUCTION" /><input type="hidden" name="vads_currency" value="986" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value="SINGLE" /><input type="hidden" name="vads_return_mode" value="GET" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20140526101407" /><input type="hidden" name="vads_trans_id" value="239848" /><input type="hidden" name="vads_url_return" value="http://demo.com/return.php" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="oTCT+7Oc+xttdGmcp9qa6/0pSSfNxoMtl8U1J1l+LtE="/><input type="submit" name="pagar" value="Pagar"/></form>




8.8. Ativar o retorno automático para o site de e-commerce

O vendedor pode mencionar no seu formulário se ele deseja redirecionar automaticamente o compradorpara o site de e-commerce no final do pagamento.

Se você usar um código de tracking (Google Analytics ou outro) no seu site, você deve implementar estafuncionalidade.


2. Preencher os campos facultativos abaixo segundo suas necessidades.

Nome do campo Descrição

vads_redirect_success_timeout Estabelece o prazo de espera antes do redirecionamento depois de umpagamento aceito.Este prazo é apresentado em segundo e deve ser entre 0 e 300 segundos.

vads_redirect_success_message Estabelece a mensagem de espera antes do redirecionamento depois de umpagamento aceito.

vads_redirect_error_timeout Estabelece o prazo de espera antes do redirecionamento depois de umpagamento recusado.Este prazo é apresentado em segundo e deve ser entre 0 e 300 segundos.

vads_redirect_error_message Estabelece a mensagem de espera antes do redirecionamento depois de umpagamento recusado.

Tabela 12 : Lista dos campos facultativos disponíveis.

Observação

Se você escolher um timeout de zero, seu redirecionamento acontecerá da forma seguinte:

• Para um pagamento aceito, o comprador será redirecionado em vads_url_success.

• Para um pagamento cancelado, o comprador será redirecionado em vads_url_cancel se oparâmetro for definido.

• Se o parâmetro não for definido, o comprador será redirecionado na URL de retorno informadano campo vads_url_return ou na URL de retorno informada no Back Office.

• Se a URL de retorno não for definida, ele será redirecionado na URL da loja.

• Para um pagamento recusado, o comprador será redirecionado em vads_url_refused se oparâmetro for definido.

• Se o parâmetro não for definido, o comprador será redirecionado na URL de retorno informadano campo vads_url_return ou na URL de retorno informada no Back Office.

• Se a URL de retorno não for definida, ele será redirecionado na URL da loja.

3. Preencher o campo vads_return_mode aGET.

4. Calcular o valor do campo signature usando a totalidade dos campos do seu formulário, com o nomecomeçando porvads_ (ver capítulo Calcular a assinatura ).



Exemplo de formulário de pagamento:

<form method="POST" action="https://secure.payzen.com.br/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="3000" /><input type="hidden" name="vads_capture_delay" value="0" /><input type="hidden" name="vads_ctx_mode" value="PRODUCTION" /><input type="hidden" name="vads_currency" value="986" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value="SINGLE" /><input type="hidden" name="vads_redirect_error_message" value="Você será redirecionado para seu site de e-commerce" /><input type="hidden" name="vads_redirect_error_timeout" value="0" /><input type="hidden" name="vads_redirect_success_message" value="Você será redirecionado para seu site de e-commerce" /><input type="hidden" name="vads_redirect_success_timeout" value="0" /><input type="hidden" name="vads_return_mode" value="GET" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20140526101407" /><input type="hidden" name="vads_trans_id" value="239848" /><input type="hidden" name="vads_url_return" value="http://demo.com/return.php" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="AzTJmizS5N0muYzu63nVvCUWo0ixnMJfpqQmuEa4CSY="/><input type="submit" name="pagar" value="Pagar"/></form>




8.9. Sobrescrever a URL de notificação instantânea (IPN)

Você pode sobrescrever a url de notificação instantânea (também chamada IPN) no formulário se você usaruma só loja para diferentes canais de venda, diferentes tipologias de pagamento, diferentes idiomas etc...

Esta funcionalidade não é compatível com a execução, pelo Back Office, da solicitação enviada à url denotificação instantânea. A URL chamada será a mesma que foi configurada na regra de notificação (vercapítulo Configurar as notificações).


2. Preencher o campo vads_url_check para sobrescrever a URL da página que será notificada.

Se o valor do campo vads_url_check estiver errado, o formulário será recusado.


Exemplo de formulário de pagamento que sobrescreve a URL de notificação instantânea:

<form method="POST" action="https://secure.payzen.com.br/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="3000" /><input type="hidden" name="vads_capture_delay" value="0" /><input type="hidden" name="vads_ctx_mode" value="PRODUCTION" /><input type="hidden" name="vads_currency" value="986" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value="SINGLE" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20140526101407" /><input type="hidden" name="vads_trans_id" value="239848" /><input type="hidden" name="vads_url_check" value="http://www.myshop.com/check" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="yXvSZnYvcMRORVGiapWaHT0euKDI0OGlrddYKc4XDZc="/><input type="submit" name="pagar" value="Pagar"/></form>




8.10. Criar um pagamento sem redirecionar para a página de pagamento

Para esta funcionalidade precisa ativar a opção Aquisição dos dados bancários

Neste modo, a aquisição dos dados bancários vai ocorrer no site do vendedor.

Esta funcionalidade:

• esta disponível se o seu banco autoriza digitar informações bancários no site de e-commerce.

• requer no mínimo o uso de um certificado SSL no site de e-commerce.

1. Informar os campos presentes abaixo para montar seu formulário de pagamento.







n14Ex: 20170701130025


n..12Ex: 3000 para 30,00 BRL


n3



enumSILENT



enumV2



vads_payment_cards Tipo de cartão Ex: VISA

vads_card_number Número de cartão usado para opagamento.

n..36Ex: 4970100000000000

vads_cvv Criptograma visual n..4 Ex: 123

vads_expiry_month Mês de vencimento do cartão n..2 Ex: 2

vads_expiry_year Ano de vencimento n4 Ex: 2023

Tabela 13 : Lista dos campos - Pagamento sem redirecionar para a página de pagamento

2. Preencher os campos vads_payment_config e vads_capture_delay em função das suas necessidades.

3. Preencher o campo vads_action_mode a SILENT.


5. Preencher os campos vads_card_number, vads_expiry_month, vads_expiry_year, vads_cvv com asinformações de cartão digitadas pelo comprador.



6. Preencher o campo vads_payment_cards em função da escolha do comprador:



Exemplo de formulário de pagamento sem redirecionar para a página de pagamento:

<form method="POST" action="https://secure.payzen.com.br/vads-payment/"><input type="hidden" name="vads_action_mode" value="SILENT" /><input type="hidden" name="vads_amount" value="3000" /><input type="hidden" name="vads_capture_delay" value="0" /><input type="hidden" name="vads_card_number" value="4970100000000000" /><input type="hidden" name="vads_ctx_mode" value="TEST" /><input type="hidden" name="vads_currency" value="986" /><input type="hidden" name="vads_cvv" value="123" /><input type="hidden" name="vads_expiry_month" value="5" /><input type="hidden" name="vads_expiry_year" value="2017" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_cards" value="VISA" /><input type="hidden" name="vads_payment_config" value="SINGLE" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20140326164147" /><input type="hidden" name="vads_trans_id" value="164147" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="EKrcj4e8N38LGCP/xkJMaHUajUfvsRG50mDwYLNBsMU=" /><input type="submit" name="pagar" value="Pagar"/></form>




9. PERSONALIZAR AS PÁGINAS DE PAGAMENTO

Você pode personalizar alguns elementos da página de pagamento:

• os meios de pagamento propostos na hora do pagamento,

• o idioma usado nas páginas de pagamento exibidas,

• os idiomas propostos ao comprador nas páginas de pagamento,

• o nome e a url da loja,

• a denominação dos botões.

Graças à opção de personalização avançada, você pode também:

• criar diferentes modelos de personalização da página de pagamento para que ela seja parecida comseu site de e-commerce.

• criar diferentes modelos de personalização dos e-mail que serão enviados ao comprador.

• Personalizar certas denominações exibidas nas páginas de pagamento.

Isto passará confiança para o comprador e tranqüilidade na hora de efetuar o pagamento.

Consulte o Manual do usuário do Back Office - Personalização avançada para maiores detalhes ou entreem contato com o suporte técnico.

9.1. Sobrescrever o modelo de personalização

O Back Office PayZenpermite:

• criar diversos modelos de personalização das páginas de pagamento,

• definir o modelo que será aplicado por padrão a todas suas transações.

O formulário de pagamento permite sobrescrever de maneira dinâmica o modelo que será aplicado graçasao campo vads_theme_config.

Para isso, você deve usar a palavra-chave: RESPONSIVE_MODEL e indicar o nome do modelo que será aplicado(Model_1, Model_2, ...).

Exemplo de uso:

<input type="hidden" name="vads_theme_config" value="RESPONSIVE_MODEL=Model_1" />

Consulte o Manual do usuário do Back Office - Personalização avançada para maiores detalhes sobre acriação dos modelos.

Consulte o capítulo vads_theme_config para maiores detalhes sobre o uso deste campo.



9.2. Gerenciar os meios de pagamento propostos ao comprador

E possível personalizar os meios de pagamento que você deseja propor ao comprador.


2. Preencher o campo vads_payment_cards.

• com um valor só se você não desejar exibir a página de seleção dos meios de pagamento.

• com uma lista de valores separados por um ";" para exibir a página de seleção dos meios depagamento.

3. Calcular o valor do campo signature usando a totalidade dos campos do seu formulário, com o nomecomeçando por vads_ (ver capítulo Calcular a assinatura ).

Exemplo de formulário de pagamento com lista de escolha de meios de pagamento:

<form method="POST" action="https://secure.payzen.com.br/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="30000" /><input type="hidden" name="vads_capture_delay" value="0" /><input type="hidden" name="vads_ctx_mode" value="PRODUCTION" /> <input type="hidden" name="vads_currency" value="986" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_cards" value="VISA;MASTERCARD" /><input type="hidden" name="vads_payment_config" value="SINGLE" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20140526101407" /><input type="hidden" name="vads_trans_id" value="239848" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="qqpxF6z1+Ri5jtkHNVDCCJulxxpJYehrfP1OLwJ4Ysg="/><input type="submit" name="pagar" value="Pagar"/></form>




9.3. Mudar o idioma

Você pode personalizar o idioma usado nas páginas de pagamento.


2. Preencher o campo vads_language com um dos valores presentes no quadro abaixo :

Idioma Codificação ISO 639-1

Alemão de

Inglês en

Chinês zh

Espanhol es

Francês fr

Italiano it

Japonês ja

Holandês nl

Polonês pl

Português pt

Russo ru

Sueco sv

Turco tr

• Se o valor do campo vads_language estiver errado, o formulário será recusado.

• Se o campo não for enviado ou se ele permanecer vazio, a página de pagamento será exibida noidioma do navegador do comprador.

• O comprador poderá a qualquer momento mudar de idioma clicando nas bandeiras presentes embaixo da página de pagamento.

3. Calcular o valor do campo signature usando a totalidade dos campos do seu formulário, com o nomecomeçando por vads_(ver capítulo Calcular a assinatura).

Exemplo de formulário de pagamento com definição do idioma:

<form method="POST" action="https://secure.payzen.com.br/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="3000" /><input type="hidden" name="vads_capture_delay" value="0" /><input type="hidden" name="vads_ctx_mode" value="PRODUCTION" /><input type="hidden" name="vads_currency" value="986" /><input type="hidden" name="vads_language" value="pt" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value="SINGLE" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20140526101407" /><input type="hidden" name="vads_trans_id" value="239848" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="PAMdHJ8FJc2CqUJLXQLxz+e77K4k1YGJmI5mHqGN74g="/><input type="submit" name="pagar" value="Pagar"/></form>




9.4. Modificar os idiomas propostos ao comprador

Você pode personalizar os idiomas propostos ao comprador.

O último idioma selecionado pelo comprador será o idioma padrão do e-mail de confirmação depagamento enviado para o comprador.


2. Preencher o campo vads_available_languages usando o quadro abaixo:

• com um valor só se você não desejar que o comprador mude de idioma.

• com uma lista de valores separados por um « ; » para listar os idiomas disponíveis.

Idioma Valor Bandeira exibida por padrão

Alemão de x

Inglês en x

Chinês zh x

Espanhol es x

Francês fr x

Italiano it x

Japonês ja x

Holandês nl x

Polonês pl

Português pt x

Russo ru x

Sueco sv x

Turco tr x

Se o valor do campo vads_available_languages estiver errado, o formulário será recusado.

3. Calcular o valor do campo signature usando a totalidade dos campos do seu formulário, com o nomecomeçando por vads_(ver capítulo Calcular a assinatura).

Exemplo de formulário de pagamento com lista de escolha de idiomas:

<form method="POST" action="https://secure.payzen.com.br/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="3000" /><input type="hidden" name="vads_available_languages" value="fr;en;es" /><input type="hidden" name="vads_capture_delay" value="0" /><input type="hidden" name="vads_ctx_mode" value="PRODUCTION" /><input type="hidden" name="vads_currency" value="986" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value="SINGLE" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20140526101407" /><input type="hidden" name="vads_trans_id" value="239848" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="aEWutqzuHH6Q8ns3a6cj5XitZCuhYsDcsKjlLpL8flA="/><input type="submit" name="pagar" value="Pagar"/></form>




9.5. Mudar o nome e a URL da loja

Se você possuir dois nomes de domínios, você pode mudar o nome e a URL da loja para exibir o nomedo domínio.


2. Usar o campo vads_shop_name para exibir o nome da loja presente no resumo no final dopagamento, o ticket e os e-mails de confirmação.

3. Preencher o campo vads_shop_url para mudar a URL da loja exibida nas páginas de pagamento.

Este valor será mencionado no e-mail de confirmação.

Se o valor do campo vads_shop_url estiver errado, o formulário não será recusado. Porém, o valorserá usado pelo 3D Secure. O pagamento poderá ser recusado se a URL não for válida


Exemplo de formulário de pagamento com modificação do nome e da URL da loja:

<form method="POST" action="https://secure.payzen.com.br/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="3000" /><input type="hidden" name="vads_capture_delay" value="0" /><input type="hidden" name="vads_ctx_mode" value="PRODUCTION" /><input type="hidden" name="vads_currency" value="986" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value="SINGLE" /><input type="hidden" name="vads_shop_name" value="My Shop" /><input type="hidden" name="vads_shop_url" value="http://www.myshop.com" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20140526101407" /><input type="hidden" name="vads_trans_id" value="239848" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="gV0f2HZzQ9BxttHM2W5ZM+AKQsxu0HjDvKy0NAE/G24="/><input type="submit" name="pagar" value="Pagar"/></form>




9.6. Mudar a denominação do botão "Voltar para a loja"

Você pode personalizar o texto "Voltar para a loja".


2. Use o campo vads_theme_config para mudar a denominação dos botões "Voltar para a loja".

3. Use a palavra chave SUCCESS_FOOTER_MSG_RETURN para mudar a denominação do botão "Voltarpara a loja" exibido se o pagamento for aceito.

4. Use a palavra chave CANCEL_FOOTER_MSG_RETURN para mudar a denominação do botão "Cancelare voltar para a loja" nas diferentes páginas de pagamento.


Ativando a opção personalização avançada, você poderá mudar denominações (exemplo: loja) exibidosna página de pagamento.

Consulte o Manual do usuário do Back Office - Personalização avançada para maiores detalhes ou entreem contato com o suporte técnico.

Exemplo de formulário de pagamento que muda a denominação do botão "Voltar para a loja":

<form method="POST" action="https://secure.payzen.com.br/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="4000" /><input type="hidden" name="vads_capture_delay" value="0" /><input type="hidden" name="vads_ctx_mode" value="PRODUCTION" /><input type="hidden" name="vads_currency" value="986" /><input type="hidden" name="vads_order_id" value="CD100000858" /><input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value="SINGLE" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_theme_config" value="CANCEL_FOOTER_MSG_RETURN=Cancelar;SUCCESS_FOOTER_MSG_RETURN=Retorno" /><input type="hidden" name="vads_trans_date" value="20140331092024" /><input type="hidden" name="vads_trans_id" value="408248" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="ge5DHBbUGsq4cFfSIR1QyB/L/9qPNp2vhX9/G3kKJeQ="/><input type="submit" name="pagar" value="Pagar"/></form>




10. EXIBIR A PÁGINA DE PAGAMENTO EM UM IFRAME

1. Criar um tag HTML <iframe> na página onde você deseja exibir o formulário a preencher (esta páginadeveria corresponder à etapa “Pagamento” do seu caminho de compra):

...<body> <iframe id="idFrame" name="nameFrame" src="https://www.mystore.com/payment/form.php" /></body></html>

Valorize o atributo src com a URL do seu formulário de pagamento.

Para uma exibição correta das páginas 3D-Secure, aconselhamos escolher um tamanho mínimo de 400px * 400px.

Exemplo de página de pagamento integrada:

Exemplo de página 3D Secure integrada:



2. Modificar seu formulário de pagamento:

• Valorize o parâmetro vads_action_mode a IFRAME para ativar o modo iframe e obter uma exibiçãosimples e clara da página de pagamento,

• Adicione o atributo target a seu tag <form> e digite nele o nome do seu iframe,

• Em modo iframe, o comprador não pode consultar ou baixar o ticket de pagamento. Este último deveser enviado por e-mail ao comprador. O parâmetro vads_cust_email torna-se então imprescindível,

...<form method="POST" action="" target="nameFrame" > <input type="hidden" name="vads_action_mode" value="IFRAME" /> ......

3. Gerir o fim do pagamento.

Em modo iframe, não há botão para cancelar ou para voltar para a loja. Porém, você pode redirecionarautomaticamente o comprador para sua página de confirmação de pedido.

Para isso, valorize os parâmetros abaixo no seu formulário de pagamento:

• vads_redirect_success_timeout e vads_redirect_error_timeout a "0",

• vads_url_success com a URL da sua página de confirmação de pedido,

• vads_url_return com a URL da sua página de retorno em caso de pagamento recusado,

• vads_return_mode com o valor "POST" ou "GET" para resgatar o resultado do pagamento e exibí-lo na sua página de confirmação de pedido se for necessário,

• vads_theme_config com o valor "FORM_TARGET=_top" para definir como será exibida a página deretorno.

Você pode também usar os valores seguintes conforme suas necessidades: "_self", "_parent","_framename".

Exemplo de página de confirmação exibindo os dados do pagamento



11. CALCULAR A ASSINATURA

Para calcular a assinatura, você deve ter:

• todos os campos com o nome começando por vads_

• o tipo de algoritmo escolhido na configuração da loja

• a chave (certificado)

O valor da chave está disponível no seu Back office, selecionando o menu Configurações > Loja > abaCertificados.

O tipo de algoritmo é definido no seu Back Office, selecionando o menu Configurações > Loja > abaConfiguração.

Para um segurança máxima, recomendamos usar o algoritmo HMAC-SHA-256 bem como uma chavealfanumérica.

Para calcular a assinatura:

1. Classificar por ordem alfabética todos os campos com o nome começando por vads_ .

2. Garanta que todos os campos sejam codificados em UTF-8.

3. Separe os valores dos campos com o símbolo "+".

4. Concatene o resultado com a chave de teste ou de produção, separando-os com o símbolo "+".

5. Conforme o algoritmo definido na configuração da sua loja:

a. Se sua loja estiver configurada para usar “SHA-1”, aplique a função hash SHA-1 no string obtido naetapa anterior.

b. Se sua loja estiver configurada para usar "HMAC-SHA-256", calcule e codifique no formato Base64a assinatura da mensagem usando o algoritmo HMAC-SHA-256 com os parâmetros seguintes:

• a função hash SHA-256,

• a chave de teste ou de produção (em função do valor do campo vads_ctx_mode) como chavecompartilhada,

• O resultado da etapa anterior como mensagem para ser autenticada.

6. Salve o resultado da etapa anterior no campo signature.



Exemplos de parâmetros enviados para a plataforma de pagamento:

<form method="POST" action="https://secure.payzen.com.br/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /><input type="hidden" name="vads_amount" value="5124" /><input type="hidden" name="vads_ctx_mode" value="TEST" /><input type="hidden" name="vads_currency" value="986" /> <input type="hidden" name="vads_page_action" value="PAYMENT" /><input type="hidden" name="vads_payment_config" value="SINGLE" /><input type="hidden" name="vads_site_id" value="12345678" /><input type="hidden" name="vads_trans_date" value="20170129130025" /><input type="hidden" name="vads_trans_id" value="123456" /><input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="95934ce8678c9e3305f93134054143bd209972dd " /> <input type="submit" name="pagar" value="Pagar"/></form>

Este exemplo de formulário se entende da maneira seguinte:

1. Classificar por ordem alfabética todos os campos com o nome começando por vads_ :


• vads_amount

• vads_ctx_mode

• vads_currency



• vads_site_id

• vads_trans_date

• vads_trans_id

• vads_version

2. Concatene o valor dos campos com o símbolo "+" :

INTERACTIVE+5124+TEST+986+PAYMENT+SINGLE+12345678+20170129130025+123456+V2

3. Acrescente o valor da chave de teste no final do string separando com o símbolo "+"). Neste exemplo,a chave de teste é 1122334455667788:

INTERACTIVE+5124+TEST+986+PAYMENT+SINGLE+12345678+20170129130025+123456+V2+1122334455667788

4. Se você usar o algoritmo SHA-1, aplique ele no string obtido.

O resultado para ser enviado no campo de assinatura é :95934ce8678c9e3305f93134054143bd209972dd

5. Se sua loja estiver configurada para usar "HMAC-SHA-256", calcule e codifique no formato Base64 aassinatura da mensagem usando o algoritmo HMAC-SHA-256 com os parâmetros seguintes:




O resultado a ser enviado no campo assinatura é:

6yRacR+27j4ufafWL/uafpA9YBUCOukOguC0ny2bm74=




11.1. Exemplo de implementação em JAVA

Definição da classe utilitária Sha usando o algoritmo HMAC-SHA-256 para calcular a assinatura:

import javax.crypto.Mac;import javax.crypto.spec.SecretKeySpec;import java.io.UnsupportedEncodingException;import java.security.InvalidKeyException;import java.security.NoSuchAlgorithmException;import java.util.Base64;import java.util.TreeMap; public class VadsSignatureExample { /** * Build signature (HMAC SHA-256 version) from provided parameters and secret key. * Parameters are provided as a TreeMap (with sorted keys). */ public static String buildSignature(TreeMap<String, String> formParameters, String secretKey) throws NoSuchAlgorithmException, InvalidKeyException, UnsupportedEncodingException { // Build message from parameters String message = String.join("+", formParameters.values()); message += "+" + secretKey; // Sign return hmacSha256Base64(message, secretKey); } /** * Actual signing operation. */ public static String hmacSha256Base64(String message, String secretKey) throws NoSuchAlgorithmException, InvalidKeyException, UnsupportedEncodingException { // Prepare hmac sha256 cipher algorithm with provided secretKey Mac hmacSha256; try { hmacSha256 = Mac.getInstance("HmacSHA256"); } catch (NoSuchAlgorithmException nsae) { hmacSha256 = Mac.getInstance("HMAC-SHA-256"); } SecretKeySpec secretKeySpec = new SecretKeySpec(secretKey.getBytes("UTF-8"), "HmacSHA256"); hmacSha256.init(secretKeySpec); // Build and return signature return Base64.getEncoder().encodeToString(hmacSha256.doFinal(message.getBytes("UTF-8"))); }}

Definição da classe utilitária Sha usando o algoritmo SHA-1 para calcular a assinatura:

import java.security.MessageDigest; import java.security.SecureRandom;

public class Sha { static public final String SEPARATOR = "+" ; public static String encode(String src) { try { MessageDigest md; md = MessageDigest.getInstance( "SHA-1" ); byte bytes[] = src.getBytes( "UTF-8" ); md.update(bytes, 0, bytes. length ); byte[] sha1hash = md.digest(); return convertToHex(sha1hash); } catch(Exception e){ throw new RuntimeException(e); } } private static String convertToHex(byte[] sha1hash) { StringBuilder builder = new StringBuilder(); for (int i = 0; i < sha1hash. length ; i++) { byte c = sha1hash[i]; addHex(builder, (c >> 4) & 0xf); addHex(builder, c & 0xf); } return builder.toString(); } private static void addHex(StringBuilder builder, int c) { if (c < 10) builder.append((char) (c + '0' )); else builder.append((char) (c + 'a' - 10)); }}



Função que calcula a assinatura:

public ActionForward performCheck(ActionMapping actionMapping, BasicForm form, HttpServletRequest request, HttpServletResponse response){ SortedSet<String> vadsFields = new TreeSet<String>(); Enumeration<String> paramNames = request.getParameterNames(); // Recupera e tria os nomes dos campos vads_* por ordem alfabética while (paramNames.hasMoreElements()) { String paramName = paramNames.nextElement(); if (paramName.startsWith( "vads_" )) { vadsFields.add(paramName); } } // Calcula a assinatura String sep = Sha.SEPARATOR; StringBuilder sb = new StringBuilder(); for (String vadsParamName : vadsFields) { String vadsParamValue = request.getParameter(vadsParamName); if (vadsParamValue != null) { sb.append(vadsParamValue); } sb.append(sep); } sb.append( shaKey ); String c_sign = Sha.encode(sb.toString()); return c_sign;}



11.2. Exemplo de implementação em PHP

Exemplo de cálculo de assinatura usando o algoritmo HMAC-SHA-256:

function getSignature($params, $key){ /** * Função que calcula a assinatura. * $params : quadro apresentando os campos que devem ser enviados no formulário. * $key : chave de TESTE ou de PRODUÇÃO */ //Inicialização da variável que conterá o string a ser cifrado $conteudo_assinatura = ""; //Triagem dos campos por ordem alfabética ksort($params); foreach($params as $nom=>$valeur){

//Recuperação dos campos vads_ if (substr($nom,0,5)=='vads_'){

//Concatenação com o separador "+" $conteudo_assinatura .= $valor."+"; } } //Adição da chave no final do string $conteudo assinatura .= $key;

//Codificação base64 do string cifrado com o algorítmo HMAC-SHA-256 $signature = base64_encode(hash_hmac('sha256',$conteudo_assinatura, $key, true)); return $signature; }

Exemplo de cálculo de assinatura usando o algoritmo SHA-1:

function getSignature($params, $key){ /** * Função que calcula a assinatura. * $params : quadro apresentando os campos que devem ser enviados no formulário. * $key : chave de TESTE ou de PRODUÇÃO */ //Inicialização da variável que conterá o string a ser cifrado $conteudo_assinatura = "" ; // Triagem dos campos por ordem alfabética ksort($params); foreach ($params as $nom =>$valor){ // Recupperação dos campos vads_ if (substr($nom,0,5)=='vads_') { // Concatenação com o separador "+" $conteudo_assinatura .= $valor."+"; } } // Adição da chave no final $conteudo_assinatura.= $key; // Aplicação do algorítmo SHA-1 $signature = sha1($conteudo_asssinatura); return $signature ;}



12. ENVIAR A SOLICITAÇÃO DE PAGAMENTO

Para cada transação, o comprador deve ser redirecionado para a página de pagamento para finalizar opagamento.

O navegador dele deve enviar os dados do formulário de pagamento.

12.1. Redirecionar o comprador para a página de pagamento

A URL da plataforma de pagamento é a seguinte:


Exemplos de parâmetros enviados para a plataforma de pagamento:

<form method="POST" action="https://secure.payzen.com.br/vads-payment/"><input type="hidden" name="vads_action_mode" value="INTERACTIVE" /> <input type="hidden" name="vads_amount" value="2990" /> <input type="hidden" name="vads_ctx_mode" value="TEST" /> <input type="hidden" name="vads_currency" value="986" /><input type="hidden" name="vads_cust_country" value="BR" /><input type="hidden" name="vads_cust_email" value="[email protected]" /><input type="hidden" name="vads_page_action" value="PAYMENT" /> <input type="hidden" name="vads_payment_config" value="SINGLE" /> <input type="hidden" name="vads_site_id" value="12345678" /> <input type="hidden" name="vads_trans_date" value="20160526101407" /> <input type="hidden" name="vads_trans_id" value="362812" /> <input type="hidden" name="vads_version" value="V2" /><input type="hidden" name="signature" value="NM25DPLKEbtGEHCDHn8MBT4ki6aJI/ODaWhCzCnAfvY="/><input type="submit" name="payer" value="Payer"/></form>

12.2. Gerenciar os erros

Se a plataforma detectar uma anomalia quando recebe o formulário, uma mensagem de erro apareceráe o comprador não poderá efetuar o pagamento.

Em modo de TESTE

A mensagem menciona a origem do erro e disponibiliza um link para consultar a descrição do código deerro, que ajudará você a identificar as razões possíveis.

Em modo de PRODUÇÃO

A mensagem avisa o comprador que um problema técnico ocorreu.

Em ambos os casos, o vendedor recebe um e-mail de alerta.

Contém:

• a origem do erro,

• um link para consultar as razões possíveis para este código de erro, com o intuito de facilitar odiagnóstico,

• todos os campos presentes no formulário.

Uma descrição dos códigos de erro com suas razões possíveis está disponível em nosso site

https://payzen.io/pt-BR/error-code/error-00.html



https://payzen.io/pt-BR/error-code/error-00.html



Outras mensagens podem ser enviadas durante o pagamento.

Segue uma lista das mensagens mais freqüentes:

Mensagem Descrição

Não aceita pagamento atualmente.

O “Serviço de temporada” está ativado na sua loja. Ospagamentos estão autorizados somente durante o períodoconfigurado. Se você desejar alterar o período de aberturada sua loja, favor entrar em contato com o serviço deatendimento ao cliente.

Sua solicitação de pagamento foi recusado pelo seu banco.

• O banco do comprador recusou a solicitação deautorização ou de informação.

• As regras de gerenciamento de risco causaram a recusada transação.

Esta ordem de pagamento está vencida. Favor entrar emcontato com sua loja

O comprador clicou no link de pagamento após a data devencimento da ordem.

Esta ordem de pagamento já foi paga.O comprador clicou de novo no link de pagamento após terrealizado o pagamento.

Uma falha ocorreu ao solicitar o pagamento, o site de e-commerce foi informado que a transação não pode serfinalizada.

O formulário de pagamento foi recusado. O responsável daloja recebeu um e-mail com os detalhes sobre a origem dafalha.

A transação não foi realizada

O site de e-commerce envia um código de transação já usadoem uma outra trancação (aceita ou recusada). O códigode transação deve ser único num mesmo dia (00:00:00 até23:59:59 UTC).

Sintamos muito, você foi desconectado devido a um tempode inatividade longo demais.

• O comprador tenta validar o número de cartão dele, massua sessão de pagamento já expirou. O tempo de sessão éde 10 minutos.

• O site de e-commerce envia um código de transaçãojá utilizado mas que não resultou em uma transação(pagamento abandonado por exemplo). O código detransação deve ser único num mesmo dia (00:00:00 até23:59:59 UTC).

Os cookies estão bloqueados pelo seu navegador. Favorautorizar os cookies antes de reiniciar a operação.

O comprador desativou o uso dos cookies pelo seunavegador. Os cookies são imprescindíveis ao funcionamentodo pagamento.

12.3. Gerenciar os timeout

Noção de sessão de pagamento

Uma "sessão de pagamento" corresponde ao tempo passado pelo comprador na página de pagamento.

A sessão de pagamento inicia assim que a plataforma de pagamento recebe o formulário.

A duração da sessão é de 10 minutos (salvo exceção para alguns meios de pagamento).

Esta duração é:

• suficiente para que todo comprador possa realizar seu pagamento.

• fixa: não é zerada quando o usuário fizer um ação

• inalterável: determinada pela plataforma de pagamento para atender requisitos técnicos.

Após este prazo, a sessão vence e os dados de sessão são apagados.

Vencimento da sessão de pagamento

Em certos casos, a sessão de pagamento vence a pesar do comprador não ter finalizado seu pagamento.



Casos mais frequentes:

1. Uma vez redirecionado para a página de pagamento, o comprador pode dar-se conta de que esta, porexemplo, na hora de ir almoçar.

Uma hora mais tarde, ele decide retomar o pagamento e clica no ícone do seu meio de pagamento.

Como sua sessão de pagamento venceu, a plataforma de pagamento exibe uma mensagem de erronotificando que ele foi desconecto por ter ultrapassado o tempo de inatividade autorizado.

O comprador pode então clicar no botão para voltar para o site de e-commerce.

Volte para a loja com a URL especificada pelo vendedor:

• no campo vads_url_return enviado no formulário de pagamento,

• no campo "URL da loja" no seu Back Office, se ele não informou o campo vads_url_return no seuformulário de pagamento.

2. Uma vez que voltou na página de pagamento, o comprador fecha seu navegador (por engano ouporque não quer mais realizar o pagamento).

Notificação quando a sessão venceu

O site de e-commerce pode receber uma notificação quando uma sessão vencer.

Para isso, o vendedor deve configurar e ativar a regra de notificação em cancelamento (ver capítuloConfigurar as notificações).



13. ANALISAR O RESULTADO DO PAGAMENTO

Para processar o resultado dos pagamentos, o site de e-commerce deve possuir um script em uma páginadedicada para isso (exemplo: análise_pagamento.php).

Esta página será automaticamente chamada após todo pagamento (aceito ou recusado): os parâmetrosvinculados ao resultado do pagamento são enviados em modo POST para a plataforma de pagamento.

Requisitos:

• A URL da página que analisa o resultado do pagamento deverá obrigatoriamente ser informada no BackOffice (ver capítulo Configurar as notificações).

• O vendedor deverá garantir que esta URL pode ser alcançada pela plataforma de pagamento, e issosem redirecionamento.

Os redirecionamentos provocam a perda de dados presentes no POST.

• Se houver restrições instaladas pelo site de e-commerce, será preciso autorizar a lista de endereçosIP 194.50.38.0/24.

As notificações são enviadas a partir de um endereço IP que consta na faixa 194.50.38.0/24 em modode Teste e em modo de Produção.

• A página não deverá conter mensagens HTML.

O acesso a recursos tais como imagens ou documentos padrões podem deixar a comunicação maislenta entre a plataforma de pagamento e o site de e-commerce.

Além disso, a plataforma lê sistematicamente os 512 primeiros símbolos da resposta do site de e-commerce.

Estes símbolos são depois exibidos no histórico das transações.

• Evite o quanto puder neste script tarefas que necessitam tempo tal como gerar uma fatura ou enviare-mail.

O tempo de tratamento impacta diretamente o prazo para a exibição da página de resumo dopagamento. Quanto mais o tratamento demorar, mais longo o tempo de espera antes de visualizar.

Após 35s, a plataforma entende que a chamada falhou (timeout).

Falha de notificação (IPN)

Se falhar a chamada para a URL de notificação (IPN), um e-mail de alerta será enviado para o endereçoinformado no Back Office (ver capítulo Configurar as notificações).

Contém:

• o código HTTP do erro encontrado,

• elementos de análise segundo o erro,

• os passos a seguir a partir do Back Office para enviar de novo a notificação.

Conceber o script de tratamento

O script de tratamento deverá conter pelo menos as etapas a seguir:

• Recuperar a lista dos campos presentes na resposta enviada em POST

• Calcular a assinatura

• Comparar a assinatura calculada com a assinatura recebida



• Analisar a natureza da notificação

• Recuperar o resultado do pagamento

O script pode por exemplo testar o status do pedido (ou a informação da sua escolha) para verificar quenão tenha sido atualizada já.

Uma vez que estas etapas foram realizadas, o script pode atualizar a base de dados (novo status do pedido,atualização do estoque, informações salvas do pagamento etc.).



13.1. Recuperar os dados devolvidos na resposta

Os dados devolvidos na resposta dependem dos parâmetros enviados no formulário de pagamento, dotipo de pagamento efetuado e das opções da sua loja. Estes dados constituem um lista de campos. Cadacampo contém um valor resposta. A lista de campos pode chegar a mudar.

Os dados são sempre enviados em POST para a plataforma de pagamento.

Exemplos:

• Em PHP, os dados serão armazenados na super global $_POST.

• Em ASP.NET (C#), você deve usar a propriedade Form da classe HttpRequest.

• Em ASP.NET (C#), você deve usar a propriedade getParameter da classe HttpServletRequest.

O script deverá realizar uma volta para recuperar a totalidade dos campos enviados.

Exemplo de dados enviados durante a notificação de um pagamento:

vads_amount = 3000vads_auth_mode = FULLvads_auth_number = 3fb0devads_auth_result = 00vads_capture_delay = 0vads_card_brand = VISAvads_card_number = 497010XXXXXX0000vads_payment_certificate = a50d15063b5ec6cb140043138b8d7576470b71a9vads_ctx_mode = TESTvads_currency = 986vads_effective_amount = 3000vads_site_id = 12345678vads_trans_date = 20140902094139vads_trans_id = 454058vads_validation_mode = 0vads_version = V2vads_warranty_result = YESvads_payment_src = ECvads_sequence_number = 1vads_contract_used = 5785350vads_trans_status = AUTHORISEDvads_expiry_month = 6vads_expiry_year = 2015vads_bank_code = 17807vads_bank_product = Avads_pays_ip = FRvads_presentation_date = 20140902094202vads_effective_creation_date = 20140902094202vads_operation_type = DEBITvads_threeds_enrolled = Yvads_threeds_cavv = Q2F2dkNhdnZDYXZ2Q2F2dkNhdnY= vads_threeds_eci = 05vads_threeds_xid = WXJsVXpHVjFoMktzNmw5dTd1ekQ= vads_threeds_cavvAlgorithm = 2vads_threeds_status = Yvads_threeds_sign_valid = 1vads_threeds_error_code = vads_threeds_exit_status = 10vads_trans_uuid= 1cd9994823334e31bbb579b4d716832dvads_risk_control = CARD_FRAUD=OK;COMMERCIAL_CARD=OKvads_result = 00vads_extra_result = 00vads_card_country = BRvads_language = frvads_hash = 299d81f4b175bfb7583d904cd19ef5e38b2b79b2373d9b2b4aab74e5753b10bcvads_url_check_src = PAYvads_action_mode = INTERACTIVEvads_payment_config = SINGLEvads_page_action = PAYMENTsignature = FxGvazgW0dgqOrVrx6bqKZSXh2y5Dp3bWC9HFn33t+Q=



13.2. Calcular a assinatura

A assinatura é calculada segundo a mesma lógica usada durante a criação do formulário de pagamento.

Os dados enviados pela plataforma de pagamento são codificados em UTF-8.

Qualquer alteração dos dados recebidos resultará em um cálculo de assinatura incorreto.

Para calcular a assinatura:

1. Levem em consideração todos os campos com o nome começando por vads_ :

2. Classifique todos os campos por ordem alfabética.

3. Separe os valores dos campos com o símbolo "+".

4. Concatene o resultado com a chave de teste ou de produção, separando-os com o símbolo "+".

5. Conforme o algoritmo definido na configuração da sua loja:

a. Se sua loja estiver configurada para usar “SHA-1”, aplique a função hash SHA-1 no string obtido naetapa anterior.

b. Se sua loja estiver configurada para usar "HMAC-SHA-256", calcule e codifique no formato Base64a assinatura da mensagem usando o algoritmo HMAC-SHA-256 com os parâmetros seguintes:




13.3. Comparar as assinaturas

Para garantir a integridade da resposta, você deve comparar o valor do campo assinatura recebido naresposta, com o valor calculado na etapa anterior.

Se as assinaturas corresponderem,

• você poderá então considerar que a resposta esta segura e continuar a análise.

• caso contrário, o script deverá apontar uma exceção e avisar o vendedor sobre a anomalia (ver capítuloTratar os erros).

As assinaturas não correspondem por causa de:

• erro de implementação (erro no seu cálculo, problema de codificação UTF-8, etc.),

• erro no valor da chave usada ou na chave do campo vads_ctx_mode (problema freqüente quandopassa em produção).

• tentativa de corrupção dos dados.



13.4. Analisar a natureza da notificação

O campo vads_url_check_src permite diferenciar as notificações vinculadas:

• criação de uma transação.

• reenvio da notificação pelo Back Office pelo vendedor.

Ele menciona a regra de notificação aplicada:

Valor Regra aplicada

PAY O valor PAY será reenviado nos seguintes casos:

• pagamento à vista (pagamento à vista ou primeira parcela de um pagamento parcelado)

• pagamento pré-datado com menos de 7 diassomente se o vendedor configurou a regra Url de notificação no final do pagamento.

• o comprador desistiu ou cancelou o pagamentosomente se o vendedor configurou a regra URL de notificação ao cancelamento.

BO Execução da notificação pelo Back Office (clique direito sobre uma transação > Executar a url denotificação).

BATCH O BATCH será enviado se houver uma atualização do status de uma transação após a sincronizaçãocom o adquirente.É o que acontece com pagamentos redirecionados para o adquirente como FacilyPay, PayPal etc.Somente se o vendedor configurou a regra URL de notificação sobre uma autorização por LOTE.

BATCH_AUTO O valor BATCH_AUTO será enviado nos seguintes casos:

• pagamento pré-datado com mais de 7 dias

• prestações de um pagamento parcelado (com exceção da primeira)somente se o vendedor configurou a regra URL de notificação sobre uma autorização por lote.

A notificação será enviada durante a solicitação de autorização de um pagamento com o status de"Esperando a autorização".

REC O valor REC será enviado somente para os pagamentos por assinatura se o vendedor configurou aregra URL de notificação na criação de um pagamento recorrente.

MERCH_BO O valor MERCH_BO será enviado:

• durante uma operação realizada no Back Office (cancelamento, reembolso, modificação,validação, duplicata), se o vendedor configurou a regra de notificação: URL de notificação sobreuma operação proveniente do Back Office

RETRY Re-chamada automática a URL de notificação.

Tabela 14 : Valorizações do campo vads_url_check_src

Testando seu valor, o script poderá realizar um tratamento diferente segundo a natureza da notificação.

Por exemplo:

Se vads_url_check_src tem o valor de PAY ou de BATCH_AUTO então o script atualizará o status dasolicitação, ...

Se vads_url_check_src tiver o valor de REC então o script vai recuperar a referência da assinatura e vaiincrementar o número de parcelas vencidas quando o pagamento for aceito, ...



13.5. Identificar o tipo de operação

O campo vads_operation_type permite diferenciar :

• uma operação de débito

• uma operação de reembolso

Valor Descrição

DEBIT Operação de débito

CREDIT Operação de reembolso

Tabela 15 : Valor do campo vads_operation_type

Por exemplo:

Se vads_operation_type esta preenchido com DEBIT, o script atualiza o pedido e salva as informações datransação.

Se vads_operation_type esta valorizado em CREDIT, o script atualiza o valor pago ou acrescenta uma novalinha de transação no pedido.



13.6. Tratar os dados da resposta

Segue abaixo um exemplo de análise para seguir passo a passo o tratamento dos dados da resposta.

1. Identifique o pedido recuperando o valor do campo vads_order_id se você o enviou no formulário depagamento.

Verifique que o status do pedido não foi atualizado previamente.

2. Recupere o resultado do pagamento enviado no campo vads_trans_status.

O valor dele permite definir o status do pedido.

Valor Descrição

ABANDONED AbandonadoO comprador abandonou o pagamentoA transação não foi criada e portanto não está exibida no Back Office.

AUTHORISED Captura em andamentoA transação foi aceita e será capturada automaticamente no banco na dataprevista.

AUTHORISED_TO_VALIDATE Para ser aprovadoA transação, criada em validação manual, esta autorizada. O vendedor devevalidar manualmente a transação para lançar a solicitação de autorização ea captura no banco.Pode-se validar a transação enquanto a data de vencimento da solicitaçãode autorização não for ultrapassada. Se esta data está vencida, então opagamento tem o status EXPIRED. O status Expirado é definitivo.

CANCELLED CanceladaA transação foi cancelada pelo vendedor.

CAPTURED EntregueA transação foi capturada no banco.

CAPTURE_FAILED A transação não foi capturada.Favor entrar em contato com o suporte.

EXPIRED ExpiradaA data de vencimento da solicitação de autorização foi atingida e ovendedor não validou a transação. Portanto, o portador não será debitado.

INITIAL Em andamentoEste status é específico para todos os meios de pagamento que requeremuma integração por formulário de pagamento em redirecionamento.Este status é retornado quando:

• nenhuma resposta é retornada pelo compradorou

• o prazo de resposta do comprador ultrapassa o tempo da sessão dopagamento na plataforma de pagamento.Esta status é temporário. O status definitivo será exibido no Back Officeassim que a sincronização finalizar

NOT_CREATED Transação não criadaA transação não foi criada e portanto não esta exibida no Back Office.

REFUSED RecusadaA transação foi recusada.

SUSPENDED SuspensaA captura da transação está temporariamente bloqueada pelo adquirente(AMEX GLOBAL ou SECURE TRADING). Uma vez que a captura forprocessada corretamente, o status da transação seráCAPTURED.

UNDER_VERIFICATION Verificação em andamento Específico a PayPal

WAITING_AUTHORISATION Autorização em andamentoO prazo de captura no banco é maior que o tempo de validade daautorização.

WAITING_AUTHORISATION_TO_VALIDATE

Para ser aprovado e autorizado



Valor DescriçãoO prazo de captura no banco é maior que o tempo de validade daautorização.Uma autorização 1 BRL foi aceita.O vendedor deve validar manualmente a transação para lançar a solicitaçãode autorização e a captura no banco.

Tabela 16 : Valores associados a vads_trans_status

3. Recupere a referência do pagamento enviado no campo vads_trans_id.

4. Analise o campo vads_payment_config para determinar se trata-se de um pagamento à vista(unitário) ou de um pagamento parcelado.

Este campo pode ser valorizado a:

Nome do campo Valor para um pagamento à vista Valor para um pagamento parcelado

vads_payment_config SINGLE MULTI(cuja sintaxe exata é MULTI:first=X;count=Y;period=Z)

Tabela 17 : Análise do campo vads_payment_config

Se tratar-se de um pagamento parcelado, informe o número da parcela recuperando o valor docampo vads_sequence_number.

Valor Descrição

1 Primeira parcela

2 Segunda parcela

3 Terceira parcela

n N parcela

Tabela 18 : Análise do campo vads_sequence_number

Observação:

Para um pagamento à vista (unitário) o campo vads_sequence_number tem o valor de 1.

5. Recupere o valor do campo vads_trans_date para identificar a data do pagamento.

6. Recupere o valor do campo vads_capture_delay para identificar o número de dias antes da capturano banco.

Isto lhe permitirá saber se trata-se de um pagamento à vista ou pré-datado.

7. Recupere o valor e a moeda usada. Para isso, recupere os valores dos seguintes campos:


vads_amount Valor do pagamento na sua menor unidade monetária.

vads_currency Código da moeda usada para o pagamento.

vads_change_rate Taxa de cambio usada para calcular o valor real do pagamento (vervads_effective_amount).

vads_effective_amount Valor do pagamento na moeda efetivamente usada para a captura no banco.

vads_effective_currency Moeda usada para a captura no banco.

Tabela 19 : Recupere o valor e a moeda usada.

8. Recupere o valor do campo vads_auth_result para conhecer o resultado da solicitação deautorização.

A lista completa dos códigos de retorno está disponível no dicionário de dados.

9. Recupere o resultado da autenticação 3D Secure. Para isso:

a. Recupere o valor do campo vads_threeds_enrolled para determinar o status de alistamento docartão.



Valor Descrição

Vazio Processo 3DS não realizado (3DS desativado na solicitação, vendedor não afiliado ou meio de pagamentonão elegível no 3DS).

Y Autenticação disponível, portador afiliado.

N Portador não afiliado.

U Identificação do portado impossível ou cartão não elegível com as tentativas de autenticação (ex. Cartõescomerciais ou pré-pagos).

Tabela 20 : Valores do campovads_threeds_enrolled

b. Recupere o resultado da autenticação 3D Secure recuperando o valor do campovads_threeds_status.

Valor Descrição

Vazio Autenticação 3DS não realizada (3DS desativado na solicitação, portador não afiliado ou meio de pagamentonão elegível no 3DS)

Y Portador identificado com sucesso.

N Erro de autenticação do portador.

U Autenticação impossível.

A Tentativa de autenticação mas autenticação não efetuada.

Tabela 21 : Valores do campo vads_threeds_status

10.Recupere o resultado dos controles associados à fraude identificando o valor do campovads_risk_control. Este campo é enviado somente se o vendedor:

• selecionou a opção « Ajuda à decisão »

• ativou pelo menos um controle pelo seu Back Office (menu Configuração > Controle dos riscos).

Ele toma como valor uma lista de valores separados por um « ; » cuja sintaxe é: vads_risk_control =control1=result1;control2=result2

Os valores possíveis para control são:

Valor Descrição

CARD_FRAUD Controla a presença do número de cartão do comprador na lista cinza de cartões.

SUSPECT_COUNTRY Controla a presença do país emissor do cartão do comprador na lista dos paísesproibidos.

IP_FRAUD Controla a presença do endereço IP do comprador na lista cinza de IP.

CREDIT_LIMIT Controla a freqüência e os valores de compra de um mesmo número de cartão, ou ovalor máximo de um pedido.

BIN_FRAUD Controla a presença do código BIN do cartão na lista cinza dos códigos BIN.

ECB Controla se o cartão do comprador for do tipo e-carte bleue.

COMMERCIAL_CARD Controla se o cartão do comprador for um cartão comercial.

SYSTEMATIC_AUTO Controla se o cartão do comprador for um cartão com autorização sistemática.

INCONSISTENT_COUNTRIES Controla se o país do endereço IP, o país emissor do cartão de pagamento, e o país doendereço do comprador estão coerentes entre eles.

NON_WARRANTY_PAYMENT Controla a transferência de responsabilidade da transação.

SUSPECT_IP_COUNTRY Controle a presença do país do comprador, identificado pelo endereço IP dele, na listados países proibidos.

Tabela 22 : Lista dos controles associados à fraude

Os valores possíveis para result são:

Valor Descrição

OK OK.

WARNING Controle informativo não sucedido.

ERROR Controle bloqueante não sucedido.

Tabela 23 : Lista dos controles associados à fraude



11.Recupere o tipo de cartão usado para o pagamento.

Dois cenários são possíveis:

• Para um pagamento realizado com um único cartão. Os campos a serem tratados são osseguintes:


vads_card_brand Tipo de cartão usado para o pagamento. ex: VISA, VISA_ELECTRON,MASTERCARD, MAESTRO, VPAY

vads_card_number Número de cartão usado para efetuar o pagamento.

vads_expiry_month Mês de vencimento entre 1 e 12 (ex: 3 para março, 10 para outubro).

vads_expiry_year Ano de vencimento com 4 dígitos (ex: 2023).

vads_bank_code Código do banco emissor

vads_bank_product Código produto do cartão

vads_card_country Código País do país emissor do cartão (Código alfa ISO 3166-2, ex França=FR).

Tabela 24 : Análise do cartão usado para o pagamento

• Para um pagamento fracionado (ou seja, um pagamento realizado com mais de um meio depagamento), os campos a serem tratados são os seguintes:

Nome do campo Valor Descrição

vads_card_brand MULTI Diversos tipos de cartões são utilizados para opagamento.

vads_payment_seq

Formato JSON, veja os detalhes abaixo. Detalhes de transações concluídas.

O campo vads_payment_seq (formato JSON) descreve a sequência de pagamento fracionado. Elecontém os elementos:

1. "trans_id": número de transação global da sequência de pagamento.

2. "transaction": quadro das transações da sequência. Os elementos são os seguintes:

Nome do parâmetro Descrição

amount Valor da seqüência de pagamento.

operation_type Operação de débito.

auth_number Número de autorização. Exemplo: 949478

auth_result Código retorno ao pedido de autorização.

capture_delay Prazo antes da captura (em dias).

• Para um pagamento por cartão bancário, o valor deste parâmetro leva em conta o prazoem número de dias antes da captura no banco. Se este parâmetro não for enviado noformulário de pagamento, então o valor padrão definido no Back Office será usado.

card_brand Meio de pagamento usado.

card_number Número do meio de pagamento.

• Para um pagamento por cartão bancário, o número é oculto.

expiry_month Mês de vencimento do meio de pagamento.

expiry_year Ano de vencimento do meio de pagamento.

payment_certificate Certificado de pagamento.

contract_used Contrato usado para o pagamento.

identifier Código único (Token Cartão) associado a um meio de pagamento.

identifier_status Somente presente se a ação solicitada corresponder à criação ou à atualização de um TokenCartão.Valores possíveis:

Valor Descrição

CREATED A solicitação de autorização foi aceita.O Token Cartão ou RUM foi criado com sucesso.

NOT_CREATED A solicitação de autorização foi recusada.



Nome do parâmetro Descrição

Valor DescriçãoO Token Cartão ou RUM não foi criado e não será exibido no BackOffice.

UPDATED O Token Cartão ou RUM foi atualizado com sucesso.

NOT_UPDATED O Token Cartão ou RUM não foi atualizado.

ABANDONED O comprador desistiu da ação (devedor).O Token Cartão ou RUM não foi criado e não será exibido no BackOffice.

presentation_date Para um pagamento por cartão bancário, este parâmetro corresponde à data de capturadesejada no banco (no formato ISO 8601).

trans_id Número da transação.

ext_trans_id Parâmetro ausente para o pagamento por cartão bancário.

trans_uuid Referência única gerada pela plataforma de pagamento após a criação de uma transação depagamento.Oferece uma garantia de unicidade para cada transação

extra_result 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.

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.

sequence_number Número de seqüência.

trans_status Status da transação.

Tabela 25 : Conteúdo do objeto JSON

Observação: transações canceladas também estão presentes na tabela.

12.Recupere todas as informações sobre o detalhe do pedido, o detalhe do comprador e o detalhe daentrega.

Estes dados estão presentes na resposta somente se eles foram enviadas no formulário depagamento.

O valor deles é idêntico ao valor mencionado no formulário.

13.Faça a atualização do pedido.



13.7. Tratar os erros

Implementação de um arquivo de log

Durante a fase de implementação, será útil possuir logs especificamente em caso de dificuldades paracalcular a assinatura.

Nós aconselhamos implementar um arquivo de log diariamente, mesmo depois de ter passado o site dee-commerce em produção.

Isto lhe permitirá analisar os dados em caso de problemas.

Idealmente, o arquivo de logs terá que conter os dados enviados ou recebidos, o string do cálculo deassinatura obtido, antes de aplicar da função hash.

Código de erro HTTP

Em caso de erro durante as notificações, o e-mail de alerta enviado menciona o código de retorno doprotocolo HTTP.

Existe 5 categorias de códigos de retorno:

Categoria de códigos Descrição

1XX Informação

2XX Sucesso

3XX Redirecionamento

4XX Erro do cliente

5XX Erro do cliente

Os códigos de erro mais frequentemente retornados são apresentados na FAQ - Perguntas mais frequentes

https://payzen.io/pt-BR/error-code/server-url-error.html

Erro frequente:

Um arquivo htaccess pode bloquear a chamada para a URL de notificação instantânea.

Os arquivos .htaccess são arquivos de configuração dos servidores web Apache. Podem ser localizadosem qualquer repertório do site de e-commerce (a configuração se aplica ao repertório e a todo arquivocontido que não tiver este tipo de arquivo presente).

https://payzen.io/pt-BR/error-code/server-url-error.html



14. TRATAR O RETORNO PARA A LOJA

De maneira padrão, quando o comprador volta no site de e-commerce, nenhum parâmetro é enviado pelonavegador dele.

Porém se o campo vads_return_mode foi enviado no formulário de pagamento (ver capítulo Gerenciar oretorno para o site de e-commerce) será possível recuperar os dados:

• ou em GET: dados presentes na url sob a forma: ?param1=valor1&param2=valor2.

• ou em POST: dados enviados num formulário POST.

Os dados transmitidos para o navegador são os mesmos que os das notificações (IPN).

Somente os campos vads_url_check_src e vads_hash serão enviados na notificação instantânea.

Você pode consultar o capítulo Tratar as modificações para analisar estes dados.

Observação : o retorno para a loja deve permitir somente uma visualização do contexto ao comprador.Não use os dados recebidos para realizar o tratamento na base de dados.



15. INICIAR A FASE DE TESTE

Antes de passar a loja em modo produção, é preciso realizar testes para garantir o bom funcionamentoentre o site de e-commerce e a plataforma de pagamento.

As solicitações de pagamento de teste devem:

• ter o campo vads_ctx_mode valorizado a TEST.

• usar a chave de teste para calcular a assinatura.

Diversos casos de pagamentos podem ser simulados usando os números de cartão de teste apresentadosna página de pagamento. O vendedor poderá testar de novo os diferentes resultados de autenticação 3DSecure (se este último estiver alistado 3DS e se a opção 3DS estiver ativada).

A lista dos testes a serem realizados para gerar a chave de produção está disponível no Back Office PayZen,no menu Configurações > Loja > Certificados

Cada linha da lista junta os números de cartões associados ao mesmo caso concreto (ou seja, 2 pagamentosaceitos e 2 pagamentos recusados).

Cada coluna corresponde a um tipo de cartão diferente: CB/VISA, MASTERCARD, MAESTRO, VISAELECTRON).

Para realizar a fase de teste:

1. Faça um pedido no seu site de e-commerce como se você fosse um dos seus compradores.

2. Uma vez que foi redirecionado para a página de pagamento, selecione o tipo de cartão da suaescolha.

3. Consulte a lista dos testes para identificar o número de cartão a ser utilizado.

4. Quando um teste for aprovado, seu status será atualizado na lista. Use o botão Atualizar a planilha seo status não foi atualizado automaticamente.

5. Uma vez que os 4 testes forem aprovados, o botão Gerar o certificado de produção estará entãodisponível.

6. Clique no botão Gerar o certificado de produção e valide as sucessivas mensagens de advertência.

A chave de produção encontra-se agora disponível.



15.1. Testar a URL de notificação instantânea (IPN)

Verifique primeiro o status da URL de notificação instantânea (também chama IPN) pelo Back Office.

Para isso:

1. Clique direito em uma transação.

2. Selecione Exibir o detalhe da transação.

3. Verifique o status da URL de notificação instantânea (IPN).

• Se o status exibido for Enviado, significa que você informou corretamente a URL no Back Office.

• No caso de que o status aparece em URL não definida, significa que você não informou a URL noBack Office.

1. Verifique o endereço da URL de notificação instantânea digitada em modo TEST e PRODUCTION.

2. Clique em Configuração > Regras de notificação.

3. Informar a URL de notificação de pagamento instantânea (URL de notificação no final dopagamento).

Não digite um endereço em "localhost". A chamada para esta URL é feita de servidor a servidor.


• Se o status for Falhou, consultar o capítulo Tratar os erros.



16. ATIVAR A LOJA EM MODO DE PRODUÇÃO

Este capítulo detalha como você pode:

• Gerar a chave de produção.

• Passar seu site de e-commerce em produção.

• Efetuar um primeiro pagamento em produção.

• Gerar de novo o certificado de produção (se houver problema)

16.1. Gerar a chave de produção

Você pode gerar a chave de produção a partir do menu Configuração > Loja > Aba Certificados > botãoGerar o certificado de produção.

Uma vez que a chave foi gerada, o valor dele aparece debaixo da aba Certificados.

Um e-mail é enviado para o responsável encarregado do assunto (responsável administrativo da empresa)para confirmar para ele que a chave de produção foi gerado.

16.2. Passar seu site de e-commerce em produção

1. Preencher o campo vads_ctx_mode a PRODUCTION.

2. Modificar o valor da chave de teste com o valor da sua chave de produção para calcular a assinatura.

Você encontrará este valor no menu Configuração > Loja > Aba Certificados.

3. Informar corretamente a URL de notificação no final do pagamento em modo PRODUÇÃO no menuConfiguração > Regras de notificações.

16.3. Efetuar um primeiro pagamento em produção.

Nós aconselhamos que você verifique os dois pontos seguintes:

• A boa e completa execução em modo de produção.

Para isso, faça uma transação real.

Esta transação poderá ser cancelada depois no Back Office via o menu Gestão > Transações > abaTransações em andamento. Esta transação não será capturada no banco.

• O bom funcionamento da URL de notificação de pagamento (Url de notificação no final do pagamento)informada no Back Office.

Para isso, não clique no botão Voltar para a loja depois de um pagamento.

Exiba o detalhe da transação no Back Office e confira que o status da URL de notificação (Status URLde notificação) seja Enviado.



16.4. Gerar de novo a chave de produção

Em caso de perda ou de comprometimento da chave de produção, o vendedor terá a possibilidade degerar uma nova chave no seuBack Office. Para isso:

1. No Back Office, selecionar Configuração > Loja> aba Certificados.

2. Clicar em Gerar de novo.



17. DICIONÁRIO DE DADOS

O dicionário de dados apresenta a lista completa dos campos que podem ser utilizados no formulário depagamento.

Ele detalha inicialmente as principais categorias (tais como as informações técnicas, as informações dopedido…). O conjunto dos campos que pertencem à uma categoria são apresentados.

Estas tabelas são apresentadas da seguinte maneira:

• Nome do campo: nome do parâmetro, como ele será usado em um pedido HTTP.

• Formato: formato dos dados

• Descrição: descrição do campo

• Entrada: caracteriza um campo a enviar no pedido

• Saída: caracteriza um campo enviado na resposta

O dicionário de dados apresenta em seguida o detalhe para cada um dos campos. Cada campo é descritoda seguinte maneira:

• Descrição: descrição do campo

• Formato: formato dos dados (ver quadro acima Lista de campos e formatos)

• Valores possíveis: valores esperados quando o campo é valorizado com valores específicos

• Exemplo: exemplo de codificação correta dos dados

• Código de erro: em caso de erro na interface entre o site de e-commerce e a plataforma de pagamento,esta última indicará com um código numérico o parâmetro errado no campo vads_extra_result

• Observação: informações adicionais, precisões

• Categoria: categoria com a qual o campo esta vinculado

Detalhes de códigos de erro:

Código de erro corresponde ao número de erro quando for apresentado um formulário de pagamentoincorreto.

• Em modo teste este código será exibido na página de pagamento.

• Em modo produção um e-mail de alerta será enviado precisando o código de erro e o nome doparâmetro incorreto.

Exemplo: Erro 09 corresponde a um erro sobre o valor. O valor enviado não esta conforme ao formatorequerido.



Exibir os parâmetros classificados por categoria

Clique na categoria desejada para ter a lista dos parâmetros subjacentes.

• Informações sobre a autenticação 3DS

• Informações sobre a assinatura.

• Informações sobre o comprador.

• Informações sobre o meio de pagamento.

• Informações sobre o pedido.

• Informações sobre a entrega.

• Informações técnicas

• Informações sobre a transação.

• Informações sobre as transações de doação

• Personalização da página de pagamento

• Redirecionamento automático

Informações técnicas

Nome do campo Formato Descrição Entrada Saída

signature an40Assinatura que garante a integridade dassolicitações transmitidas entre o site de e-commerce e a plataforma de pagamento.

x x

vads_action_mode enum Modo de aquisição dos dados do cartão x x

vads_override_payment_cinematic enumCinemática de pagamento para aplicar.Sobrescreve o valor salvou no contrato.

x

vads_contrib ans..128Nome da solução e-commerce usada no sitede e-commerce bem como o número daversão.

x x

vads_ctx_mode enumModo de comunicação com a plataforma depagamento

x x

vads_extra_result n2Código complementar de resposta Asignificação dela depende do valorinformado em vads_result.

x

vads_hash an64Chave única reenviada somente para aURL de notificação (IPN).

x

vads_page_action enum Define a operação a ser efetuada. x x

vads_payment_error n..3Códigos de erro sobre um pagamentorecusado.

x

vads_result n2Código retorno geral do resultado dopagamento.

x

vads_site_id n8 Código da loja x x

vads_url_check ans..1024URL da página a ser notificada no final dopagamento. Sobrescreve o valor digitado naconfiguração das regras de notificação.

x

vads_url_check_src enumEste parâmetro define a procedência dachamada URL de notificação (IPN Server).

x

vads_version enumVersão do protocolo de troca com aplataforma de pagamento

x x

Tabela 26 : Lista dos parâmetros - Informações técnicas



Informações sobre o pedido.


vads_authent_paypal_protection_eligibilityenum

Tipo de proteção dos vendedores vigentepara a transação.

x

vads_ext_info

ans

Os campos podem ser personalizadose permitem acrescentar dadossuplementares no e-mail de confirmaçãoenviado para o vendedor e na URL denotificação.

x x

vads_nb_products n..12Quantidade de artigos presentes nocarrinho

x

vads_order_id ans..64 Número de pedido x x

vads_order_info an..255 Informações adicionais sobre o pedido x x

vads_order_info2 an..255 Informações adicionais sobre o pedido x x

vads_order_info3 an..255 Informações adicionais sobre o pedido x x

vads_product_amountNn..12

Valor do artigo. N corresponde ao índicedo artigo (0 para o primeiro, 1 para osegundo...)

x

vads_product_labelNan..255

Denominação do artigo. N corresponde aoíndice do artigo (0 para o primeiro, 1 para osegundo...)

x

vads_product_qtyNn..12

Quantidade de artigo. N corresponde aoíndice do artigo (0 para o primeiro, 1 para osegundo...)

x

vads_product_refNan..64

Referência do artigo. N corresponde aoíndice do artigo (0 para o primeiro, 1 para osegundo...)

x

vads_product_typeNenum

Tipo do artigo. N corresponde ao índicedo artigo (0 para o primeiro, 1 para osegundo...)

x

vads_tax_amount n..12Valor dos impostos para a totalidade dopedido

x

Tabela 27 : Lista dos parâmetros - Detalhes do pedido



Informações sobre o comprador.


vads_avs_result a1 Address verification system (AVS) x

vads_cust_address ans..255 Caixa postal x x

vads_cust_address2 ans..255 Segunda linha do endereço x x

vads_cust_address_number ans..64 Número de rua x x

vads_cust_cell_phone an..32 Número de telefone celular x x

vads_cust_city an..128 Cidade x x

vads_cust_countrya2

Código país seguindo a norma ISO 3166alpha-2

x x

vads_cust_district ans..127 Bairro x x

vads_cust_email ans..150 Endereço e-mail do comprador x x

vads_cust_first_name ans..63 Nome x x

vads_cust_idan..63

Referência do comprador no site de e-commerce

x x

vads_cust_last_name ans..63 Sobrenome x x

vads_cust_legal_name an..100 Razão social do comprador x x

vads_cust_name an..127Use vads_cust_first_name evads_cust_last_name.

x x

vads_cust_national_id ans..255 CPF/CNPJ x x

vads_cust_phone an..32 Número de telefone x x

vads_cust_state ans..127 UF / Região x x

vads_cust_status enum Status x x

vads_cust_title an..63 Estado civil do comprador x x

vads_cust_zip an..64 CEP x x

vads_ext_info_fingerprint_id string Código único de sessão x

vads_ext_info_bil_address_complementanos..250

Complemento de endereço para ofaturamento

x

vads_ext_info_bil_date_of_birthDatetime

Data de nascimento do comprador nafatura

x

vads_ext_info_bil_gender n1 Indica o gênero do comprador na fatura x

Tabela 28 : Lista dos campos - Detalhes do comprador



Informações sobre a entrega.


vads_shipping_amount n..12 Valor das despesas de entrega x

vads_ext_info_deadline n Indica o prazo de entrega em dia (X dias) x

vads_ext_info_ship_address_complement anos..250 Complemento de endereço para a entrega x

vads_ext_info_ship_date_of_birthDatetime

Data de nascimento do comprador para aentrega

x

vads_ext_info_ship_gendern1

Indica o gênero do comprador para aentrega

x

vads_ship_to_city an..128 Cidade x x

vads_ship_to_country a2 Código país segundo a norma ISO 3166 x x

vads_ship_to_delayenum

Prazo de entrega, obrigatório para umaentrega prioritaria

x

vads_ship_to_delivery_company_name ans..127 Nome da transportadora x

vads_ship_to_district ans..127 Bairro x x

vads_ship_to_first_name ans..63 Nome x

vads_ship_to_last_name ans..63 Sobrenome x

vads_ship_to_legal_name an..100 Razão social x

vads_ship_to_nameans..63

Desvalorizado. Sobrenome do comprador.Use vads_ship_to_first_name evads_ship_to_last_name.

x x

vads_ship_to_phone_num ans..32 Número de telefone x x

vads_ship_to_speed enum Prazo de entregadesc_ship_to x

vads_ship_to_state ans..127 UF / Região x x

vads_ship_to_status enum Define o tipo de endereço de entrega. x x

vads_ship_to_street ans..255 Caixa postal x x

vads_ship_to_street_number an..5 Número de rua x x

vads_ship_to_street2 ans..255 Segunda linha do endereço x x

vads_ship_to_type enum Tipo de transporte x

vads_ship_to_user_infoans..255

Informações sobre o comprador(Identificador legal CPF/CNPJ).

x x

vads_ship_to_zip an..64 CEP x x

Tabela 29 : Lista dos parâmetros - Detalhes de entrega



Informações sobre o meio de pagamento.


vads_bank_code n5 Código banco associado ao banco emissor. x

vads_bank_productan..3

Código produto do cartão usado para opagamento.

x

vads_birth_day n..2 Data de nascimento do portador. x

vads_birth_month n..2 Mês de nascimento do portador. x

vads_birth_year n4 Ano de nascimento do portador. x

vads_card_brand an..127 Tipo de cartão usado para o pagamento. x x

vads_card_countrya2

Código alfa-2 (ISO 3166) do país do cartãousado para o pagamento.

x

vads_card_number n..36 Número do cartão oculto. x x

vads_card_holder_nameans..255

Este campo corresponde ao sobrenome doportador do cartão.

x

vads_cvvn..4

Código de segurança do cartão de 3 ou 4dígitos.

x

vads_expiry_monthn..2

Mês de vencimento do cartão usado para opagamento.

x x

vads_expiry_yearn4

Ano de vencimento do cartão usado para opagamento.

x x

vads_proof_of_id_numberan..13

Campo reservado para digitar o número dedocumento de identidade do comprador napágina de pagamento.

x

vads_proof_of_id_typeenum

Este campo corresponde ao tipo dedocumento de identidade selecionado pelocomprador.

x

Tabela 30 : Lista dos parâmetros - Informação sobre o meio de pagamento



Informações sobre a transação


vads_acquirer_transient_datajson

Informações específicas próprias aoadquirente.

x

vads_amountn..12

Valor da transação apresentado na menorunidade da moeda .

x x

vads_auth_modeenum

Modo que realizou a solicitação deautorização.

x

vads_auth_numberan..6

Número de autorização devolvido peloservidor do banco.

x

vads_auth_resultn..3

Código retorno da solicitação deautorização devolvida pelo banco emissor.

x

vads_capture_delayn..3

Prazo em quantidade de dias antes dacaptura no banco.

x

vads_change_ratestring

Taxa de cambio usada para calcular ovalor real do pagamento (pagamento multi-moeda).

x

vads_contract_used ans..250 Contrato comercial usado. x

vads_contracts map Contrato comercial a ser usado. x

vads_currencyn3

Código numérico da moeda a ser usada parao pagamento.

x x

vads_effective_amountn..12

Valor do pagamento expresso na menorunidade da moeda usada para efetuar acaptura no banco.

x

vads_effective_creation_daten14

Data de registro da transação, no fusoUTC (ou GNT+0) ao formato horário 24h(AAAAMMJJHHMMSS).

x

vads_effective_currency n3 Moeda usada para a captura no banco. x

vads_ext_trans_id enum Referência externa de transação. x

vads_first_installment_delayn..3

Quantidade em meses de adiamento aser aplicada na primeira parcela para umpagamento parcelado.

x

vads_operation_typeenum

Tipo de operação: débito ou crédito(reembolso).

x

vads_payment_cards listed'enum

Lista dos meios de pagamento para proporao comprador.

x

vads_payment_certificatean40

Campo informado pela plataforma depagamento se a autorização foi efetuadacom sucesso.

x

vads_payment_config enum Tipo de pagamento: à vista ou parcelado. x x

vads_payment_option_codean..5

Campo específico para um pagamentoparcelado. Permite definir a quantidade deparcelas

x x

vads_payment_seq json Seqüência de um pagamento fracionado. x

vads_payment_src enum Procedência do pagamento. x

vads_risk_analysis_resultenum

Resultado da análise de fraude realizadapor um sistema externo (ClearSale,CyberSource,...).

x

vads_risk_assessment_resultenum

Resultado da análise de gerenciamentoavançado dos riscos realizada pelaplataforma de pagamento.

x

vads_risk_controlmap

Resultado dos controles associados àfraude.

x

vads_sequence_numbern..3

Número de sequência da transação(número de parcela).

x

vads_token_id an..32 Código da ordem de pagamento associadaà transação.




vads_trans_daten14

Data e hora, no fuso UTC (ouGMT+0) ao formato horário 24h(AAAAMMJJHHMMSS).

x x

vads_trans_id n6 Identificador único de uma transação. x x

vads_trans_status enum Status da transação. x

vads_trans_uuidans32

Referência única da transação gerada pelaplataforma de pagamento.

x

vads_validation_mode n1 Modo de validação da transação. x x

vads_warranty_resultenum

Transferência de responsabilidade se opagamento foi aceito.

x

Tabela 31 : Lista dos parâmetros - Informação sobre a transação



Autenticação 3DS


vads_threeds_cavv

ans..28

Designa a verificação da autenticação doportador pela ACS.É valorizado pelo servidor deautenticação 3DS (ACS) quando ocomprador se identificou corretamente(vads_threeds_status vale« Y » ou « A »).

x x

vads_threeds_cavvAlgorithm

n1

Algoritmo usado pela ACS para gerar ovalor do cavv.É valorizado pelo servidor deautenticação 3DS (ACS) quando ocomprador se identificou corretamente(vads_threeds_status vale« Y » ou « A »).

x x

vads_threeds_eci

n..2

Designa o Indicador de ComercioEletrônicoÉ valorizado pelo servidor deautenticação 3DS (ACS) quando ocomprador se identificou corretamente(vads_threeds_status vale« Y » ou « A »).

x x

vads_threeds_enrolled

a1

Designa o status de alistamento doportador.É valorizado pelos servidores VISA eMASTERCARD (DS) durante o processo 3DSecure

x x

vads_threeds_error_coden..2

Desvalorizado.Use vads_threeds_exit_status.

x

vads_threeds_exit_status

n..2

Designa o status final do processo 3DSecure.É valorizado pela plataforma depagamento

x

vads_threeds_mpin1

Ativa / desativa o processo 3DS durante umpagamento e-commerce

x

vads_threeds_sign_validn1

Designa a validade da assinatura damensagem PARes.É valorizado pela plataforma de pagamento

x

vads_threeds_status

a1

Designa o status de autenticação doportador.É valorizado pelo servidor de autenticação3DS durante o processo 3D Secure.

x x

vads_threeds_xid

ans..28

Designa a referência única da transação3DS.É valorizado pelo servidor de autenticação(ACS) durante o processo 3D Secure.

x x

Tabela 32 : Lista dos parâmetros - Autenticação 3DS



Informações sobre as transações de doação.


vads_ext_info_donationn..12

Valor da doação expresso na menorunidade da moeda.

x

vads_ext_info_donation_contributionn..12

Valor em centavos da contribuiçãoexpresso na menor unidade da moeda .

x

vads_ext_info_donation_merchantn8

Identificador da associação que recebeu adoação.

x

vads_ext_info_donation_recipientn..20

Identificador HelloAsso da associação querecebeu a doação.

x

vads_ext_info_donation_recipient_name ans..255 Nome da associação que recebeu a doação. x

vads_risk_primary_warranty

enum

Permite sobrescrever a configuraçãodo controle de risco Controle datransferência de responsabilidade datransação primária.

x

Tabela 33 : Lista dos parâmetros - Informação sobre as transações de doação

Personalização da página de pagamento


vads_available_languages Lista deenum

Permite especificar os idiomas disponíveisna página de pagamento sob a forma delista.

x x

vads_language a2Definido no mesmo idioma exibido napágina de pagamento (norma ISO 639-1).

x x

vads_shop_name

ans..127

Permite definir o nome da loja queserá exibido nos e-mails de confirmaçãode pagamento e no recapitulativo datransação

x x

vads_shop_urlans..1024

Permite sobrescrever a URL da loja que seráexibida na página de pagamento e nos e-mails de confirmação de pagamento.

x x

vads_theme_config mapPermite personalizar alguns elementos dapágina de pagamento.

x

Tabela 34 : Lista dos parâmetros - Personalização da página de pagamento



Redirecionamento para o site de e-commerce


vads_redirect_error_message

ans..255

Redirecionamento automático:Mensagem exibida antes doredirecionamento depois de umpagamento aceito/recusado.

x

vads_redirect_error_timeout

n..3

Redirecionamento automático:Prazo (em segundo) antes doredirecionamento para o site de e-commerce no final de um pagamentoaceito/recusado.

x

vads_redirect_success_message

ans..255

Redirecionamento automático:Especifica a mensagem no final deum pagamento aceito no caso de umredirecionamento automático para o sitede e-commerce.

x

vads_redirect_success_timeout

n..3

Redirecionamento automático:Prazo em segundo antes doredirecionamento para o site de e-commerce no final de um pagamentoaceito. O valor oscila entre 0 et 600s.

x

vads_return_modeenum

Permite especificar o modo de envio dosdados às URLs de retorno para o site de e-commerce

x

vads_url_cancel

ans..1024

URL para qual será redirecionado ocomprador depois de clicar em "cancelar evoltar para a loja" antes de ter efetuado opagamento.

x

vads_url_checkans..1024

URL da página a ser notificada no final dopagamento. Sobrescreve o valor digitado naconfiguração das regras de notificação.

x

vads_url_check_srcenum

Este parâmetro define o evento quedispara a notificação instantânea (tambémchamada IPN ou URL de notificação).

x

vads_url_errorans..1024

URL para qual será redirecionado ocomprador em caso de erro de tratamentointerno.

x

vads_url_post_walletans..1024

URL na qual será chamado o vendedor emcaso de uso de wallet durante o pagamento.

x x

vads_url_refused ans..1024URL para qual será redirecionado ocomprador em caso de recusa.

x

vads_url_returnans..1024

URL padrão para qual será redirecionado ocomprador depois de clicar em "voltar paraa loja".

x

vads_url_success ans..1024URL para qual será redirecionado ocomprador em caso de sucesso.

x

Tabela 35 : Lista dos parâmetros - Redirecionamento para o site de e-commerce



Informações sobre a assinatura.


vads_identifier ans..50Código único associado a um meio depagamento.

x x

vads_identifier_status enum Status de registro do mandato. x

vads_recurrence_number n..2 Número da parcela da assinatura. x

vads_recurrence_status enum Status da criação de uma recorrência.

vads_sub_amount

n..12

Valor das parcelas da assinaturapara todas as prestações, salvoas que podem ser definidas porvads_sub_init_amount_number

x

vads_sub_currencyn3

Código numérico da moeda a ser usada paraa assinatura, segundo a norma ISO 4217.

x x

vads_sub_descans..255

Regra de recorrência a ser aplicada segundoa especificação iCalendar RFC5545.

x x

vads_sub_effect_date n8 Data de inicio da assinatura. x x

vads_sub_init_amountn..12

Valor das parcelas da assinatura para asprimeiras parcelas.

x x

vads_sub_init_amount_numbern..3

Quantidade de parcelas pelas quaiso valor terá que ser aplicadovads_sub_init_amount.

x x

vads_subscription ans..50 Identificador da assinatura a ser criada. x x

Tabela 36 : Lista dos parâmetros - Informação sobre a assinatura



signature

Descrição Parâmetro obrigatório.

Permite verificar a integridade das solicitações enviadas.

Se o valor for calculado:

• pelo site de e-commerce durante a solicitação de pagamento

• pela plataforma de pagamento na resposta

Campo de entrada e de saída, retornado na resposta (IPN e URL de retorno).

Formato ano40

Código de erro 00 - signature quando o valor deste campo não estiver correto.

70-empty params se o campo estiver ausente ou se ele for enviado vazio.

Erros frequentes:

• Os diferentes campos do formulário não foram codificados em UFT8.

• O MODO (teste ou produção) ou a chave usada é incorreto.

• Voltar para a linha e/ou tecla "enter" enviados no formulário.

• Símbolo aspas ["] enviado no formulário.

• O tipo de algoritmo de cálculo usado não está certo.

• A assinatura enviada não está conforme à regra do cálculo da assinatura.

Categoria Informações técnicas.

vads_acquirer_transient_data

Descrição Permite enviar informações específicas para uma ou mais redes.

Campo de entrada

Formato json

Valores possíveis Pour VisaNet Perú, le format attendu est :

vads_acquirer_transient_data ={"VISANET":{"field91": "100018211", "field92":"Lyra Peru", "field93": "specific data"}}

Les clés doivent être nommées de "field1" à "field99".

Une erreur sera renvoyée si le contenu saisi n'est pas au format JSON ou nerespecte pas les attentes de VisaNet.

Códigos de erros 130, 133, 134, 135, 136, 137

Categoria Informações sobre a transação.



vads_action_mode


Modo de aquisição das informações do cartão.


Formato enum

Código de erro 47

Valores possíveis INTERACTIVE: digitação das informações do cartão na página da plataforma depagamento.

SILENT: digitação das informações do cartão no site de e-commerce (submetido àopção comercial fornecida pelo seu banco).

IFRAME: digitação das informações do cartão na página de pagamento simplificadaque o vendedor pode incorporar na página web de sua escolha.


vads_amount

Descrição Valor da transação apresentado na menor unidade da moeda.

Exemplo: para uma transação de 10, o 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).


Formato n..12

Código de erro 09


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.



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.


vads_auth_number

Descrição Número de autorização devolvido pelo servidor do banco, se disponível (se nãovazio).


Formato an..6




vads_auth_result

Descrição Código retorno da solicitação de autorização devolvida pelo banco emissor, sedisponível.


Formato n..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 37 : Códigos retornados pelo adquirente Amex Global

Código Descrição Rechamada autorizada

1 Transação não autorizada. Transação referida.

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.


89 Erro na transaçã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.



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 38 : 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

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 comerciante)

28 Arquivo está temporariamente indisponível E6 Recusada (Inconsistência / Valor inválido / outras deregras de negócio)


E7 Recusada (status de transação não permite a operaçãosolicitada)


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 39 : Códigos retornados pelo adquirente Elavon

Código Descrição

0 Aprovado

1 Entrar em contato com emissor

3 Estabelecimento invalido

5 Não autorizada pelo emissor

12 Transação inválida ou não habilitada para o estabelecimento

13 Valor inválido para transação

14 Cartão não suportado

19 Tente novamente

22 Entrar em contato com a first data

23 Transação parcelada não permitida

24 Transação digitada não permitida

30 Data da transação invalida

35 Terminal invalido

41 Reter cartao

43 Reter cartao. Perdido ou furtado

51 Saldo insuficiente

54 Cartao expirado

55 Senha invalida

58 Estabelecimento não habilitado

61 Limite do cartao excedido

62 Cartao bloqueado

65 Excedido numero de transacoes

79 Data de transação inválida



Código Descrição

80 Emissor indisponivel

82 Pre-autorizacao noa encontrada

91 Sem resposta do emissor

93 Transacao noa encontrada

94 Transacao duplicada

96 Entrar em contato com a first data

9998 O certificado usado pode estar expirado

Tabela 40 : Códigos retornados pelo adquirente FirstData

Código Descrição Código Descrição

1 Transacao referida. Solicite ao cliente contatar oemissor

N5 Transacao nao aprovada. Solicite ao cliente contatar oemissor

2 Transacao referida. Solicite ao cliente contatar oemissor


3 Estabelecimento invalido N7 Cvv2 invalido

4 Transacao nao aprovada. Solicite ao clientecontatar o emissor




6 Erro no processamento O0 Sistema do emissor indisponivel. Tente novamente

8 Transacao aprovada sob identificacao O1 Sistema do emissor indisponivel. Tente novamente

10 Transacao nao autorizada O2 Valor invalido. Tente novamente

12 Transacao invalida O3 Transacao nao aprovada. Solicite ao cliente contatar oemissor

13 Valor da transacao invalido O4 Transacao nao aprovada. Solicite ao cliente contatar oemissor

14 Cartao invalido O5 Senha invalida. Tente novamente

15 Cartao nao pertence a rede getnet O6 Numero do cartao invalido

19 Emissor temporariamente fora de operacao O7 Transacao nao aprovada. Solicite ao cliente contatar oemissor

23 Cartao excedeu o limite para parcelamento O8 Transacao nao aprovada. Solicite ao cliente contatar oemissor

27 Transacao nao permitida p/ produto. Ligue getnet O9 Solicite ao cliente contatar o emissor

28 Quantidade de parcelas nao 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 nao pertence a rede getnet P2 Solicite ao cliente contatar o emissor





38 Excedido numero de tentativas do pin P5 Solicite ao cliente contatar o emissor

41 Cartao extraviado P6 Solicite ao cliente contatar o emissor

43 Transacao nao autorizada. Solicite ao clientecontatar o emissor

P7 Valor invalido. Tente novamente


P8 Numero do cartao invalido

54 Cartao vencido P9 Limite de saque excedido

55 Senha incorreta Q0 Transacao nao completada. Tente novamente

56 Erro nos dados informados Q1 Transacao nao completada. Tente novamente

57 Transacao nao permitida. Solicite ao clientecontatar o emissor

Q2 Transacao nao completada. Tente novamente

58 Transacao nao permitida. Entre em contato coma getnet

Q3 Transacao nao aprovada. Solicite ao cliente contatar oemissor

61 Limite de retirada excedido Q4 Transacao nao aprovada. Solicite ao cliente contatar oemissor




62 Cartao restrito Q5 Transacao nao aprovada. Solicite ao cliente contatar oemissor

64 Parcelado nao permitido para cartao Q6 Transacao nao aprovada. Solicite ao cliente contatar oemissor

65 Quantidade de saques excedida Q7 Transacao nao aprovada. Solicite ao cliente contatar oemissor

68 Transacao nao completada. Tente novamente(time out)

Q8 Transacao nao aprovada. Solicite ao cliente contatar oemissor

75 Senha bloqueada Q9 Transacao nao aprovada. Solicite ao cliente contatar oemissor

76 Cartao bloqueado R6 Transacao nao aprovada. Solicite ao cliente contatar oemissor


R7 Transacao nao aprovada. Solicite ao cliente contatar oemissor

82 Cvv invalido. R8 Transacao nao aprovada. Solicite ao cliente contatar oemissor

84 Numero do cartao invalido S4 Solicite ao cliente contatar o emissor

85 Sistema do emissor indisponivel. Tentenovamente

S8 Solicite ao cliente contatar o emissor

86 Transacao nao completada. Tente novamente S9 Solicite ao cliente contatar o emissor

87 Transacao nao completada. Tente novamente T0 Produto não habilitado

88 Sistema do emissor indisponivel. Tentenovamente

T1 Valor invalido. Tente novamente

89 Bandeira nao pertence a rede getnet T2 Erro nos dados informados. Tente novamente

94 Transmissao duplicada. Tente novamente T3 Cartao nao pertence a rede getnet

N0 Sistema do emissor indisponivel. Ligue emissor T4 Solicite ao cliente contatar o emissor

N1 Numero do cartao invalido T5 Transacao nao aprovada. Solicite ao cliente contatar oemissor

N2 Limite de saque excedido T6 Solicite ao cliente contatar o emissor

N3 Transacao nao aprovada. Solicite ao clientecontatar o emissor

T7 Transacao nao aprovada. Solicite ao cliente contatar oemissor

N4 Transacao nao aprovada. Solicite ao clientecontatar o emissor

T8 Cartao invalido

Tabela 41 : Códigos retornados pelo adquirente GetNet


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 42 : Códigos retornados pelo adquirente Global Payments


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)

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 43 : Códigos retornados pelo adquirente Rede (e.rede)


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.


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.


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.


50 Transação não autorizada 89 Transação não autorizada

51 Estabelecimento Inválido 90 Transação não autorizada


53 Transação Inválida 92 Estabelecimento Inválido



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 44 : Códigos retornados pelo adquirente Rede (komerci)


1000 Não aprovado 2001 Cartão vencido

1001 Cartão vencido 2002 Suspeita de fraude

1002 Suspeita de fraude 2003 Estabelecimento entrar em contato com emissor

1003 Estabelecimento entrar em contato com emissor 2004 Cartão com restrição

1004 Cartão com restrição 2005 Estabelecimento entrar em contato comdepartamento de segurança do adquirente

1005 Estabelecimento entrar em contato comdepartamento de segurança do adquirente

2006 Tentativas de senha excedidas

1006 Tentativas de senha excedidas 2007 Condições especiais

1007 Consultar o emissor 2008 Cartão perdido

1008 Consultar as condições especiais do emissor 2009 Cartão roubado

1009 Estabelecimento inválido 2010 Suspeita de cartão falso

1010 Valor inválido 2011 Limite de quantidade de saques excedido

1011 Cartão inválido 2012 Limite de valor para saque excedido

1012 Senha necessária 9100 Erro no formato da mensagem

1014 Nenhuma conta do tipo selecionado 9102 Transação inválida

1015 Função selecionada não suportada 9103 Tente novamente

1016 Saldo insuficiente 9105 Adquirente não suportado pelo switch

1017 Senha inválida 9107 Emissor fora de operação

1019 Transação não permitida para o portador 9108 Não foi possível enviar a transação para o destinatário

1020 Transação não permitida para o terminal 9109 Erro no sistema

1021 Limite de valor para saque excedido 9110 Emissor se desconectou

1022 Violação de segurança 9111 Emissor não respondeu em tempo

1023 Limite de quantidade de saques excedido 9112 Emissor indisponível

1024 Violação da lei 9113 Transmissão duplicada

1025 Cartão bloqueado 9114 Não foi possível encontrar a transação original

1026 Dados de senha inválidos 9116 MAC incorreto

1027 Erro no tamanho da senha 9117 Erro de sincronização de chave de MAC

1028 Erro de sincronia de chave de senha 9118 Nenhuma chave de comunicação disponível

1029 Suspeita de cartão falso 9119 Erro de sincronização de chave de encriptação

1030 Moeda inaceitável para o emissor 9120 Erro de segurança de software/hardware, tentenovamente

1032 Cartão perdido ou roubado 9121 Erro de segurança de software/hardware

1035 Conta encerrada 9122 Número da mensagem fora de sequência

1036 Conta poupança encerrada ou bloqueada paraencerramento

9123 Requisição em progresso

1037 Conta de crédito encerrada ou bloqueada paraencerramento

9124 Código de segurança inválido

1039 Conta corrente encerrada ou bloquada paraencerramento

9125 Erro no banco de dados

1041 Status ruim para conta de origem 9132 Erro nos dados de recorrência

1042 Status ruim para conta de destino 9133 Atualização não permitida

1045 Código de segurança inválido 9350 Violação de acordo comercial

1047 Troca de senha necessária 9999 Erro não especificado

1048 Nova senha inválida DPMG Mensagem Duplicada – Esta mensagem já foi recebidapela Stone.




1057 Data de pagamento inválida IMSG Mensagem Invalida – A mensagem enviada possui umformato inválido.

1060 Transação não completou normalmente no terminal INTP SAK Invalido – O SAK enviado não foi reconhecido

1061 Transação não suportada pelo emissor MSGT Tipo da Mensagem – o Message Type enviado não éreconhecido.

1062 Saque fácil não disponível PARS Erro na leitura da mensagem – Algum campoobrigatório não esta sendo enviado

1063 Limite de saque fácil excedido RCPP Destinatario Invalido – O local para aonde amensagem foi enviada esta invalida

1064 Negado offline pelo terminal SECU Segurança – Algum erro no processo de segurança.A chave de criptografia pode não estar presente noterminal.

1065 Negado, não foi possível processar offline UNPR Não Foi possível processar – Não foi possível processara mensagem. Tente novamente.

2000 Não aprovado VERS Protocolo – A versão do protocolo enviada não ésuportada.

Tabela 45 : Códigos retornados pelo adquirente Stone

Código Descrição

1 sucesso

2 em andamento na Khipu

3 falha

400 outros tipos de falha na Khipu

Tabela 46 : Códigos de retorno autorização do adquirente Khipu

Código Descrição

0 Transacción aprobada.

-1 Rechazo de transacción.

-2 Transacción debe reintentarse.

-3 Error en transacción.

-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 47 : Códigos de retorno autorização do adquirente TransBank


00 Aprobado 54 Tarjeta Expirada

01 Llame al Emisor 55 PIN Invalido

03 Estab. Errado 57 Txn. Invalida

04 Retener Tarjeta 58 Txn. No Permitida

05 Denegado 61 Exc. Monto Retiro

12 Txn. Invalida 62 Tarjeta Restringida

13 Importe Invalido 63 Violacion Seguridad

14 Tarjeta Invalida 65 Excede Nro. Retiro

15 Emisor Invalido 76 Cuenta Invalida

30 Error de Formato 77 Cuenta Inexistente

39 No es Cta. Cred. 78 Cuenta Invalida

41 Tarjeta Perdida 84 Pos Invalido

43 Tarjeta Robada 91 Emis. No Responde

51 Fondos Insuficientes 96 Error de Sistema

Otros Denegado

Tabela 48 : Códigos retornados pelo adquirente Processos




0 Operación Autorizada 409 Operación Denegada. CVV2 no procesado porentidad emisora.

101 Operación Denegada. Tarjeta Vencida. 410 Operación Denegada. CVV2 no procesado porno ingresado.

102 Operación Denegada. Contactar con laentidad emisora.

411 Operación Denegada. CVV2 no procesado porentidad emisora.

104 Operación Denegada. Operación no permitidapara esta tarjeta.

412 Operación Denegada. CVV2 no reconocido porentidad emisora.

106 Operación Denegada. Exceso de intentos deingreso de clave secreta.

413 Operación Denegada. Contactar con entidademisora.

107 Operación Denegada. Contactar con laentidad emisora.

414 Operación Denegada.

108 Operación Denegada. Exceso de actividad. 415 Operación Denegada.

109 Operación Denegada. Identificación inválidade establecimiento.




111 Operación Denegada. El monto de latransacción supera el valor máximo permitidopara operaciones virtuales


112 Operación Denegada. Se requiere clavesecreta.


116 Operación Denegada. Fondos insuficientes. 420 Operación Denegada. Tarjeta no es VISA.

117 Operación Denegada. Clave secretaincorrecta.


118 Operación Denegada. Tarjeta inválida. 422 Operación Denegada. El comercio no estáconfigurado para usar este medio de pago.


423 Operación Denegada. Se canceló el proceso depago.

121 Operación Denegada. 424 Operación Denegada. Contactar con entidademisora.

126 Operación Denegada. Clave secreta inválida. 666 Operación Denegada. Problemas decomunicación. Intente más tarde.

129 Operación Denegada. Tarjeta no operativa. 667 Operación Denegada. Transacción sinautenticación. Inicio del Proceso de Pago

180 Operación Denegada. Tarjeta inválida. 668 Operación Denegada.

181 Operación Denegada. Tarjeta con restriccionesde Débito.


182 Operación Denegada. Tarjeta con restriccionesde Crédito.

670 Operación Denegada. Módulo antifraude.

183 Operación Denegada. Error de sistema. 672 Operación Denegada. Transacción sinrespuesta de Antifraude.


673 Operación Denegada. Transacción sinrespuesta del Autorizador.


674 Operación Denegada. eTicket no válido.


675 Iniciailización de transacción

199 Operación Denegada. 676 Operación Denegada. No activa la opciónRevisar Enviar al Autorizador.

201 Operación Denegada. Tarjeta vencida. 677 Operación Denegada. Respuesta Antifraudecon parámetros nos válidos.


678 Operación Denegada. Valor ECI no válido.


682 Operación Denegada. Intento de Pago fueradel tiempo permitido.


683 Operación Denegada Registro Incorrecto de E-Ticket





684 Operación Denegada Registro IncorrectoAntifraude

208 Operación Denegada. Tarjeta perdida. 685 Operación Denegada Registro IncorrectoAutorizador

209 Operación Denegada. Tarjeta robada. 904 Operación Denegada. Formato de mensajeerróneo.

263 Operación Denegada. Error en el envío deparámetros.

909 Operación Denegada. Error de sistema.

264 Operación Denegada. Entidad emisora no estádisponible para realizar la autenticación.

910 Operación Denegada. Error de sistema.

265 Operación Denegada. Clave secreta deltarjetahabiente incorrecta.

912 Operación Denegada. Entidad emisora nodisponible.

266 Operación Denegada. Tarjeta vencida. 913 Operación Denegada. Transmisión duplicada.

280 Operación Denegada. Clave errónea. 916 Operación Denegada. Contactar con entidademisora.



300 Operación Denegada. Número de pedido delcomercio duplicado. Favor no atender.

940 Operación Denegada. Transacción anuladapreviamente.


941 Operación Denegada. Transacción ya anuladapreviamente.

401 Operación Denegada. Tienda inhabilitada. 942 Operación Denegada.

402 Operación Denegada. 943 Operación Denegada. Datos originalesdistintos.

403 Operación Denegada. Tarjeta no autenticada 945 Operación Denegada. Referencia repetida.

404 Operación Denegada. El monto de latransacción supera el valor máximo permitido.

946 Operación Denegada. Operación de anulaciónen proceso.

405 Operación Denegada. La tarjeta ha superadola cantidad máxima de transacciones en el día.

947 Operación Denegada. Comunicaciónduplicada.

406 Operación Denegada. La tienda ha superado lacantidad máxima de transacciones en el día.


407 Operación Denegada. El monto de latransacción no llega al mínimo permitido.


408 Operación Denegada. CVV2 no coincide. 965 Operación Denegada. Contactar con entidademisora.

Tabela 49 : 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.




vads_authent_paypal_protection_eligibility

Descrição Tipo de proteção dos vendedores vigente para a transação.

Três valores possíveis:

• ELIGIBLE

O vendedor está protegido pelo regulamento sobre a Proteção dos VendedoresPayPal para os pagamentos não autorizados e os objetos não recebidos.

• PARTIALLY_ELIGIBLE

O vendedor está protegido pelo regulamento sobre a Proteção dos VendedoresPayPal para os objetos não recebidos.

• INELIGIBLE

O vendedor não está protegido pelo regulamento sobre a Proteção dosVendedores PayPal.

Específico ao meio de pagamento PayPal.


Formato enum

Categoria Informações sobre o pedido.



vads_available_languages

Descrição Permite especificar os idiomas disponíveis na página de pagamento sob a forma delista.

Cada elemento da lista deve estar separado por um ponto e virgula ( ; )).

Está exibido com bandeiras na página de pagamento.


Formato idioma1;idioma2;idioma3

Código de erro 71

Valores possíveis Idioma Valor Bandeira exibida por padrão

Alemão de x

Inglês en x

Chinês zh x

Espanhol es x

Francês fr x

Italiano it x

Japonês ja x

Holandês nl x

Polonês pl

Português pt x

Russo ru x

Sueco sv x

Turco tr x

Exemplo: para exibir as bandeiras dos idiomas português e inglês, é preciso postarvads_available_languages=fr;en

Categoria Personalização da página de pagamento.

vads_avs_result

Descrição Envia o resultado da verificação de endereço realizada pelo adquirente.

Esta verificação é feita somente sobre a parte numérica do endereço de faturação.

AAddress Verification Service é ativa nos Estados-Unidos, no Canadá e no Reino-unido.


Formato a1

Valores possíveis Código Visa MasterCard Discover American Express

Y Address & 5-digit or 9-digit ZIPmatch

Address & 5-digitZIP match

Address onlymatches

Address & ZIPmatch

A Address matches,ZIP does not

Address matches,ZIP does not


Address onlymatches

S AVS notsupported

AVS notsupported

AVS notsupported

AVS notsupported

R Systemunavailable,rerowy

Systemunavailable,rerowy

Not applicable Systemunavailable,rerowy



Código Visa MasterCard Discover American Express

U Information notavailable

Information notavailable

Systemunavailable,rerowy


Z Either 5-digit or9-digit ZIP match,address does not

5-digit ZIPmatches, addressdoes not

5-digit ZIPmatches, addressdoes not

ZIP code onlymatches

N Neither ZIP noraddress match

Neither ZIP noraddress match



W Not applicable For U.S., 9-digitZIP matches,address does not.For non-U.S., ZIPmatches, addressdoes not


Not applicable

X Not applicable For U.S., all digitsmatch. For non-U.S., ZIP andaddress match.


Not applicable

B Address matches,ZIP not verified

Not applicable Not applicable Not applicable

T Not applicable Not applicable 9-digit ZIPmatches, addressdoes not

Not applicable

P ZIP matches,address notverified


C Address and ZIPnot verified


D Address &ZIP match(Internationalonly)


G Address notverified forInternationalrowansaction(Internationalonly)


I Addressnot verified(Internationalonly)


M Address &ZIP match(Internationalonly)


F Address & ZIPmatch (UK only)





vads_bank_code

Descrição Código banco associado ao banco emissor.


Formato n5

Categoria Informações sobre o meio de pagamento.

vads_bank_product

Descrição Código produto do cartão usado para o pagamento.


Formato an..3

Valores possíveis

VISA Designação

A Visa Traditional

B Visa Traditional Rewards

C Visa Signature

D Visa Signature Preferred

E Proprietary ATM

F Visa Classic

G Visa Business

G1 Visa Signature Business

G2 Reserved

G3 Visa Business Enhanced

H Reserved

I Visa Infinite

J Reserved

J1 Reserved

J2 Reserved

J3 Visa Healthcare

J4 Reserved

K Visa Corporate T&E

K1 Visa GSA Corporate T&E

L Electron

N Visa Platinium

N1 TBA

P Visa Gold

Q Private Label

Q1 Reserved

R Proprietary

S Visa Purchasing

S1 Visa Purchasing

S2 Visa Purchasing

S3 Visa Purchasing

S4 Government Services Loan

S5 Commercial Transport EBT

S6 Business Loan

S7 Visa Distribution

T Reserved



VISA Designação

U Visa TravelMoney

V Visa VPay

W Reserved

X Reserved

Y Reserved

Z Reserved



MASTERCARD Designação

MPN MASTERCARD PREPAID DEBIT STANDARD-INSURANCE

MPO MASTERCARD PREPAID DEBIT STANDARD-OTHER

MPP MASTERCARD PREPAID CARD

MPR MASTERCARD PREPAID DEBIT STANDARD-TRAVEL

MPT MASTERCARD PREPAID DEBIT STANDARD-TEEN

MPV MASTERCARD PREPAID DEBIT STANDARD-VERNMENT

MPW DEBIT MASTERCARD BUSINESS CARD PREPAID WORK B2B

MPX MASTERCARD PREPAID DEBIT STANDARD-FLEX BENEFIT

MPY MASTERCARD PREPAID DEB STANDARD-EMPLOYEE INCENTIVE

MRG MASTERCARD PREPAID CARD

MRH MASTERCARD UNKNOWN PRODUCT

MRW PREPAID MASTERCARD BUSINESS CARD

MSG PREPAID MAESTRO CONSUMER RELOADABLE CARD

MSI MAESTRO CARD

MWB WORLD MASTERCARD FOR BUSINESS CARD

MWE WORLD ELITE MASTERCARD CARD

DLS DEBIT MASTERCARD CARD-DELAYED DEBIT

MCB MASTERCARD BUSINESSCARD CARD

MCC MASTERCARD CREDIT CARD (MIXED BIN)

MVOIR MASTERCARD FLEET CARD

MCG LD MASTERCARD CARD

MCO MASTERCARD CORPORATE CARD

MCP MASTERCARD PURCHASING CARD

MCS STANDARD MASTERCARD CARD

MCW WORLD MASTERCARD CARD

MDG LD DEBIT MASTERCARD CARD

MDH WORLD DEBIT EMBOSSED MASTERCARD CARD

MDP PLATINUM DEBIT MASTERCARD CARD

MDS DEBIT MASTERCARD CARD

MIU DEBIT MASTERCARD UNEMBOSSED

MNW MASTERCARD WORLD CARD

MOC MASTERCARD UNKNOWN PRODUCT

MPG DEBIT MASTERCARD STANDARD PREPAID-GENERAL SPEND

MPC MASTERCARD PROFESSIONAL CARD

MPL PLATINUM MASTERCARD CARD

MPP MASTERCARD PREPAID CARD

MRG MASTERCARD PREPAID CARD

MRO MASTERCARD REWARDS ONLY

MRW PREPAID MASTERCARD BUSINESS CARD

MSB MAESTRO SMALL BUSINESS CARD

MSI MAESTRO CARD

MSO MAESTRO PREPAID OTHER CARD

MSW PREPAID MAESTRO CORPORATE CARD

OLS MAESTRO-DELAYED DEBIT

TCB MASTERCARD BUSINESS CARD-IMMEDIATE DEBIT

TCC MASTERCARD (MIXED BIN)-IMMEDIATE DEBIT

TCG LD MASTERCARD CARD-IMMEDIATE DEBIT

TCS MASTERCARD STANDARD CARD-IMMEDIATE DEBIT

TCW WORLD SIGNIA MASTERCARD CARD-IMMEDIATE DEBIT

TIU MASTERCARD UNEMBOSSED — IMMEDIATE DEBIT

TNW MASTERCARD NEW WORLD-IMMEDIATE DEBIT

TPL PLATINUM MASTERCARD-IMMEDIATE DEBIT



MASTERCARD Designação

WBE MASTERCARD UNKNOWN PRODUCT


vads_birth_day

Descrição Data de nascimento do portador.

Campo de entrada

Formato n..2

Código de erro 76


vads_birth_month

Descrição Mês de nascimento do portador.

Campo de entrada

Formato n..2

Código de erro 76


vads_birth_year

Descrição Ano de nascimento do portador.

Campo de entrada

Formato n4

Código de erro 76


vads_brand_management

Descrição Informa o vendedor:

• se o comprador usou uma outra marca que a marca definida por padrão pelovendedor (atributo userChoice),

• a marca escolhida pelo comprador (atributo brand),

• a lista das marcas disponíveis (atributo brandList).


Formato json

Valores possíveis Exemplo:

vads_brand_management={"userChoice":true,"brand":"CB","brandList":"CB|VISA"}




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 Officeserá usado. Este último pode ser configurado no Back Office por todas as pessoasdevidamente 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


vads_card_brand

Descrição Meio de pagamento usado, se disponível (se não vazio).

O valor é procedente dos arquivos de classificação BIN.


Formato an..127

Valores possíveis Consultar o parâmetro vads_payment_cards.


vads_card_country

Descrição Código país do cartão usado para o pagamento segundo a norma ISO 3166.


Formato ISO 3166


vads_card_holder_name

Descrição Este campo corresponde ao sobrenome do portador do cartão.

Na América Latina, este parâmetro é obrigatório para DECIDIR e VISANET.

Campo de entrada

Formato ans..255

Código de erro 45




vads_card_number

Descrição Na solicitação de pagamento

Número de cartão em claro (caso do pagamento silencioso).

Na resposta:

• 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.


Formato an..36

Código de erro 40


vads_change_rate

Descrição Taxa de cambio usada para calcular o valor real do pagamento (para um pagamentomulti-moeda).


Formato string




vads_contracts

Descrição Permite:

• especificar, para cada rede de aceitação, o contrato vendedor a ser usado soba forma de lista,

• excluir uma rede.

Este parâmetro é facultativo e é útil somente se você possuir vários contratosna mesma rede e se você desejar trocar eles dinamicamente em função dopagamento.

Se este parâmetro não for informado ou ausente, o pagamento será realizado como(s) contrato(s) vendedor conforme a ordem de prioridade definida no Back Office(Menu Configuração > Loja > aba Contratos).

Campo de entrada.

Formato map

Código de erro 62

Valores possíveis Para excluir uma rede, é preciso usar a sintaxe nome_de_rede=NO

Exemplo: REDE1=contrato1;REDE2=contrato2;REDE3=NO

As diferentes redes possíveis são:

Código Rede Descrição

AMEX Rede American Express

AMEXGLOBAL Rede American Express

BOLETO Rede Boleto Bancário

ITAU_IB Rede Itaú (Boleto e Internet Bancking)

CIELO Rede CIELO

CIELOV3 Rede CIELO

DECIDIR Rede Decidir

ELAVONBR Rede Elavon

EVO Rede EVO

FIRSTDATA_IPG Rede FirstData - API IPG

FIRSTDATABR Rede FirstData

FIRSTDATALAT Rede FirstData

GETNET Rede GETNET

GLOBAL_PAYMENTS Rede GLOBAL PAYMENTS

JCB Rede JCB

KHIPU Rede Khipu

MASTERPASS Rede MasterPass

PAYPAL Rede PayPal

PAYPAL_SB Rede PayPal - modo sandbox

PROCESOS Rede Procesos

PROCESOS_WS Rede Procesos - Pagamentos recorrentes

REDE Rede Rede

REDECARD Rede Redecard

STONE Rede Stone

VISANET Rede VISANET

WEBPAY Rede WEBPAY

WEBPAY_COMPLETA Rede WEBPAY Completa

WEBPAY_NORMAL Rede WEBPAY Normal



Exemplo para forçar o contrato a ser usado:

vads_contracts="STONE=12312318;CIELOV3=1324657"

vads_contracts="VISANET=123123129;PRISMA=13246578"

Exemplo para proibir o pagamento em uma rede específica:

vads_contracts="STONE=12312318;CIELOV3=NO"

vads_contracts="VISANET=123123129;PRISMA=NO"


vads_contract_used

Descrição Este campo estabelece o valor do contrato associado à transação. É informado pelocontrato salvo por padrão na sua loja ou toma o valor do campo vads_contractspassado na solicitação de pagamento.


Formato ans..250


vads_contrib

Descrição Informação complementar facultativa destinada a mencionar o nome dacontribuição usada durante o pagamento (Joomla, osCommerce...). Se você usaruma implementação proprietária, este campo pode receber seu número de loteinterno do módulo que você desenvolveu, por exemplo.


Formato ans..128

Código de erro 31




vads_ctx_mode


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 esta 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.


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




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.


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


vads_cust_address

Descrição Endereço postal do comprador.

Observação

O endereço é obrigatório se o cliente tiver uma conta bancária nos locais, territóriosou países seguintes: Suíça, Mônaco, São-Marino, Maiote, São-Pedro e Miquelão,Guernsey, Jersey, Ilha de Man.


Formato ans..255

Observação: Os símbolos > e < não são autorizados.

Código de erro 19

Observação: Parâmetro obrigatório para 3xCB Cofinoga.

Categoria Informações sobre o comprador.

vads_cust_address2

Descrição Segunda linha do endereço.


Formato ans..255

Código de erro 19




vads_cust_address_number

Descrição Número de rua do comprador.


Formato ans..64

Código de erro 112


vads_cust_cell_phone

Descrição Número de telefone celular do comprador.


Formato an..32

Código de erro 77


vads_cust_city

Descrição Cidade do comprador


Formato an..128

Código de erro 21



vads_cust_country

Descrição Permite especificar o código do país do comprador segundo a norma ISO 3166.


Formato a2

Código de erro 22

Exemplos devalores possíveis

Código País Código País

AT Áustria IN Índia

BR Brasil MQ Martinica

CI Costa do Marfim NC Nova-Caledônia

FR Corsega PF Polinésia Francesa

FR França PM São Pedro e Miquelão

GP Guadalupe US Estados Unidos das Américas



vads_cust_district

Descrição Bairro do comprador


Formato ans..127

Código de erro 113


vads_cust_email

Descrição Endereço e-mail do comprador, necessário se você deseja que a plataforma depagamento envie um e-mail para o comprador.

Para que o comprador receba um e-mail, não esqueça de postar este parâmetrono formulário quando você gerar uma solicitação de pagamento.


Formato ans..150

Código de erro 15


vads_cust_first_name

Descrição Nome do comprador


Formato ans..63

Código de erro 104



vads_cust_id

Descrição Código do comprado para o vendedor.


Formato an..63

Código de erro 16


vads_cust_last_name

Descrição Sobrenome do comprador.


Formato ans..63



Código de erro 105

Observação Parâmetro obrigatório para 3xCB Cofinoga.




vads_cust_legal_name

Descrição Razão social do comprador.


Formato an..100

Código de erro 121


vads_cust_name

Descrição Sobrenome do comprador.

Este campo esta desvalorizado. Ele foi substituído pelos camposvads_cust_first_name e vads_cust_last_name


Formato an..127

Código de erro 18


vads_cust_national_id

Descrição CPF/CNPJ

Possibilita identificar de maneira única cada cidadão dentro de um país.

Por exemplo, no Brasil, ClearSale impõe que este campo seja informado com o CPF/CNPJ (formato numérico, de 11 até 20 dígitos.


Formato ans..255

Código de erro 124


vads_cust_phone

Descrição Número de telefone do comprador.


Formato an..32

Código de erro 23



vads_cust_state

Descrição UF / Região do comprador




Formato ans..127

Código de erro 88




vads_cust_status

Descrição Tipo de comprador


Formato enum

Código de erro 92

Valores possíveis PRIVATE, COMPANY


vads_cust_title

Descrição Estado civil do comprador (Exemplo Sr., Sra., Srta.).


Formato an..63

Código de erro 17



vads_cust_zip

Descrição CEP do comprado.


Formato an..64

Código de erro 20



vads_cvv

Descrição Na solicitação de pagamento:

Código de segurança do cartão (caso do pagamento silencioso).

Na resposta:

Código de segurança oculto.

O comprimento dele pode variar entre 3 ou 4 dígitos em função do tipo de cartão.

Campo de entrada.

Formato n..4

Código de erro 43




vads_effective_amount

Descrição Valor do pagamento na moeda efetivamente usada para a captura no banco.


Formato n..12

Exemplos EXEMPLO PARA UMA LOJA NA QUAL A CAPTURA É EFETUADA EM BRL

Pagamento de 10,00 BRL

Parâmetros enviados no formulário de pagamento

• vads_amount = 1000

• vads_currency = 986

Parâmetros devolvidos



• vads_effective_amount = 1000

Pagamento de 10 dólares americanos




Parâmetros devolvidos



• vads_change_rate= 1.3118 (taxa usada)

• vads_effective_amount = 762 (vads_amount / vads_change_rate)

Pagamento múltiplo 90,00 BRL em 3 vezes




• vads_payment_config=MULTI_EXT:data1=3000;data2=2000;data3=4000

Parâmetros devolvidos para a primeira parcela



• vads_effective_amount = 3000



Pagamento múltiplo 90 dólares americanos em 3 vezes




• vads_payment_config=MULTI_EXT:20121025=3000;20121026=2000;20121027=4000

Parâmetros devolvidos para a primeira parcela



• vads_change_rate= 1.3118 (taxa usada)

• vads_effective_amount = 2287 (valor 1a parcela 30$ / vads_change_rate)


vads_effective_creation_date

Descrição Data de registro da transação, no fuso UTC (ou GNT+0) ao formato horário 24h(AAAAMMJJHHMMSS).


Formato n14


vads_effective_currency

Descrição Moeda usada para a captura no banco.

Campo de entrada, retornado na resposta (IPN e URL de retorno).

Formato n3




vads_expiry_month

Descrição Mês de vencimento do cartão usado para o pagamento.


Formato n..2

Código de erro 41


vads_expiry_year

Descrição Ano de vencimento do cartão usado para o pagamento.


Formato n4

Código de erro 42


vads_ext_info

Descrição Permite ao vendedor acrescentar dados adicionais no formulário de pagamento

Estas informações constarão:

• no Back Office, no detalhe da transação (aba Extras)

• nos dados enviados ao site de e-commerce quando voltar à loja

• nos dados enviados ao site de e-commerce durante a IPN

• por padrão no e-mail de confirmação de pagamento para o vendedor.

• no e-mail de confirmação de pagamento para o vendedor se você especificar aregra de notificação nas configurações.

Sintaxe obrigatória:

Vads_ext_info_onomedocampo=valeur


Formato ans

Código de erro 91


vads_ext_info_bil_address_complement

Descrição Exclusivo para o Brasil e ao analisador de fraude ClearSale.

Permite acrescentar um complemento de endereço para o faturamento.

Campo de entrada.

Formato ans..250



vads_ext_info_bil_date_of_birth


Permite acrescentar na fatura a data de nascimento do comprador.

Formato : yyyy-mm-ddThh:mm:ss)

Campo de entrada.

Formato Datetime


vads_ext_info_bil_gender


Permite mencionar na fatura se o comprador for um homem ou uma mulher.

Campo de entrada.

Formato n1


vads_ext_info_deadline


Permite indicar o prazo de entrega em dia (D dias).

Campo de entrada.

Formato n

Categoria Informações sobre a entrega.

vads_ext_info_donation

Descrição Parâmetro retornado somente para a url de notificação instantânea (tambémchamada IPN) em caso de doação.

Valor da doação expressa na menor unidade da moeda .


Formato n..12

Categoria Informação sobre as transações de doação.

vads_ext_info_donation_recipient


Identificador HelloAsso da associação que recebeu a doação.




Formato n..20




vads_ext_info_donation_recipient_name


Nome da associação que recebeu a doação.


Formato string


vads_ext_info_donation_merchant


Identificador da associação que recebeu a doação.


Formato n8


vads_ext_info_donation_contribution


Valor da doação expresso na menor unidade da moeda .


Formato n..12


vads_ext_info_fingerprint_id


Identificador único de sessão.

• Ou este código de sessão é gerado pela plataforma.

Neste caso, este parâmetro não deve ser informado.

• Ou este código de sessão é 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.

Formato string



Codificado em 128 octetos, pode conter maiúsculas ou minúsculas, números ouhífen ([A-Z] [a-z], 0-9, _, -).


vads_ext_info_ship_address_complement


Permite acrescentar um complemento de endereço para a entrega.

Campo de entrada.

Formato ans..250




vads_ext_info_ship_date_of_birth


Permite indicar para a entrega a data de nascimento do comprador.

Campo de entrada.

Formato Datetime


vads_ext_info_ship_gender


Permite mencionar nas informações de entrega se o comprador for um homem ouuma mulher.

Campo de entrada.

Formato n1


vads_ext_trans_id

Descrição Referência externa da transação.

Exemplo: número de transação PayPal, número de reserva Klarna.


Formato ans..20




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












20 Controle de coerência: nenhum país corresponde (país IP, país cartão, país docomprador).


99 Problema técnico servidor durante o tratamento dos controles locais.



vads_first_installment_delay

Descrição Este campo permite especificar de quantos meses a primeira parcela de umpagamento parcelado será adiada quando o adquirente o permite (ex: WebpayCompleta).

O pagamento será recusado e o campo vads_payment_error será valorizado a 171nos casos seguintes:

• o vendedor não é autorizado a adiar os pagamentos

• o valor enviado na solicitação não consta nas opções autorizadas peloadquirente

Campo de entrada.

Formato n..2

Código de erro N/A




vads_hash

Descrição Chave única reenviada somente para a URL de notificação (IPN).


Formato an64


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 é gerado pela plataforma.


• Ou este código é gerado pela 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 códigos deusuários. Toda solicitação de registro contendo um código de usuário jáexistente, será recusada, e será exibido uma mensagem de erro.


Formato ans..50

Código de erro 30

Categoria Informações sobre a assinatura.



vads_identifier_status

Descrição Somente presente se a ação solicitada corresponder à criação ou à atualização deum:

• Token Cartão (assinatura).

• RUM ou referência única de mandato (SEPA)


Formato string

Valores possíveis Valor Descrição


NOT_CREATED A solicitação de autorização foi recusada.O Token Cartão ou RUM não foi criado e não será exibido no Back Office.



ABANDONED O comprador desistiu da ação (devedor).O Token Cartão ou RUM não foi criado e não será exibido no Back Office.


vads_insurance_amount

Descrição Valor do seguro para a totalidade do pedido.


Campo de entrada.

Formato n..12

Código de erro 110


vads_language

Descrição Na solicitação de pagamento:

Definido no mesmo idioma exibido na página de pagamento (norma ISO 639-1).

Se o campo não for enviado ou se ele permanecer vazio na solicitação depagamento, a página de pagamento será exibida no mesmo idioma do navegadordo comprador.

Na resposta:

Devolve o valor especificado no formulário se o comprador não mudou o idiomana página de pagamento.

Devolve o idioma selecionado pelo comprador se ele mudou de idioma na páginade pagamento selecionando uma outra bandeira.


Formato a2



Código de erro 12

Valores possíveis Idioma Codificação ISO 639-1

Alemão de

Inglês en

Chinês zh

Espanhol es

Francês fr

Italiano it

Japonês ja

Holandês nl

Polonês pl

Português pt

Russo ru

Sueco sv

Turco tr

Categoria Personalização da página de pagamento

vads_nb_products

Descrição Permite definir a quantidade de produtos contidos no carrinho.

Observação:

Este campo é obrigatório para que o carrinho seja levado em conta.

Quando preencher este campo, a aba Carrinho será exibida nos detalhes detransação do Back Office.

No entanto, se os outros campos começando por vads_product_ não forempreenchidos, a aba não conterá informação. Por esta razão, ao preenchervads_nb_products, valorizar os outros campos começando por vads_product_passa a ser obrigatório.

Campo de entrada.

Formato n..12


vads_operation_type

Descrição Permite fazer a diferença entre uma operação de débito e uma de crédito(reembolso).


Observação

O campo vads_operation_type não é retornado na resposta quando umpagamento for cancelado ou não finalizado.



Formato enum

Valores possíveis DEBIT, CREDIT




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.


Formato ans..64

Código de erro 13


vads_order_info

Descrição Descrição do pedido.


Formato an..255

Código de erro 14


vads_order_info2



Formato an..255

Código de erro 14


vads_order_info3



Formato an..255

Código de erro 14


vads_override_payment_cinematic

Descrição Parâmetro opcional.

Usado pelo vendedor para transações individuais, para solicitar uma cinemática depagamento diferente da cinemática definida no seu contrato. (campo “Cinemáticade pagamento”)



Campo de entrada.

Observação

Não são todos os contratos que utilizam este parâmetro. Se um valor forselecionado em um contrato que não utiliza o parâmetro, o dado serádesconsiderado e nenhuma mensagem de erro será enviada.

Formato enum

Código de erro 131

Valores possíveis • (vazio)

O valor do contrato é utilizado.

• DIRECT

Valor presente mais não utilizado.

• PRE_AUTO

Valor presente mais não utilizado.

• IMMEDIATE_CAPTURE

Corresponde a uma cinemática de captura imediata: a captura é lançada peloadquirente no dia do pagamento.

• DELAYED_CAPTURE

Corresponde a uma cinemática de captura adiada: a captura é lançada pelaplataforma de pagamento, sempre antes do vencimento da solicitação deautorização.




vads_page_action


Define a operação a ser efetuada.


Formato enum

Código de erro 46

Valores possíveis • PAYMENT

Pagamento (com ou sem Token Cartão)

• REGISTER

Inscrição sem pagamento

• REGISTER_UPDATE

Atualização das informações do meio de pagamento

• REGISTER_PAY

Inscrição com pagamento

• REGISTER_SUBSCRIBE

Inscrição com contratação de uma assinatura

• REGISTER_PAY_SUBSCRIBE

Inscrição com pagamento e contratação de uma assinatura

• SUBSCRIBE

Contratação de uma assinatura

• REGISTER_UPDATE_PAY

Atualização das informações do meio de pagamento com pagamento

• ASK_REGISTER_PAY

Pagamento com inscrição opcional do portador




vads_payment_cards

Descrição Apresenta a lista dos meios de pagamento que serão propostos ao comprador,separados por " ;".

Se a lista tiver somente um meio de pagamento, a página para preencher os dadosdeste meio de pagamento será diretamente exibida. Se não, a página de seleçãodos meios de pagamentos será exibida.

Se este parâmetro estiver vazio (aconselhado) então os meios de pagamentoelegíveis (moedas, obrigações técnicas, etc.) associadas à loja serão propostas.

Observação sobre o meio de pagamento Itau Internet Banking:

Para um pagamento Itau Internet Banking, vads_payment_cards deveobrigatoriamente ter o valor ITAU_IB. Se o parâmetro estiver vazio, o pagamentoserá cancelado.

Campo de entrada.

Formato tipo1;tipo2;tipo3

Código de erro 08

O formulário será recusado nos seguintes casos:

• o valor transmitido não está presente na lista abaixo.

• TODOS, ALL não são valores aceitos. Para oferecer todos os meios de pagamentoeste parâmetro não deve ser enviado ou postado vazio.

• o valor passado não corresponde ao meio de pagamento disponível para sualoja.

• Seu contrato e-commerce foi fechado pelo seu banco. Entrar em contato como serviço de atendimento ao cliente da sua plataforma de pagamento.

• o valor transmitido não está presente na lista abaixo.

Valores possíveisValor Descrição

AMEX American Express

AURA Aura

BOLETO Boleto Bancário

CABAL Carte de crédit Cabal

ELO Elo

DINERS Diners

DISCOVER Discover

HIPERCARD Hipercard

HIPER Hiper

ITAU_BOLETO Boleto Itaú

ITAU_IB Itau Internet Banking

JCB Jcb

MAESTRO Maestro

MASTERCARD MasterCard

SOROCRED Carte de crédit SOROCRED

VISA Visa

VISA_ELECTRON Visa Electron

Tabela 50 : Zona Brasil




vads_payment_certificate

Descrição Este campo é informado pela plataforma de pagamento nos casos de que aautorização foi efetuada com sucesso.


Formato an40




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 (na sua menor unidademonetária).

• « 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.


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:

• 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.




vads_payment_error

Descrição Códigos de erros que podem ser exibidos quando um pagamento for recusado.


Formato n..3

Valores possíveis

Código Mensagem

1 A transação não foi encontrada

2 A transação não foi encontrada

3 Esta ação não está autorizada para uma transação com este status {0}.

4 Esta transação não está autorizada neste contexto.

5 A transação já existe.

6 Valor de transação inválida.

7 Esta ação não for mais possível para uma transação criada nesta data.

8 A data de vencimento do cartão não autoriza esta ação.

9 CVV obrigatório para o cartão.

10 O valor do reembolso é superior ao valor inicial.

11 A soma dos reembolsos efetuados é superior ao valor inicial.

12 A duplicação de um crédito (reembolso) não for autorizado.

13 Devido a um problema técnico, não podemos responder a sua solicitação.




17 A configuração remota do contrato Aurore falhou.

18 A análise da resposta Cetelem falhou.

19 Moeda desconhecida.

20 Tipo de cartão inválido.

21 Nenhum contrato encontrado para este pagamento. Favor mudar os dados ou entrar em contato com seugerente em caso de falhas repetidas.

22 Loja não encontrada.

23 Contrato ambíguo.

24 Contrato inválido.


26 Número de cartão inválido.




30 Número de cartão inválido (Luhn)

31 Número de cartão inválido (comprimento)

32 Número de cartão inválido (não encontrado)

33 Número de cartão inválido (não encontrado)

34 Controle cartão com autorização sistemática falhou.

35 Controle e-Carte Bleue falhou.

36 A transação foi recusada pelo controle dos riscos.

37 Interrupção não gerenciada durante o pagamento.


39 A transação foi recusada pelo 3D Secure.



42 Um erro interno ocorreu durante a consulta do número de cartão.

43 Um erro interno ocorreu durante a consulta do número de cartão.



Código Mensagem

44 Esta ação não é permitida para transações presenciais.

45 Moeda inválida para a modificação.

46 O valor está superior ao valor autorizado.

47 A data de apresentação desejada é posterior à data de validade da autorização.

48 A modificação requerida é inválida.

49 Definição do pagamento múltiplo inválido.

50 Loja desconhecida.

51 Taxa desconhecida.

52 O contrato acabou desde o {0}.

53 A loja {0} fechou desde o {1}.

54 Parâmetro recusado porque pode conter dados sensíveis {0}.


57 Erro na recuperação do Token Cartão.

58 O status do Token Cartão não está compatível com esta operação.

59 Erro na recuperação do Token Cartão.

60 Token Cartão existente.

61 Token Cartão inválido.

62 Criação de Token Cartão recusada.

63 A assinatura já existe.

64 Esta assinatura já foi cancelada.

65 Este assinatura não é válida.

66 A regra de recorrência não é válida.

67 Criação da assinatura recusada.

68 Cancelamento recusado.


70 Código país inválido.

71 Configuração do serviço web inválido.

72 Autorização recusada pela Cofinoga.

73 Autorização de 1 BRL recusada.

74 Configuração de pagamento inválida.

75 A operação foi recusada por PayPal.

76 O nome do portador não consta.


78 Identificador de transação não definido.

79 Código de transação já utilizado.

80 O código de transação venceu.

81 Conteúdo do tema config inválido.

82 O reembolso não está autorizado.

83 Valor de transação fora dos valores permitidos.



88 Reembolso impossível: após 60 dias, PayPal proíbe o reembolso das transações.

89 A modificação não for autorizada.

90 Um erro foi encontrado durante o reembolso desta transação.

91 Nenhuma opção de pagamento ativada para este contrato.

92 Um erro ocorreu durante o cálculo do canal de pagamento.

93 Um erro ocorreu durante o retorno do comprador para a página de finalização de pagamento.

94 Um erro técnico ocorreu.

96 Um erro foi encontrado durante a captura desta transação.

97 Data de apresentação esta distante demais.

98 Data de transação inválida.

99 Um erro ocorreu durante o cálculo da procedência do pagamento.



Código Mensagem

100 Falhar do controle do e-cartão comercial.

101 Recusado porque a primeira parcela foi recusada.

103 A sincronização do status da transação com o sistema externo falhou.

104 Um erro foi encontrado durante a captura desta transação.

105 Um erro de segurança foi encontrado durante o processo 3DS desta transação.

106 Moeda não adequada para este contrato e/ou esta loja.

107 O cartão associado ao Token Cartão não esta mais válido.


109 Prazo de espera excedido quando o comprador foi redirecionado.

110 Cartão de pagamento não adequado para este contrato.

111 Transações sem transferência de responsabilidade recusadas.

112 O cancelamento não está autorizado.

113 A duplicação não está autorizada.

115 O reembolso não está autorizado.

116 Pagamento manual não autorizado para este cartão.

118 Pagamento manual parcelado não autorizado para este cartão.

119 A data submetida é inválida.

120 A opção de pagamento da transação inicial não pode ser aplicada.

124 Cartão inativo.

125 Pagamento recusado pelo comprador.

126 Esta ação é impossível porque a sequência de pagamento não acabou.

128 Meio de pagamento inválido.

129 Código PIN inválido.

130 Saldo esgotado

131 Saldo insuficiente

136 Transações derivadas recusadas, sem transferência de responsabilidade na primeira transação.

137 A transação já existe.

138 O reembolso parcial não for permitido para esta transação.

139 Reembolso recusado.

140 Ocorreu um problema técnico durante o pagamento.

141 O analisador de risco recusou esta transação.

142 O tipo de cartão usado não é válido com o modo de pagamento solicitado.


144 Uma transação em modo produção foi marcada em modo teste pelo adquirente.

145 Uma transação em modo teste foi marcada em modo produção pelo adquirente.

146 Código sms inválido.

147 O módulo de gestão de fraudes solicitou a recusa desta transação.

148 Devido a um problema técnico, não podemos responder a sua solicitação. A transação não foi criada.

149 O tempo limite da sessão de pagamento acabou (caso do comprador redirecionado para o ACS e que nãofinaliza a autenticação 3D Secure).

150 Devido a um problema técnico, não podemos responder a sua solicitação. A transação não foi criada.

151 Uma transação Facily Pay não pode ser cancelada/modificada/reembolsada entre 23h30 e 5h30.


153 Ocorreu uma falha durante a chamada para o serviçoBanque Accord.

155 A transação Facily Pay não pôde ser cancelada/modificada/reembolsada: o status da transação impede realizara ação solicitada. Lembrete sobre uma transação Facily Pay : um reembolso deve aguardar um prazo de doisdias após a captura, o prazo entre dois reembolsos é de um dia, um reembolso parcial é limitado a 20 dias, umreembolso total é limitado a 6 meses.

156 Operação não compatível.


159 O valor é inferior ao valor mínimo autorizado (mínimo={0} {1}).

160 É impossível reembolsar um transação não paga.

164 Opção de pagamento inválida.



Código Mensagem

165 O tipo de documento de identidade está presente, mas não consta seu número.

166 O número de documento de identidade está presente, mas não consta seu tipo.

167 O tipo de documento de identidade é desconhecido.

168 O número de documento de identidade é inválido.

169 Os dados específicos que devem ser enviadas ao adquirente são inválidos.

170 O pagamento adiado não é autorizado.

171 O número de meses para o pagamento adiado não é autorizado.

172 A cinemática de pagamento selecionada é inválida.

173 Erro no serviço Express Checkout de PayPal.

174 Emissor de cartão não disponível.

175 Cancelamento impossível, favor tentar um reembolso.

176 Reembolso impossível, favor tentar um cancelamento.

177 Nenhuma resposta ao pedido de autorização foi recebida dentro do prazo.

178 Cancelamento impossível, a transação já foi cancelada.

179 O status da transação é desconhecido.

182 O CPF/CNPJ do cliente é incorreto.

183 O formato do CPF/CNPJ do cliente é incorreto.


vads_payment_option_code

Descrição Campo específico para um pagamento parcelado. Permite definir a quantidade deparcelas


Formato an..5

Código de erro 103




vads_payment_seq

Descrição Detalhes de transações concluídas.


Formato json

vads_payment_seq (formato json) descreve a sequência do pagamentofracionado. Ele contém os elementos:

• "trans_id": número de transação global da sequência de pagamento.

• "transaction": quadro das transações da sequência. Ele contém os elementos:

Nome doparâmetro

Descrição

amount Valor da seqüência de pagamento.

operation_type Operação de débito.

auth_number Número de autorização. Exemplo: 949478

auth_result Código retorno ao pedido de autorização.

capture_delay Prazo antes da captura (em dias).

• Para um pagamento por cartão bancário, o valor deste parâmetro levaem conta o prazo em número de dias antes da captura no banco. Seeste parâmetro não for enviado no formulário de pagamento, então ovalor padrão definido no Back Office será usado.

card_brand Meio de pagamento usado.

card_number Número do meio de pagamento.

• Para um pagamento por cartão bancário, o número é oculto.

expiry_month Mês de vencimento do meio de pagamento.

expiry_year Ano de vencimento do meio de pagamento.

payment_certificate Certificado de pagamento.

contract_used Contrato usado para o pagamento.

identifier Código único (Token Cartão) associado a um meio de pagamento.

identifier_status Somente presente se a ação solicitada corresponder à criação ou àatualização de um Token Cartão.Valores possíveis:

Valor Descrição


NOT_CREATED A solicitação de autorização foi recusada.O Token Cartão ou RUM não foi criado e não seráexibido no Back Office.



ABANDONED O comprador desistiu da ação (devedor).O Token Cartão ou RUM não foi criado e não seráexibido no Back Office.

presentation_date Para um pagamento por cartão bancário, este parâmetro corresponde àdata de captura desejada no banco (no formato ISO 8601).

trans_id Número da transação.

ext_trans_id Parâmetro ausente para o pagamento por cartão bancário.

trans_uuid Referência única gerada pela plataforma de pagamento após a criação deuma transação de pagamento.Oferece uma garantia de unicidade para cada transação

extra_result Código numérico do resultado dos controles de riscos.



Nome doparâmetro

Descrição

Code Descrição












20 Controle de coerência: nenhum país corresponde (país IP, paíscartão, país do comprador).


99 Problema técnico servidor durante o tratamento dos controleslocais.

sequence_number Número de seqüência.

trans_status Status da transação.

Tabela 51 : Conteúdo do objeto JSON

Observação: as transações canceladas estão também presentes no quadro(informação dada no parâmetro JSONtrans_status).


vads_payment_src

Descrição Permite definir a origem do pagamento.


Formato enum

Código de erro 60


EC E-commerce: pagamento efetuado na página de pagamento.

MOTO MAIL OR TELEPHONE ORDER : pagamento efetuado por um operador decorrentede um pedido por telefone ou e-mail.

CC Call center : pagamento efetuado via um call center.

OTHER Outro: pagamento efetuado em uma outra fonte como por exemplo o Back Office.


vads_pays_ip

Descrição Código país do endereço IP do comprador segundo a norma ISO 3166.


Formato a2




vads_presentation_date

Descrição • Data de captura no banco solicitada.


Formato n14


vads_product_amountN

Descrição Permite definir o valor dos diferentes artigos contidos no carrinho.

N corresponde ao índice do artigo. (0 para o primeiro;1 para o segundo etc.)

O valor será expresso na menor unidade da moeda.

Campo de entrada.

Formato n..12

Código de erro 102




vads_product_labelN

Descrição Permite definir a denominação de cada um dos artigos contidos no carrinho.

N corresponde ao índice do artigo. (0 para o primeiro;1 para o segundo)

Campo de entrada.

Formato ans..255

Código de erro 97


vads_product_qtyN

Descrição Permite definir a quantidade de cada um dos artigos contidos no carrinho.


Campo de entrada.

Formato n..12

Código de erro 101


vads_product_refN

Descrição Permite definir uma referência para cada um dos artigos contidos no carrinho.


Campo de entrada.

Formato an..64

Código de erro 100




vads_product_typeN

Descrição Permite definir o tipo de produto contido no carrinho.


Campo de entrada.

Formato enum

Código de erro 98


FOOD_AND_GROCERY Produtos alimentares e de mercadinho

AUTOMOTIVE Automóvel / Moto

ENTERTAINMENT Lazer / Cultura

HOME_AND_GARDEN Casa e jardim

HOME_APPLIANCE Equipamentos para a casa

AUCTION_AND_GROUP_BUYING Leilões e compras em grupo

FLOWERS_AND_GIFTS Flores e presentes

COMPUTER_AND_SOFTWARE Computadores e softwares

HEALTH_AND_BEAUTY Saúde e beleza

SERVICE_FOR_INDIVIDUAL Serviços para pessoa física

SERVICE_FOR_BUSINESS Serviços para pessoa jurídica

SPORTS Esportes

CLOTHING_AND_ACCESSORIES Roupas e acessórios

TRAVEL Viagem

HOME_AUDIO_PHOTO_VIDEO Som, imagem e vídeo

TELEPHONY Telefonia

Tabela 52 : Valores associados a vads_product-type0


vads_product_vatN

Descrição Permite definir o valor da taxa de cada um dos artigos contidos no carrinho.


Campo de entrada.

Formato n..12

Código de erro 203

Valores possíveis • Um número inteiro sem decimais

Para mencionar um valor em centavo aplicado sobre o produto em questão.

Exemplo em BRL : 14520 (para um valor de 145 BRL et 20 centavos)

• Um número inteiro com decimal inferior a 100

Para mencionar uma percentagem aplicada sobre o valor do produto emquestão com 4 dígitos máximo após a virgula.

Exemplos: 20.0 ou 19.6532

Observações:

• A decimal é obrigatória para mencionar uma percentagem.



• A decimal é marcada pelo símbolo ".".


vads_proof_of_id_number

Descrição Campo reservado para digitar o número de documento de identidade docomprador na página de pagamento.

O formato depende do tipo de documento de identidade e é de 7 a 13 dígitos,números, letras e/ou pontos.

Na América Latina, este parâmetro pode ser obrigatório para certos adquirentes.

Campo de entrada

Formato an..13

Código de erro 129


vads_proof_of_id_type

Descrição Este campo corresponde ao tipo de documento de identidade selecionado pelocomprador quando ele digitou os dados do cartão de pagamento.

Na América Latina, este parâmetro é obrigatório para DECIDIR.

Campo de entrada.

Formato enum

Código de erro 128


vads_recurrence_number

Descrição Número da parcela da assinatura.


Formato n..2


vads_recurrence_status

Descrição Status da assinatura.

Somente presente se a ação solicitada corresponder à criação deuma assinatura (REGISTER_SUBSCRIBE, SUBSCRIBE, REGISTER_PAY_SUBSCRIBE,REGISTER_UPDATE_PAY).


Formato string




CREATED A assinatura foi criada com sucesso.O detalhe da assinatura estiver disponível no Back Office.

NOT_CREATED A assinatura não foi criada e portanto não esta disponível no BackOffice.

ABANDONED O comprador desistiu da solicitação de criação da assinatura (devedor).A assinatura não foi criada e portanto não esta disponível no BackOffice.




vads_redirect_error_message

Descrição Permite especificar a mensagem se o pagamento for recusado no caso de umredirecionamento automático para o site de e-commerce.

Campo de entrada.

Formato ans..255

Código de erro 37

Categoria Redirecionamento para o site de e-commerce.

vads_redirect_error_timeout

Descrição Permite definir um prazo em segundos antes do redirecionamento automáticopara o site de e-commerce no final de uma pagamento recusado.

o valor oscila entre 0 e 600s.

Uma vez este prazo vencido, o comprador será redirecionado para a URL informadano campo vads_url_refused. Se o campo não for preenchido, o comprador seráredirecionado para a URL de retorno informada no campo vads_url_return ou paraa URL de retorno informada no Back Office. Se a URL de retorno não for definida,ele será redirecionado para a URL da loja.

Campo de entrada.

Formato n..3

Código de erro 36




vads_redirect_success_message

Descrição Permite especificar a mensagem no final de um pagamento aceito no caso de umredirecionamento automático para o site de e-commerce.

Campo de entrada.

Formato ans..255

Código de erro 35


vads_redirect_success_timeout

Descrição Permite definir um prazo em segundos antes do redirecionamento automáticopara o site de e-commerce no final de um pagamento aceito.

O valor oscila entre 0 et 600s.

Uma vez este prazo vencido, o comprador será redirecionado para a URL informadano campo vads_url_success. Se o campo não for preenchido, o comprador seráredirecionado para a URL de retorno informada no campo vads_url_return ou paraa URL de retorno informada no Back Office. Se a URL de retorno não for definida,ele será redirecionado para a URL da loja.

Campo de entrada.

Formato n..3

Código de erro 34




vads_result

Descrição Código de retorno da ação solicitada.


Formato n2


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.


vads_return_mode

Descrição Permite especificar o método de envio dos dados usado quando voltar para o sitede e-commerce.

Campo de entrada

Formato enum

Código de erro 48

Valores possíveisNome do campo Valor Descrição

Ausente, vazioou NONE

Nenhum parâmetro será transmitido à URL deretorno para o site de e-commerce.

GET Os campos de retorno serão enviados à URL deretorno sob a forma de um formulário HTTP GET(na "query string").

vads_return_modePOST Os campos de retorno serão enviados à URL de

retorno sob a forma de um formulário HTTP POST.Se a volta para a loja ocorrer em um ambiente nãohttps então o navegador exibirá um pop-up desegurança para o comprador.




vads_risk_analysis_result

Descrição Retorna o resultado da análise de fraude efetuada por um sistema externo (Konduto,ClearSale, CyberSource,...).


Formato ans

Valores possíveis

Valores comuns a todos os analisadores de riscos

INVALID_CREDENCIAL Falha de configuração do contrato de análise de riscos.

COMUNICATION_PROBLEM Não foi possível comunicar com o analisador de riscos.

DATA_PROCESSING_PROBLEM Falha durante o tratamento do envio ou da resposta do analisador deriscos.

MISSING_MANDATORY_ORDER_INFO Dados relativos ao pedido estão faltando.

MISSING_MANDATORY_SHIPPING_INFO Dados relativos à entrega estão faltando.

MISSING_MANDATORY_SHIPPING_ADDRESS_INFO Dados relativos ao endereço de entrega estão faltando.

MISSING_MANDATORY_BILLING_INFO Dados relativos ao faturamento estão faltando.

MISSING_MANDATORY_BILLING_ADDRESS_INFO Dados relativos ao endereço de faturamento estão faltando.

MISSING_MANDATORY_CARD_INFO Dados sobre o meio de pagamento estão faltando.

MISSING_MANDATORY_CUSTOMER_INFO Dados sobre o comprador estão faltando.

Tabela 53 : Valores comuns a todos os tipos de analisadores de riscos

ClearSale

APA A transação esta automaticamente aprovada conforme as configurações.

APM A transação foi manualmente aprovada por um analista.

RPM O pedido foi recusado devido a uma falta de informações sobre o comprador conforme à política aplicada.

AMA Análise manual em espera. O pedido esta na lista de espera para análise.

ERR Erro

NVO Novo pedido. Tratamento e classificação em andamento.

SUS Pedido manualmente suspenso. O pedido esta suspenso por suspeita de fraude.

CAN Pedido cancelado. O pedido foi cancelado pelo vendedor.

FRD Fraude confirmada com o operador do cartão de crédito ou do titular do cartão.

RPA Pedido recusado automaticamente. O pedido foi recusado conforme à aplicação das configurações daanálise de fraude externa.

RPP Pedido recusado automaticamente. O pedido foi recusado conforme à aplicação da política cliente ouClearSale

Tabela 54 : Valores retornados por ClearSale

CyberSource

100 A transação foi efeituada com sucesso.

101 A transação foi recusada. Um ou mais campos estão faltando.

102 A transação foi recusada. Um ou mais campos contém dados inválidos.

150 Erro.

151 Erro. A solicitação foi recebida mas o prazo foi excedido. Este erro não inclui prazos excedidos entre ocliente e o servidor.

152 Erro. A solicitação foi recebida mas um serviço não foi acabado no devido tempo.

202 Recusada. Cartão vencido.

231 Recusada. Número de conta inválido.

234 Recusado. Um problema ocorreu com a configuração CyberSource do vendedor.

400 Recusada. O valor da fraude excede o limiar de tolerância.

480 O pedido esta marcado para ser examinado pelo Decision Manager.

481 O pedido foi recusado pelo Decision Manager.

Tabela 55 : Valores retornados por Cybersource



Konduto

APPROVE Konduto recomenda aceitar a transação.Se nenhuma regra contradizer esta recomendação, o status da transação seráAUTHORISED.

DECLINE Konduto recomenda recusar a transação.O status da transação será REFUSED.

REVIEW Konduto recomenta verificar a transação.Dependendo do resultado da autenticação 3D-Secure, o status da transação será:

• AUTHORISED_TO_VALIDATE se a autenticação do portador for realizada comsucesso.

• REFUSED se a autenticação não for realizada com sucesso.

Tabela 56 : Valores retornados por Konduto




vads_risk_assessment_result

Descrição Retorna a lista das ações realizadas na transação, após o acionamento das regras degerenciamento de riscos avançados ativadas no Back Office.

Ao acionar diversas regras, o campo vads_risk_assessment_results será formado devárias palavras-chaves separadas por um ";".

Exemplo:

vads_risk_assessment_results="ENABLE_3DS;MANUAL_VALIDATION"


Formato ans

Valores possíveis

Valores Descrição

ENABLE_3DS 3D Secure ativado.

DISABLE_3DS 3D Secure desativado.

MANUAL_VALIDATION A transação é criada em validação manual.A captura do pagamento está bloqueada temporariamente para permitir ao vendedorefetuar todas as verificações desejadas.

REFUSE A transação foi recusada.

RUN_RISK_ANALYSIS Chamada para analisador de riscos externos se o vendedor possuir um contrato.Referir-se à descrição do campo vads_risk_analysis_result para identificar a lista dosvalores possíveis e a descrição deles.

INFORM Um aviso foi enviado.O vendedor é avisado que um risco foi identificado.O vendedor é informado via uma ou mais regras do centro de notificação (URL denotificação, e-mail ou SMS).




vads_risk_control

Descrição Permite definir o resultado do controle de riscos.


Formato controle1=resultado1;controle2=resultado2


CARD_FRAUD Controla a presença do número de cartão do compradorna lista cinza de cartões.

SUSPECT_COUNTRY Controla a presença do país emissor do cartão docomprador na lista dos países proibidos.

IP_FRAUD Controla a presença do endereço IP do comprador na listacinza de IP.

CREDIT_LIMIT Controla a freqüência e os valores de compra de ummesmo número de cartão, ou o valor máximo de umpedido.

BIN_FRAUD Controla a presença do código BIN do cartão docomprador na lista cinza dos códigos BIN.

ECB Controla se o cartão do comprador for do tipo e-cartebleue.

COMMERCIAL_CARD Controla se o cartão do comprador for um cartãocomercial.

SYSTEMATIC_AUTO Controla se o cartão do comprador for um cartão comautorização sistemática.

INCONSISTENT_COUNTRIES Controla se o país do endereço IP, o país emissor docartão de pagamento, e o país do endereço do compradorestão coerentes entre eles.

NON_WARRANTY_PAYMENT Controla a transferência de responsabilidade da transação.

SUSPECT_IP_COUNTRY Controle a presença do país do comprador, identificadopelo endereço IP dele, na lista dos países proibidos.

Os diferentes valores possíveis para resultado’ são :

Valor Descrição

OK OK

WARNING Controle informativo não sucedido.

ERROR Controle bloqueante não sucedido.




vads_risk_primary_warranty

Descrição Especifico à doação (ou transação secundária).

Permite sobrescrever a configuração do controle de risco Controle datransferência de responsabilidade da transação primária.


Formato enum

Código de erro 117


DEFAULT ou vazio Valor por padrão. Uso da configuração da loja alva.

IGNORE Ignora o valor da transferência de responsabilidade da transaçãoprimária antes de criar a transação secundária.

CHECK Força o controle da transferência de responsabilidade da transaçãoprimária antes de criar a transação secundária.

Categoria Informações sobre as transações de doação.

vads_sequence_number

Descrição Número de seqüência da transação.

Caso do pagamento único (vads_payment_config=SINGLE)

vads_sequence_number tem o valor de 1 no caso de um pagamento único.

No entanto, se o vendedor autorizou mais de uma tentativa de pagamento apósum pagamento recusado, o número de seqüência será incrementado a cada novatentativa.

O número de tentativas adicionais após um pagamento recusado pode serconfigurado no Back Office (menu Configurações > Loja > Configuração).

Caso do pagamento em x vezes (vads_payment_config=MULTI)

Para um pagamento parcelado, este campo tomará o valor “1” para a primeiraparcela, “2” para a segunda parcela, “3” para a terceira parcela etc.

O pagamento em mais de uma vez não é compatível com a funcionalidade detentativas adicionais em caso de pagamento recusado.

Observação:

O campo vads_sequence_number não é retornado na resposta quando umpagamento for cancelado ou não finalizado.



vads_ship_to_city

Descrição Permite definir a cidade do comprador.




Formato an..128

Código de erro 83




vads_ship_to_country

Descrição Permite definir o código do país do comprador segundo a norma ISO 3166.


Formato a2

Código de erro 86

Exemplos devalores possíveis

Código País Código País

AT Áustria IN Índia

BR Brasil MQ Martinica

CI Costa do Marfim NC Nova-Caledônia

FR Corsega PF Polinésia Francesa

FR França PM São Pedro e Miquelão

GP Guadalupe US Estados Unidos das Américas


vads_ship_to_delay

Descrição Permite definir a velocidade relativa ao modo de entrega quandovads_ship_to_speed tiver o valor de PRIORITY.

Campo de entrada.

Formato enum

Código de erro 127

Valores possíveis • INFERIOR_EQUALS para um prazo de entrega inferior ou igual a 1 hora.

• SUPERIOR para um prazo de entrega superior a 1 hora.

• IMMEDIATE para um prazo de entrega imediato.

• ALWAYS para um prazo de entrega 24h por dia.


vads_ship_to_delivery_company_name

Descrição Permite definir o nome do transportador.

Campo de entrada.

Formato ans..127

Código de erro 96


vads_ship_to_district

Descrição Permite definir o bairro.


Formato ans..127



Código de erro 115


vads_ship_to_first_name

Descrição Permite definir o nome do comprador.

Campo de entrada.

Formato ans..63

Código de erro 106


vads_ship_to_last_name

Descrição Permite definir o sobrenome do comprador.

Campo de entrada.

Formato ans..63

Código de erro 107


vads_ship_to_legal_name

Descrição Razão social do local de entrega.

Campo de entrada.

Formato an..100

Código de erro 125


vads_ship_to_name

Descrição Permite definir o sobrenome do comprador.

Desvalorizado. Sugerimos usar vads_ship_to_first_nameevads_ship_to_last_name


Formato ans..63

Código de erro 80


vads_ship_to_phone_num

Descrição Permite definir o número de telefone do comprador.




Formato ans..32

Código de erro 87




vads_ship_to_speed

Descrição Permite definir o modo de entrega.

Campo de entrada.

Formato enum

Código de erro 95

Valores possíveis STANDARD, EXPRESS, PRIORITY

Observação:

A utilização do valor PRIORITY requer a utilização do campo vads_ship_to_delay.


vads_ship_to_status

Descrição Permite definir o tipo de endereço de entrega.


Formato enum

Código de erro 93

Valores possíveis PRIVATE, COMPANY


vads_ship_to_state

Descrição Permite definir a UF do comprador.


Formato ans..127

Código de erro 84




vads_ship_to_street

Descrição Permite definir o endereço do comprador.


Formato ans..255


Código de erro 81


vads_ship_to_street2

Descrição Permite definir a segunda linha do endereço do comprador.


Formato ans..255


Código de erro 82


vads_ship_to_street_number

Descrição Permite definir o número de rua.


Formato ans..64

Código de erro 114


vads_ship_to_type

Descrição Permite definir o tipo de entrega.

Campo de entrada.

Formato enum

Código de erro 94

Valores possíveis • RECLAIM_IN_SHOP para retirar a mercadoria na loja.

• RELAY_POINT para a utilização de uma rede de pontos de entrega terceirizada(Kiala, Alveol, etc).

• RECLAIM_IN_STATION para retirar num aeroporto, uma agência de viagens ououtros.

• PACKAGE_DELIVERY_COMPANY para a entrega por transportadora (Colissimo,UPS, etc).

• ETICKET para emitir uma passagem eletrônica, baixar.



vads_ship_to_user_info

Descrição Informação sobre o usuário na origem do pagamento.

Este parâmetro será reenviado na resposta com o valor enviado na solicitação.

Observação:

Por razões de retro-compatibilidade, pode-se utilizar este campo para informar oCPF/CNPJ (Identificação legal, em formato numérico, tendo entre 11 e 20 dígitos)exigido pelo módulo de gerenciamento de fraude ClearSale. No entanto, o CPF/CNPJ pode ser informado no campo vads_cust_national_id.


Formato ans..255

Código de erro 116


vads_ship_to_zip

Descrição Permite definir o CEP do comprador.


Formato an..64

Código de erro 85


vads_shipping_amount

Descrição Permite definir o valor das despesas de entrega para a totalidade do pedido.

Campo de entrada.

Formato n..12

Código de erro 109


vads_shop_name

Descrição Permite definir o nome da loja que será exibido no recapitulativo no final dopagamento, o ticket e os e-mails de confirmação de pagamento.


Formato ans..127

Código de erro 72




vads_shop_url

Descrição URL da loja que será exibida na página de pagamento e nos e-mails de confirmaçãode pagamento.

Este parâmetro pode sobrescrever o valor padrão da sua loja.


Formato ans..1024

Código de erro 73


vads_site_id


Valor gerado durante o cadastro na plataforma de pagamento.

O valor pode ser consultado na interface do Back Office no menu Configuração >Loja > Certificados 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.


Formato n8

Código de erro 02


vads_subscription

Descrição Parâmetro facultativo usado quando criar uma assinatura. Designa o identificadorda assinatura a ser criada.

Duas opções são possíveis:

• Ou a gestão destes identificadores é delegada à plataforma.


Se a criação da plataforma for bem sucedida, a resposta apresentará o valorgerado pela plataforma.

• Ou este identificador é feito pelo site de e-commerce.

Neste caso, este parâmetro deve ser informado com o valor do identificadorde assinatura desejado. Cuidado, cabe ao site de e-commerce garantir ocaráter único dos identificadores de assinatura. Toda solicitação de assinaturacontendo um identificador de assinatura já existente, será recusada, e seráexibido uma mensagem de erro.




Formato ans..50

Código de erro 63




vads_sub_amount

Descrição Parâmetro obrigatório usado quando criar uma assinatura.

Faz referência ao valor das parcelas da assinatura para todas as parcelas, salvo asque podem ser definidas por vads_sub_init_amount_number.

O valor não pode ser negativo, nem vazio, nem igual a 0.

O valor deve ser apresentado na menor unidade monetária da moeda .

Exemplo: para uma transação de 10, o valor do parâmetro é 1028.

Campo de entrada.

Formato n..12

Código de erro 65


vads_sub_currency


Indica a moeda a ser usada para a assinatura, segundo a norma ISO 4217.


Formato n3

Exemplos de valorespossíveis

As moedas possíveis são as seguintes:

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

Código de erro 67


vads_sub_desc


Designa a regra da assinatura a ser criada.

O valor esperado neste parâmetro é um string de símbolos conforme aespecificação iCalendar, ou Internet Calendar, descrita na RFC5545 (ver http://tools.ietf.org/html/rfc5545).

Esta especificação permite, dentro de outras coisas, definir regras complexas deassinatura, via a propriedade RRULE.

Por razões técnicas. não for possível definir períodos de assinatura inferiores a umdia.

http://tools.ietf.org/html/rfc5545

http://tools.ietf.org/html/rfc5545



As palavras chaves SECONDLY" / "MINUTELY" / "HOURLY não são levadas em conta.

Exemplos:

• Para definir parcelas de pagamento que ocorrem o último dia de cada mês,durante 12 meses, a regra se escreve:

RRULE:FREQ=MONTHLY;BYMONTHDAY=28,29,30,31;BYSETPOS=-1;COUNT=12

Esta regra significa que se o mês corrente não contém um dia 31, então o motorlevará em conta o dia 30. Se o dia 30 não existe, então ele levará em conta odia 29, e assim por diante até o dia 28.

Outra versão desta regra é:RRULE:FREQ=MONTHLY;COUNT=5;BYMONTHDAY=-1

• Para definir parcelas de pagamento que ocorrem o dia 10 de cada mês,durante 12 meses, a regra de assinatura se escreve da seguinte forma:RRULE:FREQ=MONTHLY;COUNT=12;BYMONTHDAY=10

• Para definir parcelas de pagamento que ocorrem todo trimestre, até o31/12/2016:RRULE:FREQ=YEARLY;BYMONTHDAY=-1;BYMONTH=1,4,7,10;UNTIL=20161231

As parcelas ocorrerão todo dia 1° de janeiro, abril, julho e outubro. Aquantidade total deles depende da data de início da assinatura (ver parâmetrovads_sub_effect_date).

Para maiores detalhes e exemplos, você pode consultar o site http://recurrance.sourceforge.net/.


Formato string

Código de erro 64


http://recurrance.sourceforge.net/

http://recurrance.sourceforge.net/



vads_sub_effect_date

Descrição Parâmetro obrigatório usado para criar uma assinatura que permite definir a datade inicio na assinatura.

Este parâmetro não coincide sistematicamente com a data da primeira parcela,que depende somente do parâmetro vads_sub_desc.

A data de inicio indica quando a assinatura inicia. O formato desta data éAAAAMMJJ

Exemplo: para o 1° de fevereiro 2015, use o valor 20150201


Formato n8

Código de erro 69


vads_sub_init_amount

Descrição Parâmetro facultativo usado quando criar uma assinatura. Representa o valor dasparcelas da assinatura para as primeiras parcelas.

A quantidade destas primeiras parcelas é definido pelo parâmetrovads_sub_init_amount_number.

Este valor é apresentado na moeda definida pelo parâmetro vads_sub_currency eesta expresso na sua unidade indivisível.

O valor pode estar vazio mas não pode ser negativo nem igual a 0.


Formato n..12

Código de erro 66


vads_sub_init_amount_number

Descrição Parâmetro facultativo usado quando criar uma assinatura. Representaa quantidade de parcelas pelas quais o valor terá que ser aplicadovads_sub_init_amount.

Uma vez esta quantidade de parcelas excedida, é o valor vads_sub_amount queserá usado.

Exemplo: para definir uma assinatura cujas 3 primeiras parcelas são de 25,00 BRL,e o resto das prestações de 30,00 BRL, os seguintes valores serão usados:

• vads_sub_currency = 986

• vads_sub_init_amount_number = 3

• vads_sub_init_amount = 2500

• vads_sub_amount = 3000




Formato n..3

Code erreur 68


vads_tax_amount

Descrição Parâmetro que permite definir o valor das taxas para a totalidade do pedido.

O valor deve ser apresentado na menor unidade monetária da moeda .


Campo de entrada.

Formato n..12

Código de erro 108


vads_theme_config

Descrição Permite personalizar alguns elementos da página de pagamento como o modelo depersonalização que será aplicado, a denominação dos botões e certas mensagens.

Este parâmetro disponibiliza uma lista de palavras-chaves (códigos) associadas aelementos das páginas de pagamento com os quais um valor é associado.

Exemplo:

vads_theme_config="SUBMIT_BUTTON_LABEL=PAGAR;TICKET_LABEL=TICKET DE PAGAMENTO"

Consulte o Manual do usuário do Back Office - Personalização avançada paramaiores detalhes sobre a personalização das páginas de pagamento.

Campo de entrada.

Formato map

Código de erro 32

Valores possíveis

Código Descrição

Funcionalidades

RESPONSIVE_MODEL Permite sobrescrever o modelo de personalização que será aplicado àspáginas de pagamento.Exemplo de uso:

vads_theme_config="RESPONSIVE_MODEL=Model_1"

O uso dos modelos de personalização requer ativar a opção“Personalização avançada”.

RESPONSIVE_MAIL_MODEL Permite sobrescrever o modelo de personalização que será aplicado aose-mails.Exemplo de uso:

vads_theme_config="RESPONSIVE_MAIL_MODEL=Model_1"



Código DescriçãoO uso dos modelos de personalização requer ativar a opção“Personalização avançada”.

SIMPLIFIED_DISPLAY Permite diminuir o volume de dados que serão carregados na exibição dapágina de pagamento.Apaga a seleção de idioma e as logomarcas presentes no rodapé.Recomendado para as integrações iframe e In-app.Valores possíveis: "true" ou "false".Exemplo de uso:

vads_theme_config="SIMPLIFIED_DISPLAY=true"

FORM_TARGET Permite definir ou exibir a página de retorno no final do pagamento.Valores possíveis:

• _blank: em uma nova janela ou uma nova aba

• _self: no frame atual

• _parent: no frame parente

• _top: na página toda

• framename: no frame especificado.

Exemplo de uso:

vads_theme_config="FORM_TARGET=_top"

3DS_LOGOS Permite ocultar as logomarcas "Verified By Visa" e "Mastercard SecureCode" na página onde digita os dados do cartão.Valores possíveis: "true" ou "false".Exemplo de uso:

vads_theme_config="3DS_LOGOS=false"

Denominação dos botões

SUBMIT_BUTTON_LABEL Permite modificar a denominação do botão “VALIDAR”.Exemplo de uso:

vads_theme_config="SUBMIT_BUTTON_LABEL=PAGAR"

CANCEL_FOOTER_MSG_RETURN Denominação do botão “Cancelar e voltar para a loja” presente na páginade seleção do meio de pagamento, a página onde digita as informaçõesdo cartão e na página de resultado se o pagamento falhar.Exemplo de uso:

vads_theme_config="CANCEL_FOOTER_MSG_RETURN=CANCELAR"

SUCCESS_FOOTER_MSG_RETURN Denominação do botão “Voltar para a loja” presente na página deresultado se o pagamento for realizado com sucesso.Exemplo de uso:

vads_theme_config="SUCCESS_FOOTER_MSG_RETURN=RETORNO"

TICKET_LABEL Denominação do botão “TICKET” presente na página de resultado se opagamento for realizado com sucesso.Exemplo de uso:

vads_theme_config="TICKET_LABEL=TICKET DE PAGAMENTO"

Mensagens

MERCHANT_ MESSAGE Permite exibir uma mensagem acima do resumo da transação.É preciso assinalar a caixa Exibir a mensagem personalizada via o menuConfigurações > Personalização > aba Páginas de pagamento > grupoLogomarca.



Código DescriçãoExemplo de uso:

vads_theme_config="MERCHANT_MESSAGE=Resumo da transação"

SECURE_ MESSAGE Valor por padrão: O endereço deste site de pagamento prefixado porhttps mostra que você esta em um site seguro e que você pode fazer seupagamento com toda tranqüilidade.Exemplo de uso:

vads_theme_config="SECURE_ MESSAGE=Você está em um site seguro TLS1.2. Você pode pagar com toda segurança.”

SECURE_MESSAGE_REGISTER Valor por padrão: O endereço deste site de pagamento prefixado porhttps mostra que você está em um site seguro e que você pode digitarseus dados bancários com toda tranqüilidade.

REGISTER_ON_PAYMENT Permite personalizar o texto da caixa que deve assinalar para umASK_REGISTER_PAY.Valor por padrão: Quero salvar os dados do meu meio de pagamento parauma próxima compra

Denominações presentes no ticket e nas páginas de pagamento

SITE_ID_LABEL Valor por padrão: Código de usuário do vendedor

ORDER_ID_LABEL Valor por padrão: Referência do pedido

TRANSACTION_ID_LABEL Valor por padrão: Número da transação

TRANSACTION_AMOUNT_LABEL Valor por padrão: Valor

MULTI_DATE_LABEL Valor por padrão: Data de vendaInformação somente presente para um pagamento parcelado.

CUST_ID_LABEL Valor por padrão: Referência do compradorInformação somente presente para um pagamento por código.

CUST_ADRESS_NUMBER_LABEL Valor por padrão: Número do endereçoInformação somente presente para um pagamento por código.

CUST_ADRESS_LABEL Valor por padrão: EndereçoInformação somente presente para um pagamento por código.

CUST_ADRESS2_LABEL Valor por padrão: Complemento de endereçoInformação somente presente para um pagamento por código.

CUST_DISTRICT_LABEL Valor por padrão: BairroInformação somente presente para um pagamento por código.

CUST_CITY_LABEL Valor por padrão: CidadeInformação somente presente para um pagamento por código.

CUST_COUNTRY_LABEL Valor por padrão: PaísInformação somente presente para um pagamento por código.

CUST_PHONE_LABEL Valor por padrão: Tel.Informação somente presente para um pagamento por código.

CUST_NAME_LABEL Valor por padrão: Sobrenome do compradorInformação somente presente para um pagamento por código.

RECURRENCE_AMOUNT_LABEL Valor por padrão: Valor por parcelaInformação somente presente para um pagamento por código.

RECURRENCE_INIT_AMOUNT_NUMBER_LABEL

Valor por padrão: Quantidade de parcelas de valor inicialInformação somente presente para um pagamento por código.

RECURRENCE_INIT_AMOUNT_LABEL Valor por padrão: Valor inicial da assinaturaInformação somente presente para um pagamento por código.

SHOP_LABEL Valor por padrão: LOJAInformação somente presente no ticket PDF.

SITE_URL_LABEL Valor por padrão: Endereço URLInformação somente presente no ticket PDF.

CUST_LANGUAGE Valor por padrão: IdiomaInformação somente presente no ticket PDF.




vads_threeds_cavv

Descrição Designa a verificação da autenticação do portador pela ACS. É valorizadopelo servidor de autenticação 3DS (ACS) quando o comprador se identificoucorretamente (vads_threeds_status vale « Y » ou « A »).


Formato ans..28

Código de erro 52

Categoria Autenticação 3DS.

vads_threeds_cavvAlgorithm

Descrição Algoritmo usado pela ACS para gerar o valor do cavv.

É valorizado pelo servidor de autenticação 3DS (ACS) quando o comprador seidentificou corretamente (vads_threeds_status vale « Y » ou « A »).


Formato n1

Código de erro 55


0 HMAC

1 CVV

2 CVV_ATN

3 MasterCard SPA


vads_threeds_eci

Descrição Designa o Indicador de Comercio Eletrônico

É valorizado pelo servidor de autenticação 3DS (ACS) quando o comprador seidentificou corretamente (vads_threeds_status vale« Y » ou « A »).

status =Y status = A status = U status =N

VISA e AMEX 5 6 7 -

MasterCard 02 01 - -


Formato n..2

Código de erro 53




vads_threeds_enrolled

Descrição Designa o status de afiliação do portador. É valorizado pelos servidores VISA eMASTERCARD (DS) durante o processo 3D Secure.


Formato a1

Código de erro 51


Y Portador afiliado, autenticação 3D Secure possível.Observação: No Back Office, o valor ENROLLED está exibido (aba 3D Secure doDetalhes de uma transação).

N Portador não afiliado.Observação: No Back Office, o valor NOT_ENROLLED está exibido (aba 3D Secure doDetalhes de uma transação).

U Não foi possível verificar o status de afiliação.Observação: No Back Office, o valor UNAVAILABLE está exibido (aba 3D Secure doDetalhes de uma transação).


vads_threeds_error_code

Descrição Status final do processo 3D Secure.

Este campo esta desvalorizado. É substituído pelo campovads_threeds_exit_status.


Formato n..2


vads_threeds_exit_status

Descrição Status final do processo 3D Secure.

É valorizado pela plataforma de pagamento


Formato n..2


0 Status inicial

1 Status não aplicável (global, razão não detalhada)

2 Status não aplicável (integrator disabled)

3 Não é um pagamento e-commerce

4 Pagamento sem 3DS (pagamento por Token Cartão, PayPal, Cetelem, etc.)

5 Vendedor não afiliado, sem 3DS*

6 Erro técnico durante o processo 3DS, sem 3DS

7 Portador não alistado, sem 3DS

8 Assinatura inválida

9 Problema proveniente do ACS



Valor Descrição

10 O processo 3DS foi concluído corretamente

11 O processo 3DS foi feito pelo integrador

12 Problema proveniente do DS

13 Prazo de conexão vencido (timeout) durante uma conexão ao DS

15 O 3DS não esta disponível para este canal de pagamento (pagamentos porarquivo)

16 Tipo de cartão e rede eligível no 3DS, mas sem “brand” associada ao cartão(somente CB)

98 A inicialização do processo 3DS esta OK

99 Status desconhecido

* Estes status são relacionados aos pagamentos para os quais o 3DS ocorreu massem digitação de cartão (por Token Cartão).




vads_threeds_mpi

Descrição Ativa / desativa o processo 3DS durante um pagamento e-commerce.

Campo de entrada.

Formato n1

Código de erro 50


ausenteouvazio

Autenticação 3DS gerada pela plataforma de pagamento (configuração do vendedor).

0 Autenticação 3DS gerada pela plataforma de pagamento (configuração do vendedor).

1 Autenticação 3DS integralmente gerada pelo vendedor somente se vads_card_numberfoi preenchido (digitação dos dados cartões no site do vendedor).Os dados que resultam da autenticação 3D Secure efetuada pelo MPI do vendedordevem agora ser enviados para os campos do formulário previstos para isso(vads_threeds_enrolled, vads_threeds_cavv, vads_threeds_eci, vads_threeds_xid,vads_threeds_ cavvAlgorithm, vads_threeds_status).

2 Autenticação 3DS desativada para a transação, seja qual for a configuração padrão dovendedor.


vads_threeds_sign_valid

Descrição Designa a validade da assinatura da mensagem PARes. É valorizado pela plataformade pagamento


Formato n1


Vazio Sem 3DS.

0 Assinatura incorreta.

1 Assinatura correta.




vads_threeds_status

Descrição Designa o status de autenticação do portador. É valorizado pelo servidor deautenticação 3DS durante o processo 3D Secure.


Formato a1

Código de erro 56


Y Autenticação sucedida.Observação: No Back Office, o valor SUCCESS está exibido (aba 3D Secure do Detalhes deuma transação).

N Erro de autenticação .Observação: No Back Office, o valor FAILED está exibido (aba 3D Secure do Detalhes deuma transação).

U Autenticação impossível.Observação: No Back Office, o valor UNAVAILABLE está exibido (aba 3D Secure doDetalhes de uma transação).

A Tentativa de autenticação .Observação: No Back Office, o valor ATTEMPT está exibido (aba 3D Secure do Detalhesde uma transação).


vads_threeds_xid

Descrição Designa a referência única da transação 3DS.

É valorizado pelo servidor de autenticação (ACS) durante o processo 3D Secure.


Formato ans..28

Código de erro 54


vads_token_id

Descrição Código da ordem de pagamento associada à transação.

Corresponde ao campo offerId do objeto paymentOfferResponse > offerEntities(ver. Guia de implementação "API Webservices SOAP Ordem de pagamento").


Formato ans..255




vads_trans_date


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ável vads_trans_date correspondeao campo transmissionDate. Nós aconselhamos salvar este valor na base paravalorizar corretamente o campo transmissionDate durante as suas chamadas viaos webcservices.


Formato n14

Código de erro 04

Erros frequentes:

• A data não é enviada no formato AAAAMMJJHHMMSS (ano, mês, dia, hora,minuto, segundo).

• 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.




vads_trans_id


É 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.


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.




vads_trans_status

Descrição Permite definir o status da transação.


Formato enum


ABANDONED AbandonadoO comprador abandonou o pagamentoA transação não foi criada e portanto não está exibida noBack Office.

AUTHORISED Captura em andamentoA transação foi aceita e será capturada automaticamente nobanco na data prevista.

AUTHORISED_TO_VALIDATE Para ser aprovadoA transação, criada em validação manual, esta autorizada. Ovendedor deve validar manualmente a transação para lançara solicitação de autorização e a captura no banco.Pode-se validar a transação enquanto a data de vencimentoda solicitação de autorização não for ultrapassada. Seesta data está vencida, então o pagamento tem o statusEXPIRED. O status Expirado é definitivo.

CANCELLED CanceladaA transação foi cancelada pelo vendedor.

CAPTURED EntregueA transação foi capturada no banco.

CAPTURE_FAILED A transação não foi capturada.Favor entrar em contato com o suporte.

EXPIRED ExpiradaA data de vencimento da solicitação de autorização foiatingida e o vendedor não validou a transação. Portanto, oportador não será debitado.

INITIAL Em andamentoEste status é específico para todos os meios de pagamentoque requerem uma integração por formulário de pagamentoem redirecionamento.Este status é retornado quando:

• nenhuma resposta é retornada pelo compradorou

• o prazo de resposta do comprador ultrapassa o tempoda sessão do pagamento na plataforma de pagamento.Esta status é temporário. O status definitivo será exibidono Back Office assim que a sincronização finalizar

NOT_CREATED Transação não criadaA transação não foi criada e portanto não esta exibida noBack Office.

REFUSED RecusadaA transação foi recusada.

SUSPENDED SuspensaA captura da transação está temporariamente bloqueadapelo adquirente (AMEX GLOBAL ou SECURE TRADING). Umavez que a captura for processada corretamente, o status datransação seráCAPTURED.

UNDER_VERIFICATION Verificação em andamento Específico a PayPal

WAITING_AUTHORISATION Autorização em andamentoO prazo de captura no banco é maior que o tempo devalidade da autorização.

WAITING_AUTHORISATION_TO Para ser aprovado e autorizado



Valor Descrição_VALIDATE O prazo de captura no banco é maior que o tempo de

validade da autorização.Uma autorização 1 BRL foi aceita.O vendedor deve validar manualmente a transação paralançar a solicitação de autorização e a captura no banco.

Tabela 57 : Valores associados a vads_trans_status


vads_trans_uuid

Descrição Referência única gerada pela plataforma de pagamento após a criação de umatransação de pagamento.

Oferece uma garantia de unicidade para cada transação.


Formato ans32


vads_url_cancel

Descrição URL para qual será redirecionado o comprador depois de clicar em "cancelar evoltar para a loja" antes de ter efetuado o pagamento.

Campo de entrada.

Formato ans..1024

Código de erro 27


vads_url_check

Descrição URL da página a ser notificada no final do pagamento. Sobrescreve o valor digitadona configuração das regras de notificação.

Observação

Este campo deve ser utilizado excepcionalmente porque:

• Esta URL será utilizada somente na chamada da URL de notificação depagamento (IPN) imediato,

• o valor sobrescrito não será utilizado se houver um relançamento automático.

Esta funcionalidade não é compatível com a execução, pelo Back Office, dasolicitação enviada à url de notificação instantânea. A URL chamada será amesma que foi configurada na regra de notificação (ver capítulo Configurar asnotificações).

Campo de entrada.

Formato ans..1024

Código de erro 33



vads_url_check_src

Descrição Este parâmetro define a procedência da chamada URL de notificação (tambémchamada IPN).


Formato enum


PAY Criação de um pagamento por formulário.

BO Execução de URL de notificação pelo Back Office.

BATCH_AUTO Chamada durante a solicitação de autorização de um pagamento quetinha o status de autorização em andamento.

BATCH Atualização do status da transação após a sincronização com o adquirente(caso da notificação em modificação por batch).

REC Pagamentos criados a partir de uma recorrência.

MERCH_BO Operação efetuada na transação pelo Back Office.

RETRY Re-chamada automática a URL de notificação.


vads_url_error

Descrição URL para qual será redirecionado o comprador em caso de erro de tratamentointerno.

Campo de entrada.

Formato ans..1024

Código de erro 29


vads_url_post_wallet

Descrição Este campo permite ao vendedor transmitir a URL para na qual será redirecionadoo comprador durante um pagamento via um wallet em duas etapas.

Esta url é usada para transmitir informações relativas à escolha do comprador (e-mail, endereço de entrega, meio de pagamento, etc.).

A partir destes elementos, o vendedor pode escolher qual ação realizar (ajustarcustos de entrega, salvar o meio de pagamento, etc.) antes de deixar o compradorfinalizar sua compra.

Os dados serão enviados para o site de e-commerce via um formulário html POST.

Exemplo: vads_url_post_wallet = https://mydomain-name.com/return_url

Observação

Se a URL não for disponível, a transação não poderá ser finalizada. Após o finaldo prazo da sessão de pagamento, uma transação recusada será criada. Se ovendedor configurou a regra de notificação em abandono/cancelamento, o sitede e-commerce será notificado da recusa via o campo vads_payment_error. Estecampo terá o valor 149 que indica que o prazo da sessão de pagamento venceu.



Será então possível consultá-lo na aba Histórico do Back Office.


Formato ans..1024

Código de erro 138


vads_url_referral

Descrição Campo desvalorizado. Use vads_url_refused.

URL para qual será redirecionado o comprador se a autorização for recusada(código 02 Entrar em contato com o emissor do cartão) depois de clicar em Voltarpara a loja.

Campo de entrada.

Formato ans..127

Código de erro 26


vads_url_refused

Descrição URL para qual será redirecionado o comprador, depois de clicar no botão "voltarpara a loja".

Campo de entrada.

Formato ans..1024

Código de erro 25




vads_url_return

Descrição URL para qual será redirecionado por padrão o comprador depois de clicarno botão Voltar para a loja, se as URLs vads_url_error, vads_url_refused,vads_url_success ou vads_url_cancel não forem informadas.

Se este campo não foi enviado, a configuração do Back Office será levada em conta.

É possível configurar URL de retorno, em modo TEST e em modo PRODUCTION.Estes campos são chamados URL de retorno da loja em modo teste e URL deretorno da loja em modo produção, e são acessíveis no menu Configurações >Loja > aba Configuração.

Se nenhuma URL foi definida no Back Office ou no formulário, então o botão Voltarpara a loja redirecionará o comprador para a URL do site de e-commerce (campoURL na configuração da loja).

Campo de entrada.

Formato ans..1024

Código de erro 28


vads_url_success

Descrição URL para qual será redirecionado o comprador se o pagamento for aceito, depoisde clicar no botão "voltar para a loja".

Campo de entrada.

Formato ans..1024

Código de erro 24


vads_user_info

Descrição Informação sobre o usuário na origem do pagamento.

No caso de um pagamento por formulário, este parâmetro será reenviado naresposta com o valor enviado na solicitação.

No caso de um pagamento manual pelo Back Office, este campo será preenchidocom o nome de usuário (login) que efetuou o pagamento.

Observação:

Por razões de retro-compatibilidade, pode-se utilizar este campo para informar oCPF/CNPJ (Identificação legal, em formato numérico, tendo entre 11 e 20 dígitos)exigido pelo módulo de gerenciamento de fraude ClearSale. No entanto, o CPF/CNPJ pode ser informado no campo vads_cust_national_id.


Formato ans..255

Código de erro 61




vads_validation_mode

Descrição Apresenta o modo de validação da transação.


Formato enum

Código de erro 05


Ausente ouvazio

Configuração padrão da loja escolhida (pode ser configurado no Back Office).

0 Validação automática pela plataforma de pagamento

1 Validação manual pelo vendedor.


vads_version


Versão do protocolo de troca com a plataforma de pagamento.


Formato enum

Código de erro 01

Valor possível V2


vads_warranty_result

Descrição Mostra a garantia do pagamento se o pagamento foi aceito.


Formato enum


YES O pagamento é garantido.

NO O pagamento não é garantido.

UNKNOW Por causa de um erro técnico, o pagamento não pode ser garantido.

Nãovalorizado.

Garantia de pagamento não aplicável


api formulário - documentation payzen · criar um formulÁrio de pagamento ... • adição do...

Documents