Checkout
Monte a sua página de pagamento com as mesmas rotas da página da PayZu, que levam toda venda a uma fatura paga no cartão ou no Pix.
Modalidades
Leia o plano e crie a assinatura, que nasce incomplete com a fatura de adesão a pagar.
Mostre o link criado no painel e crie, a cada compra, a fatura que o comprador paga.
Pagar a fatura pela páginaCobre a fatura no cartão ou no Pix e mostre a fatura paga como comprovante.
O plano e o link são portas de entrada e não recebem pagamento.
| Porta de entrada | O que a rota cria |
|---|---|
| Plano | A assinatura incomplete e a fatura de adesão, que ativa a assinatura quando é paga. |
| Link de pagamento | Uma fatura sem cliente, a cada compra. |
Só a fatura recebe pagamento, seja ela criada pela API, pela adesão ou pelo link. A fatura paga é o comprovante da venda.
Rotas
| Rota | Chave | Limite por IP | Página |
|---|---|---|---|
| GET /v1/checkout/plans/:plan_id | Chave de checkout | 60 por minuto | Assinar um plano pelo checkout |
| POST /v1/checkout/subscriptions | Chave de checkout | 10 por minuto | Assinar um plano pelo checkout |
| GET /v1/checkout/subscriptions/:subscription_id | Chave de checkout | 60 por minuto | Assinar um plano pelo checkout |
| GET /v1/checkout/payment-links/:payment_link_id | Sem chave | 60 por minuto | Comprar pelo link |
| POST /v1/checkout/payment-links/:payment_link_id/invoices | Sem chave | 10 por minuto | Comprar pelo link |
| GET /v1/checkout/invoices/:invoice_id | Sem chave | 60 por minuto | Pagar a fatura pela página |
| POST /v1/checkout/invoices/:invoice_id/payments | Sem chave | 10 por minuto | Pagar a fatura pela página |
Regras de todas as rotas
- Chave: as rotas do plano e da assinatura levam a chave de checkout no cabeçalho
x-checkout-keye exigem a Recorrência ativa na conta. As rotas do link e da fatura não levam chave, porque o id no caminho identifica a cobrança. - Limite por IP: as consultas dividem um contador de 60 chamadas por minuto. Pagar a fatura e comprar pelo link dividem outro, de 10 por minuto, e criar a assinatura tem o próprio, também de 10. Acima do limite, a resposta é
429. - IP de quem chama: o limite e a análise antifraude usam o IP de quem chama, então chamadas feitas do seu servidor somam todos os compradores num IP só.
- Valores: inteiros em centavos, como em Valores em dinheiro.
- Nome da conta: as consultas trazem em
merchant.display_nameo nome de exibição da sua conta, para a página mostrar quem recebe. Sem nome cadastrado, ele vemnull.
Libere o pedido com a fatura paga e o acesso com a assinatura active.
Leia a fatura paid na consulta ou no evento invoice.paid dos seus webhooks, e a assinatura active na consulta ou em subscription.activated. No cartão, o resultado vem na resposta do pagamento; no Pix, a fatura fica pending até o cliente pagar o QR Code.