Introdução ao Checkout

O Checkout PagBank possibilita que você redirecione o seu cliente para o ambiente PagBank no momento de realizar o pagamento. Dessa forma, seus clientes tem uma experiência fluida e segura ao usarem uma solução referência no mercado de pagamentos. Ao mesmo tempo, você evita toda a complexidade relacionada à integração de pagamentos ao seu sistema, deixando isso a cargo do PagBank.

Quando você opta pelo Checkout do PagBank você tem controle sobre as configurações dos pagamentos oferecidos, como por exemplo o número de parcelas. Atualmente os seguintes métodos de pagamentos estão disponíveis:

• Cartão de crédito
• Cartão de débito
• Pix
• Boleto

Como o Checkout PagBank funciona

O processo de utilização do Checkout PagBank pode ser dividido em seis passos:

1. O seu cliente seleciona os items desejado e então finaliza o pedido no seu ecommerce.
2. Você identifica as características da compra do seu cliente, como itens relacionados ao pedido, por exemplo. Com esses dados você cria um checkout utilizando o endpoint Criar Checkout. Nesse você irá configurar o checkout que será disponibilizado ao seu cliente. Entre as configurações disponíveis, você poderá definir:
   • Para qual URL o seu cliente deve ser direcionado após a conclusão do pagamento (redirect_url).
   • Formas de pagamento que estarão disponíveis para o seu cliente.
   • Limite de parcelas para pagamentos com cartão.
3. A API do PagBank irá te fornecer um id de identificação do checkout. Esse id é utilizado caso você deseje fazer consultas acerca do checkout criado. Você também recebe um link que você utilizará para redirecionar o seu cliente para a página de checkout, contendo todas as configurações definidas por você. Essa URL é disponibilizada em links[].href no objeto que contem links[].rel = PAY.
   
   
   JSON

        "links": [
          	{
             "rel": "PAY",
             "href": "https://pagamento.pagseguro.uol.com.br/pagamento?code=XXXX",
             "method": "GET"
         	}
        ]
   

4. Utilizando o link fornecido, você irá redirecionar o seu cliente à página de checkout criada pelo PagBank.
5. Na página de checkout personalizada, o seu cliente irá concluir o pagamento com o método que ele desejar. Além disso, dependendo de como o checkout foi criado, ele também pode escolher a forma de envio e fornecer os dados do endereço de entrega.
6. Com a conclusão do pagamento, o Checkout do PagBank irá direcionar o seu cliente à página que você definiu ao criar o checkout, defina pelo parâmetro redirect_url .

👍

Suporte

Em caso de dúvidas, entre em contato com nosso time de especialistas.

A imagem abaixo sumariza esse processo.

🚧

Autenticação

Para utilizar o Checkout do Pagbank você precisa estar autenticado. Se você não está familiarizado com as opções de autenticação utilizadas pelo PagBank, acesse a página de Primeiros passos para ter um guia completo acerca de todos os passos necessários.

Personalização do checkout

Depois que seu cliente acessa a página do checkout, ele precisa fornecer informações de identificação e sobre o endereço de entrega. Você tem a opção de pular esses passos para o seu cliente.

A personalização do passos existentes no checkout depende dos parâmetros abaixo fornecidos no momento da criação do checkout:

• customer_modifiable: Define se o passo de fornecimento dos dados pessoais será apresentado.
• address_modifiable: Define se o passo de fornecimento dos dados do endereço de entrega será apresentado.

Caso opte por não apresentar um desses passos, você deverá fornecer os dados relacionados no momento da criação do checkout.

Valor do pagamento

O valor a ser pago pelo seu cliente no checkout será calculado pelo sistema do PagBank, definido por:

valor a ser pago = valor dos itens + valor do frete + valor adicional - desconto

O valor adicional, definido pelo parâmetro additional_amount, é utilizado para incorporar ao valor total custos que não estão vinculados aos items do pedido ou ao envio dos produtos. Já o desconto, definitro através do parâmetro discount_amount, aplicará um desconto sobre o valor total a ser cobrado do cliente.

🚧

Valor do desconto

O valor do desconto não pode ser superior a soma do valor dos itens, frete e valor adicional.

🚧

Valor máximo do pedido

O valor máximo do carrinho não deve ultrapassar 8999999100 centavos, equivalente a R$ 89.999.991,00.

Endpoints e webhooks

A utilização do Checkout do PagBank é realizado através de quatro endpoints. Esses endpoints são apresentados a seguir:

• Criar Checkout: permite que você crie e configure um checkout para cada compra realizada pelos seus clientes.
• Consultar Checkout: possibilita que você recupere os dados associados a um checkout criado previamente. Utilize essa opção para verificar o status atual do checkout e da transação ou para recuperar dados relacionados ao montante, forma de pagamento, ou valor do frete, por exemplo.
• Inativar Checkout: utilize essa opção para bloquear a realização do pagamento relacionado a um checkout criado previamente. O checkout continuará existindo com suas configurações. No entanto, o seu cliente não será capaz de realizar o pagamento enquanto o checkout estiver desativado.
• Ativar Checkout: ativa um checkout previamente inativado. Enquanto o chekout está ativado, o cliente pode executar o pagamento.

Além dos endpoints, o PagBank também fornece webhooks que te notificarão sempre que um evento relacionado a mudança de status ocorrer. Essas notificações podem ser relacionadas ao checkout ou às transações a ele associadas. Para maiores informações, acesse Webhooks.

📘

Homologação

Após finalizar os testes no ambiente de Sandbox, você precisa fazer a homologação junto ao PagBank.

Objeto Checkout

A API de Checkout utiliza o objeto Checkout. Para identificar todos os parâmetros, seus respectivos tipos e exemplos de cada parâmetro do objeto, acesse Objeto Checkout.

Erros

Os erros relacionados à requisição aos endpoints da API de Checkout normalmente estão associados ao fornecimento de parâmetros incorretos ou falta de autenticação. Para te auxiliar a entender os problemas ao executar as requisições, você pode acessar a página Códigos de erro, que lista os códigos que você pode receber e provê detalhes adicionais para cada erro.

Bandeiras aceitas

Durante a criação do checkout você pode escolher quais bandeiras de cartão estarão disponíveis para o comprador executar o pagamento. Atualmente, as seguintes bandeiras de cartão são aceitas pelo Checkout do PagBank.