/checkout/charges cria as mesmas Checkout Sessions que
/checkout/sessions ad-hoc, mas a listagem é filtrada para mostrar apenas Sessions sem linkId —
deixando o dashboard mais limpo para fluxos de venda direta. Além disso, oferece um endpoint de
cancelamento.
Os exemplos usam o sandbox: API em
https://checkout-api.sandbox.z2pay.com e página em
https://pay.sandbox.z2pay.com. Em produção, use https://checkout-api.z2pay.com e
https://pay.z2pay.com. Requisições usam o header x-api-key — veja
Autenticação.Endpoints
| Método | Rota | Descrição |
|---|---|---|
GET | /checkout/charges | Lista vendas rápidas (Sessions ad-hoc) |
POST | /checkout/charges | Cria uma venda rápida ad-hoc |
GET | /checkout/charges/{id} | Busca uma venda rápida pelo ID |
POST | /checkout/charges/{id}/cancel | Cancela uma venda rápida |
Criar charge
POST /checkout/sessions na forma ad-hoc — mesmo schema
de items, paymentMethods, branding, splits, customer, etc. Retorna 201 com a Session criada e a
url pronta para enviar. Suporta idempotência via header Idempotency-Key.
A resposta é uma
CheckoutSession (com linkId: null) e a url para compartilhar pelo seu canal.Listar charges
linkId) do tenant.
Filtra por status (CSV). Valores:
created, opened, paying, partially_paid, paid, failed,
expired, canceled.Busca por ID da Session ou customer (nome, email, documento).
Número da página (≥ 1).
Itens por página (1–100).
Buscar charge por ID
GET /checkout/sessions/{id} — retorna a
visão completa da Session ad-hoc.
200 (encontrada) · 404 (não encontrada).
Cancelar charge
canceled. Permitido apenas se o status atual for created, opened ou
failed. Retorna 200. Suporta idempotência.
200 (cancelada) · 404 (não encontrada) · 409 (session_not_cancellable —
status atual não permite cancelamento, ex. paid).
Exemplo: cobrança individual recorrente
Cenário comum: enviar uma fatura mensal por boleto, com customer pré-preenchido e validade longa.10080 min). Envie a url retornada pelo seu canal (e-mail, WhatsApp).
Veja também
Checkout Sessions
O recurso por baixo das Charges: estados, schema e listagem.
Checkout Links
Para divulgação em massa, prefira um Link.
Comprador (página pública)
O que acontece quando o comprador abre a
url.Erros
Formato dos erros e códigos de domínio do checkout.

