Pular para o conteúdo
Guia

Checkout

Uma página de pagamento hospedada com seus itens, métodos, cupons e campos extras.

1. Crie o checkout

Itens com valor unitário em centavos (string). A resposta traz url — o endereço público para o comprador.

POST /v1/checkouts
curl -X POST https://api2.bosspay.io/v1/checkouts \
  -H "Authorization: Bearer bp_test_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Curso Fundamentos",
    "items": [ { "name": "Curso", "unitAmount": "49700", "quantity": 1 } ],
    "methods": ["PIX", "CREDIT_CARD"],
    "maxInstallments": 6,
    "returnUrl": "https://sualoja.com/obrigado"
  }'

2. Redirecione o comprador

Envie o comprador para url. Após o pagamento ele volta para returnUrl.

3. Acompanhe

Pagamentos entram em Transações com origem CHECKOUT. GET /v1/checkouts/:id/stats mostra visitas, conversão e volume.

Webhooks relevantes

payment.createdpayment.approvedpayment.failed