O Checkout PagBank é uma solução que agrega diversos serviços de processamento de pagamento, no qual o cliente é encaminhado para uma página de pagamento online fornecida pelo próprio PagBank, oferecendo um elevado nível de confiabilidade e segurança. Ao final do pagamento o cliente é redirecionado ao site do parceiro integrador conforme ilustração abaixo:

👍

Atualmente é possivel gerar checkout com as seguintes formas de pagamento:

• Cartão de Crédito
• Cartão de Débito (Obrigatório 3DS)
• PIX
• Boleto Bancário.

Autenticação

Todas as APIs públicas do PagBank requerem autenticação. Através dessa, identificamos e autorizamos o integrador a utilizar nossas APIs e seus recursos, bem como eventuais configurações adicionais.

❗️

Atenção

As chaves de acesso são confidenciais e recomendamos não compartilhá-las em ambientes públicos ou com terceiros.

Obter credenciais de Conta:

Esse tipo de autenticação é utilizada por você que efetua suas vendas através da sua conta PagBank, informando seu token de integração no momento da requisição, você pode obte-lo em sua conta PagBank seguindo o passo a passo abaixo:

Ambiente de Sandbox

1º passo: Criar uma conta no nosso ambiente de Sandbox

2º passo: Localizar o menu Perfis de Integração

3º passo: Clicar em Vendedor. O token de sandbox estará disponível na seção Credenciais.

Ambiente de Produção:

1º passo: Acesse sua Conta PagBank;

2º passo: No menu lateral em Meu Negócio, selecione Vendas;

3º passo: Vá na opção Integrações;

4º passo: Pressione o botão Getar Token.

🚧

Atenção

Caso você já tenha gerado o token anteriormente, ele será enviado ao seu e-mail de cadastro por segurança. Nesse caso, basta pressionar Enviar por e-mail. Se preferir, você também pode gerar um novo token, mas importante: nesse caso, o token antigo será invalidado.

Obter credenciais de Aplicação:

Esse tipo de autenticação é utilizada quando você necessita efetuar vendas em nome de outros vendedores como, por exemplo, plataformas e marketplaces.

A autenticação neste caso deverá ser feita via API Connect criando uma aplicação, solicitando autorização de seu cliente para que aja em seu nome e obtendo seu acess_token.

O acess_token é a informação que deverá ser informada no momento da requisição do Checkout.

Para solicitar a autorização de seu cliente via Connect você deve informar os escopos:

Objeto Checkout

Para obter informações sobre os parâmetros a serem enviados na requisição acesse Objeto Checkout

Utilização do frete (shipping)

O Checkout possui os seguintes tipos de frete:

• FIXED: Valor fixo enviado pelo vendedor.
• FREE: Não realiza cálculo de frete e exibe na tela transacional “Frete Grátis”
• CALCULATED: Utiliza uma API dos correios para realizar o cálculo do envio. O valor do cálculo dependerá das informações da caixa passadas no nó Shipping e do CEP de entrega. Lembrando que a gestão e inteligência da caixa a ser enviada fica a cargo do vendedor.

O tipo escolhido deve ser passado via payload no momento da integração, juntamente com as dimensões da caixa em caso de "CALCULATED".

"shipping": {
        "type": "CALCULATE",
        "address_modifiable": true,
        "address": {
            "country": "BRA",
            "postal_code": "01451001",
            "street": "Avenida Brigadeiro Faria Lima",
            "number": "1384",
            "complement": "4º andar",
            "locality": "São Paulo",
            "region_code": "SP"
        },
        "box": {
            "dimensions": {
                "length": 15,
                "width": 10,
                "height": 14
            },
            "weight": 300
        }

    }

Checkout e seus Status

Status transacionais:

• PAID: Indica que o checkout foi pago.
• IN_ANALYSIS: Indica que o comprador optou por pagar com um cartão de crédito e o PagBank está analisando o risco da transação.
• DECLINED: Indica que a cobrança foi negada pelo PagBank ou Emissor.
• CANCELED: Indica que a cobrança foi cancelada
• WAITING: Significa que a cobrança está aguardando pagamento

Status de Checkout

• ACTIVE: Indica que o Checkout está ativo para receber pagamentos
• INACTIVE: Indica que o Checkout está inativo para receber pagamentos
• EXPIRED: Indica que o Checkout expirou

Personalização dos steps

Possibilitamos, caso seja de seu desejo, a personalização dos steps do Checkout. Isso pode ser feito via envio de parâmetros no payload.

• customer_modifiable: Indicador da imutabilidade dos dados pessoais na criação do checkout. Caso false, possibilita pular o step de dados pessoais.
• address_modifiable: Indicador de imutabilidade do endereço de entrega. Caso false, impossibilita a alteração do endereço de entrega por parte do comprador.

Webhook

O PagBank poderá enviar notificações via webhook para seu ambiente sempre que um evento (uma mudança de status de transação ou de checkout) acontecer, possibilitando a automação de seus processos de gestão de vendas.

Para configurar o recebimento de notificação: Webhook Checkout

Tabela de erros

Você receberá erro como resposta quando não conseguirmos prosseguir com a operação. Listamos os erros disponíveis para te ajudar nas tratativas: Tabela de erros

Informações adicionais:

Consultar uma transação:

Para consultar uma transação: Consultar pedido através de parâmetros

Valor máximo do carrinho

O valor do carrinho é dado por: soma do valor dos itens + valor do frete + valor adicional - desconto. O valor máximo do carrinho não deve ultrapassar 8999999100 centavos.

Bandeiras aceitas

'PERSONALCARD'

'UPBRASIL'

'BANESECARD'

'VISA'

'MASTERCARD'

'AMEX'

'DINERS'

'HIPERCARD'

'HIPER'

'AURA'

'CABAL'

'AVISTA'

'PLENOCARD'

'ELO'

'GRANDCARD'

'CARDBAN'

'SOROCRED'

'BRASILCARD'

'VERDECARD'

'JCB'

'MAIS'

'POLICARD'

'VALECARD'

'DISCOVER'

'FORTBRASIL'

Dúvidas

Em caso de dúvidas sobre a integração e para homologação pós testes em sandbox, entre em contato com nosso time especialista: https://app.pipefy.com/public/form/e7ouI6XN