Checkout hospedado
Toda cobrança nasce com um checkoutUrl: uma página de pagamento pronta, com a marca da sua empresa, que você manda ao cliente por e-mail, WhatsApp ou redirecionamento. Não precisa de chave nem de login para abrir.
O que o pagador vê
- O nome fantasia da empresa (sem ele, a razão social), o logo e a cor cadastrados no painel, em Empresa › Marca do checkout.
- O valor, a
descriptione, se houver, oexternalIdcomo número do pedido. - O prazo, com contagem regressiva, o QR code do PIX, o código copia e cola com botão de copiar e os passos para pagar pelo app do banco.
- A página se atualiza sozinha enquanto espera: quando o pagamento é confirmado, mostra "Pagamento confirmado" com a hora. Se o prazo acaba ou a cobrança é cancelada, mostra isso.
- Português, espanhol e inglês: começa pelo idioma do navegador e o pagador pode trocar.
Voltar para o seu site
Com returnUrl na criação, o checkout mostra o link "Voltar para" + o nome da sua empresa, inclusive depois do pagamento. O checkout não redireciona sozinho. A URL precisa ser https.
O cliente voltar ao seu site não prova que pagou. Libere o pedido pelo webhook charge.paid ou consultando a cobrança.
Por quanto tempo o endereço vale
O checkoutUrl funciona enquanto a cobrança espera o pagamento e continua mostrando o resultado (pago, expirado, cancelado) por 7 dias depois que ela termina. Depois disso, ou com um endereço errado, a página mostra "link inválido", sem dizer se a cobrança existe.
O final do endereço é um código próprio do checkout, não o id da cobrança: quem tem o link só vê a página de pagamento. Para uma página que aceita vários pagadores, use um link de pagamento.
No ambiente de teste
O checkout de uma cobrança de teste mostra os simuladores (pagamento, expiração e falha) e avisa que nenhum banco aceita o código. Veja Ambiente de teste.
Prefere a sua própria tela?
A resposta de POST /v1/charges e de GET /v1/charges/:id traz, em attempt.instructions, o PIX da cobrança enquanto ela está pendente:
emv: o código copia e cola. O QR code é esse mesmo texto, gerado como QR por qualquer biblioteca.expiresAt: até quando o código vale.
Segurança da página
O checkout não abre dentro de iframe de outro site e não manda o endereço como referência para outros sites. Para embutir o pagamento no seu app, use o caminho acima.