Checkout e Link de Pagamento

A API de Checkout e Link de Pagamento do PagBank oferece uma solução completa e versátil para simplificar o processo de pagamento online. Com essa API, você pode gerar links compartilháveis que direcionam os clientes a uma página de pagamento dentro do ambiente seguro do PagBank, garantindo uma experiência de compra contínua e protegida, alinhada aos mais altos padrões de segurança e conveniência do mercado de pagamentos.

• Checkout: você redirecionar os seus clientes para o ambiente de pagamento do PagBank, onde eles podem concluir a transação com facilidade. Ao finalizar a compra, você pode optar por retornar o cliente à sua loja, proporcionando uma experiência integrada e personalizada.
• Link de Pagamento: você pode compartilhar o link de pagamento gerado com a API do PagBank em diversas plataformas, como redes sociais, e-mails e aplicativos de mensagens, sem a necessidade de ter um e-commerce. Assim, o processo de pagamento online é simplificado, adaptando-se ao seu modelo de negócio.

Ao optar pela API de Checkout e Link de Pagamento do PagBank, você tem total controle sobre as configurações dos pagamentos oferecidos, incluindo o número de parcelas e os meios de pagamento disponíveis, proporcionando flexibilidade e personalização para atender às necessidades específicas do seu negócio.

Atualmente os seguintes métodos de pagamentos estão disponíveis:

• Cartão de crédito
• Cartão de débito
• Pix
• Boleto
• Pagar com PagBank (cartão de crédito e saldo)

📘

Pagar com PagBank

Você pode escolher os meios de pagamento que estarão disponíveis ao seu cliente, podendo habilitar ou emitir as opções acima. No entanto, a opção de Pagar com PagBank sempre ficará disponível no checkout, independente da configuração.

Como a API de Checkout e Link de Pagamento funciona

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

1. Você coleta as informações dos itens associados ao pedido. Isso pode ser feito por meio do seu e-commerce ou qualquer outra plataforma de vendas que você utilize.

2. Com base nas características do pedido, você irá criar uma página de pagamento utilizando o endpoint Criar Checkout. Nesse endpoint, você irá configurar o checkout que será disponibilizado ao seu cliente. Entre as configurações disponíveis, você poderá definir:

   • A URL para a qual o seu cliente deve ser redirecionado 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.
   
   

   📘

   O Link de pagamento é considerada uma página de pagamento pelo PagBank, onde você customizou as preferências do pedido.

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 ou link de pagamento criado. Você também recebe um link que você utilizará para redirecionar o seu cliente para a página de pagamento, 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 (checkout) ou encaminhar (link de pagamento) o seu cliente à página de pagamento criada pelo PagBank.

5. Na página criada, o seu cliente irá concluir o pagamento com o método que ele desejar. Além disso, dependendo de como o checkout ou link de pagamento 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 e Link de Pagamento 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 de todos os passos necessários.

Personalização da página de pagamento

Depois que seu cliente acessa a página do pagamento, 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 dos passos existentes no processo de pagamento depende dos parâmetros abaixo fornecidos no momento da criação:

• 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 itens do pedido ou ao envio dos produtos. Já o desconto, definido 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.

Expiração do Checkout e Link de Pagamento

Você pode informar no momento da criação do pagamento, via parâmetro, um prazo de expiração. Caso não faça, a página de pagamento seguirá ativa independente do momento em que for acessada.

Repassando taxas de parcelamento ao vendedor

Por padrão, as taxas de parcelamento são arcadas pelo comprador quando você criar um Checkout ou Link de Pagamento. No entanto, você pode configurar o Checkout/Link de Pagamento para você assumir essas taxas de parcelamento de uma venda.

Caso você deseje arcar com as taxas de parcelamento, você precisa:

• Determinar o número máximo de parcelas que você aceitará para a venda.
• Especificar a quantidade de parcelas em que você assumirá os juros do parcelamento.

📘

Consulta de taxas

Para consultar as taxas aplicáveis, acesse sua conta e navegue até Vendas > Simulação.

As informações referentes ao número de parcelas e as taxas devem ser enviadas no momento da criação do Checkout/Link de Pagamento. Essas informações devem ser repassadas através do objeto payment_methods_configs.config_options através de objetos distintos, contento os parâmetros option e value. O parâmetro value define a quantidade de parcela, enquanto o parâmetro option pode conter uma das seguintes opções:

• INSTALLMENTS_LIMIT: define o número máximo de parcelas permitidas para o pagamento.
• INTEREST_FREE_INSTALLMENTS: especifica o número de parcelas cujo juros serão assumidos pelo vendedor.

O bloco de código a seguir apresenta um exemplo de configuração, onde a venda pode ser parcelada em até 12 vezes e o vendedor irá arcar com os juros das primeiras 5 parcelas.

"config_options": [
  {
    "option": "INSTALLMENTS_LIMIT",
    "value": "12"
  },
  {
    "option": "INTEREST_FREE_INSTALLMENTS",
    "value": "5"
  }
]

Com essa configuração, o vendedor assumirá a taxa de parcelamento das primeiras 5 parcelas. Caso o comprador opte por parcelar em mais de 5 vezes, ele será responsável pelas taxas de parcelamento adicionais.

Endpoints e webhooks

A utilização da API de Checkout e Link de Pagamento é realizado por meio 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 checkout 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 mais 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 estão normalmente 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.