Checkout

​

Introducao

O Checkout hospedado envia o comprador para uma pagina de pagamento da PodPay, sem o integrador precisar construir tela de PIX, cupom ou status.

Quando usar

Use Checkout quando quiser que a PodPay cuide da experiencia de pagamento: pagina publica, resumo do pedido, cupom, dados do comprador, geracao do PIX e acompanhamento de status.

Use Transactions diretamente quando voce ja tem checkout proprio e precisa apenas criar uma cobranca por API.

Fluxo recomendado para integracao REST

  1. Seu backend chama POST /v1/checkout/sessions com x-api-key (sk_* ou ck_*) e, de preferencia, X-Idempotency-Key.
  2. Envie productId copiado da aba Produtos do Checkout. O campo expiresAt e opcional e representa minutos; sem ele, a sessao dura 48 horas.
  3. A PodPay cria a sessao e retorna checkoutUrl na primeira criacao.
  4. Voce salva essa URL no seu pedido e redireciona o comprador para ela.
  5. O comprador finaliza o pagamento no checkout hospedado.
  6. Voce acompanha a confirmacao por webhook/postback ou pela consulta de transacao.

Em replay idempotente, a API retorna a sessao ja criada, mas nao promete reconstruir checkoutUrl. Salve a URL da primeira resposta.

Chaves

A chave sk_* continua sendo a chave secreta principal da API. A chave ck_* e dedicada ao Checkout e so pode ser usada nos endpoints REST de checkout permitidos, como POST /v1/checkout/sessions. Ela nao cria transacoes diretas, saques, consultas de saldo ou refunds.

Fluxo por link de pagamento

Quando o link e criado no painel PodPay, o comprador abre a URL publica do link. O app de checkout chama POST /v1/checkout/payment-links/{publicToken}/sessions e redireciona para a checkoutUrl retornada. Normalmente esse endpoint e usado pelo proprio app publico, nao pelo backend do integrador.

Endpoints publicos

Os endpoints que leem sessao, aplicam cupom e geram PIX nao usam API key no browser. Eles sao protegidos por token opaco da sessao, validacao de dominio quando aplicavel e rate limit por IP.

Checkout Operations