3-D Secure (3DS)

Inicializar o script

Inclua o seguinte script em sua página web para carregar o script responsável por realizar a comunicação com as bandeiras e os bancos emissores:

<script src="https://static.payzu.io/scripts/3ds20.min.js"></script>

Após carregar o script em sua página, será necessário inicializá-lo da seguinte maneira:

const config = {
  amount: 350,
  currency: 'BRL',
  options: {
    enabled: true,
    sandbox: true,
    debug: true,
    suppressChallenge: false
  }
};

payzu3DS.init(config);

Registrar os eventos de autenticação

Registre os listeners dos eventos para tratar cada resultado possível da autenticação:

payzu3DS.on("ready", function (e) {

});

ready

Este evento é acionado quando todos os procedimentos de carregamento do script foram concluídos com sucesso, incluindo a validação do token de acesso. Indica que o checkout está pronto para iniciar o processo de autenticação.

Resultados da autenticação

O liability shift ocorre somente quando a autenticação é concluída com sucesso: nesse caso, a responsabilidade por chargeback é transferida ao emissor ou à bandeira. Em todos os demais cenários, a responsabilidade permanece com o estabelecimento.

unsupportedBrand

Este evento é acionado quando a bandeira do cartão utilizado não é compatível com o protocolo 3DS. Nesse caso, a autenticação não é realizada.

Atributos retornados

Solicitar o desafio

Instancie o objeto paymentObject, observando os campos que são expressamente obrigatórios na tabela abaixo. Ao executar o checkout, o processo de autenticação será iniciado e seu resultado será retornado através dos eventos.

const paymentObject = {
  installments: '01',
  cardnumber: '4000000000001091',
  cardexpirationmonth: '01',
  cardexpirationyear: '2027',
  cardalias: 'JOAO SOUZA',
  paymentmethod: 'Credit'
}

payzu3DS.checkout(paymentObject)

Caso a autenticação seja concluída com sucesso, o evento success será acionado. Nesse caso, as variáveis Cavv, Xid e Eci serão retornadas: elas devem ser enviadas ao seu backend e posteriormente incluídas na requisição no momento da autorização. Neste caso, o liability shift é transferido ao emissor.

Utilizar o resultado na cobrança

Para criar uma cobrança utilizando o 3DS, é necessário definir o campo authenticate como true, além de informar o campo externalAuthentication dentro de creditCardPayment:

{
  "creditCardPayment": {
    "authenticate": true,
    "externalAuthentication": {
      "cavv": "Ag5zZ2ElCIUbLFj6gS0J9gByv//rRg5qGTqWqf8vTjt5",
      "xid": "198b924ea7db1014b64c8b426a0e6f1e",
      "eci": "05",
      "version": "2.2",
      "referenceId": "abcd1234-efgh-5678-ijkl-9012mnopqrst"
    }
  }
}

Consulte Criar cobrança para os demais campos da requisição.