Skip to main content
O abacatepay.js é o script de navegador que mostra o formulário de cartão do checkout transparente e gera o token ctok_, usado em Criar cobrança Cartão.

Entenda o checkout transparente de cartão

Como o script, a chave pública e o seu backend trabalham juntos, com exemplo de uso básico e em React. O passo a passo completo está no tutorial de checkout transparente com cartão.

Instalação

Coloque a tag no <head> da página de pagamento:
O script cria o objeto global AbacatePay. Use sempre esse endereço: não copie o arquivo para o seu servidor, porque ele é atualizado por nós. Não existe pacote npm do abacatepay.js; em React, Vue ou Next.js, carregue a mesma tag (o exemplo em React está em Cartão de crédito).

AbacatePay.create(opções)

Cria o checkout. Não desenha nada ainda: isso é papel do mount(). create() lança um erro na hora se publicKey estiver vazia ou se amount for menor que 100. Os callbacks são opcionais. Você pode usar só await com try/catch nos métodos, ou só os callbacks, ou os dois. Para usar await, coloque o código num <script type="module"> ou numa função async.

Métodos

checkout.mount(alvo)

Desenha o formulário dentro do elemento. Aceita um seletor CSS ('#cartao') ou o próprio elemento. O conteúdo que estiver dentro dele é substituído. Devolve uma Promise que resolve quando o formulário está pronto e rejeita com um erro se algo falhar, por exemplo uma chave pública inválida. Chame uma vez por checkout.

checkout.tokenize(cliente, endereço?)

Valida o cartão, faz o 3DS quando o banco exige e devolve o token. Chame no clique do botão de pagar, nunca antes: o token vale só 60 segundos. Quando o banco pede 3DS, o tokenize() abre uma janela por cima da página, com o título Autenticação do cartão, e só resolve depois que o cliente termina. Se ele não confirmar, rejeita com THREE_DS_FAILED. cliente (obrigatório): endereço (opcional): endereço de cobrança do cartão. Em produção ele é enviado ao banco na autenticação 3DS. Se enviar, mande os cinco campos: street, number, city, state (sigla com 2 letras) e zipCode.
Resultado:
Para pagar de novo depois de uma recusa, chame tokenize() outra vez: cada chamada gera um token novo.

checkout.destroy()

Remove o formulário. Use quando o cliente sai da tela de pagamento sem recarregar a página (SPA).

Propriedades


onCardChange

Recebe o estado do formulário a cada mudança:

Erros

Os erros do abacatepay.js têm name igual a AbacatePayError, uma message e um code:
Mensagens mais comuns com code: 'API', no mount() ou no tokenize():

Modo Teste

Com a chave pública de teste, o abacatepay.js mostra um formulário de teste: campos simples, já preenchidos com o cartão 4242 4242 4242 4242, sem 3DS e sem cobrança real. Para simular recusas, troque o número pelos cartões de teste.

Aparência

O theme é repassado ao formulário seguro. Em styles, cada chave é um seletor CSS de dentro do formulário e o valor é um objeto de estilos:
O theme vale para o formulário seguro de produção. O formulário de teste do Modo Teste tem visual fixo.