# Z2Pay Developers

> Documentação da API pública do Z2Pay — pagamentos, assinaturas, checkout e sandbox.

## Docs

- [Ambientes](https://docs.z2pay.com/docs/pt-BR/ambientes.md): Sandbox × Produção: URLs base, como acessar o ambiente de testes e o que muda entre eles.
- [Assinaturas](https://docs.z2pay.com/docs/pt-BR/assinaturas/assinaturas.md): Crie e gerencie assinaturas recorrentes — criação, cancelamento, retomada, pausa e consulta.
- [Ciclos de cobrança](https://docs.z2pay.com/docs/pt-BR/assinaturas/ciclos.md): Como a Z2Pay calcula quando cada fatura de uma assinatura é gerada e cobrada — âncoras, prepaid/postpaid, geração das faturas, trial, lead time e inadimplência (dunning).
- [Faturas](https://docs.z2pay.com/docs/pt-BR/assinaturas/faturas.md): Liste, consulte e reconcilie faturas de recorrência, além da página de fatura hospedada para o pagador.
- [Planos e Preços](https://docs.z2pay.com/docs/pt-BR/assinaturas/planos-precos.md): Crie planos de cobrança recorrente, monte os componentes (itens) do bundle e versione preços na Billing API do Z2Pay.
- [Assinaturas: visão geral](https://docs.z2pay.com/docs/pt-BR/assinaturas/visao-geral.md): Como o Billing Engine da Z2Pay modela cobrança recorrente — Plano, Preço, Assinatura e Fatura — e por onde começar a integrar.
- [Autenticação](https://docs.z2pay.com/docs/pt-BR/autenticacao.md): Como autenticar suas requisições com a API key do Z2Pay (header x-api-key).
- [Checkout Charges](https://docs.z2pay.com/docs/pt-BR/checkout/charges.md): Venda rápida ad-hoc: crie uma cobrança individual sem Link e envie a URL direto pelo WhatsApp ou e-mail.
- [Comprador (página pública)](https://docs.z2pay.com/docs/pt-BR/checkout/comprador.md): Os endpoints públicos que a página de pagamento hospedada consome — config pública, abertura e confirmação.
- [Checkout Links](https://docs.z2pay.com/docs/pt-BR/checkout/links.md): Crie templates de cobrança reutilizáveis (chk_): uma URL para divulgar N vezes, cada acesso vira uma Session.
- [Checkout Sessions](https://docs.z2pay.com/docs/pt-BR/checkout/sessions.md): Instâncias de compra (cs_): valor congelado, snapshot imutável e máquina de estados created → opened → paying → paid.
- [Checkout — Visão geral](https://docs.z2pay.com/docs/pt-BR/checkout/visao-geral.md): Página de pagamento hospedada pelo Z2Pay: crie via API, compartilhe a URL e receba o pagamento pronto.
- [Conceitos centrais](https://docs.z2pay.com/docs/pt-BR/conceitos.md): Os objetos do Z2Pay e como eles se relacionam: transação, payment, cliente, recebedor, split e carteira.
- [Convenções](https://docs.z2pay.com/docs/pt-BR/convencoes.md): Regras que valem para toda a API: valores em centavos, datas ISO 8601, paginação e idempotência.
- [Cartões](https://docs.z2pay.com/docs/pt-BR/core-api/cards.md): Liste, consulte e desative cartões salvos de um customer. Apenas dados não-sensíveis são retornados.
- [Chargebacks](https://docs.z2pay.com/docs/pt-BR/core-api/chargebacks.md): Liste e consulte chargebacks, envie documentos de contestação e baixe os arquivos enviados.
- [Customers](https://docs.z2pay.com/docs/pt-BR/core-api/customers.md): Crie, liste, consulte, atualize e remova clientes (compradores) na Core API do Z2Pay.
- [Taxas (Fees)](https://docs.z2pay.com/docs/pt-BR/core-api/fees.md): Consulte a tabela de taxas resolvida da sua conta — pix, boleto, cartão, saque, reembolso e chargeback.
- [Payments](https://docs.z2pay.com/docs/pt-BR/core-api/payments.md): Liste, consulte, processe e estorne os pagamentos de uma transação.
- [Recipients (Recebedores)](https://docs.z2pay.com/docs/pt-BR/core-api/recipients.md): Cadastre e gerencie recebedores que recebem repasses via split na Z2Pay.
- [Refunds (Reembolsos)](https://docs.z2pay.com/docs/pt-BR/core-api/refunds.md): Consulte, aprove e recuse reembolsos de pagamentos via API do Z2Pay.
- [Splits](https://docs.z2pay.com/docs/pt-BR/core-api/splits.md): Gerencie configurações de split que definem como o valor de uma transação é dividido entre recipients.
- [Tokenizer](https://docs.z2pay.com/docs/pt-BR/core-api/tokenizer.md): Endpoints públicos de tokenização de cartão. Transforme dados sensíveis do cartão em um token opaco sem que o número passe pelo seu servidor.
- [Transactions](https://docs.z2pay.com/docs/pt-BR/core-api/transactions.md): Crie e consulte transações de pagamento, liste seus items e estorne a transação inteira.
- [Wallets & Withdrawals](https://docs.z2pay.com/docs/pt-BR/core-api/wallets.md): Consulte saldos e extrato das carteiras por recebedor e solicite saques (payouts) na Core API do Z2Pay.
- [Webhooks (gerenciamento)](https://docs.z2pay.com/docs/pt-BR/core-api/webhooks.md): Crie, edite e monitore webhooks da sua conta Z2Pay, liste o catálogo de eventos e reprocesse entregas que falharam.
- [Erros](https://docs.z2pay.com/docs/pt-BR/erros.md): Formato padrão de erro, códigos HTTP e como tratar falhas de forma robusta.
- [Introdução](https://docs.z2pay.com/docs/pt-BR/introducao.md): A API do Z2Pay para aceitar pagamentos, assinaturas e dividir valores — sem cuidar de PCI, antifraude ou roteamento.
- [Quickstart](https://docs.z2pay.com/docs/pt-BR/quickstart.md): Do zero ao primeiro pagamento aprovado no sandbox, em poucos minutos.
- [Cartões de teste](https://docs.z2pay.com/docs/pt-BR/sandbox/cartoes.md): Todos os cartões de teste do sandbox: quais passam, quais falham, e um gerador de número válido.
- [PIX e boleto de teste](https://docs.z2pay.com/docs/pt-BR/sandbox/pix-boleto.md): Como controlar a liquidação de PIX e boleto no sandbox: instant, auto, manual e cenários por valor.
- [Roteiro de teste](https://docs.z2pay.com/docs/pt-BR/sandbox/roteiro.md): Um checklist prático para validar sua integração no sandbox, do pagamento ao chargeback.
- [Simular eventos](https://docs.z2pay.com/docs/pt-BR/sandbox/simular.md): Force manualmente o desfecho de pagamentos e chargebacks pelo painel do sandbox.
- [Sandbox: visão geral](https://docs.z2pay.com/docs/pt-BR/sandbox/visao-geral.md): Como funciona o ambiente de testes do Z2Pay e por que ele é determinístico.
- [Liquidação e saque](https://docs.z2pay.com/docs/pt-BR/valores/liquidacao.md): Como o valor pago vira saldo na carteira do recebedor e como solicitar e acompanhar um saque (payout) via API.
- [Cálculo de split](https://docs.z2pay.com/docs/pt-BR/valores/split.md): Como o Z2Pay divide o valor de um pagamento entre vários recebedores, com exemplos numéricos em centavos.
- [Taxas](https://docs.z2pay.com/docs/pt-BR/valores/taxas.md): Como funcionam as taxas (MDR e fixo) do Z2Pay e como consultar a tabela resolvida da sua conta.
- [Valores: visão geral](https://docs.z2pay.com/docs/pt-BR/valores/visao-geral.md): Como o dinheiro flui no Z2Pay: centavos, moeda BRL, taxas, split e liquidação na carteira até o saque.
- [Catálogo de eventos](https://docs.z2pay.com/docs/pt-BR/webhooks/eventos.md): Lista completa dos eventos que você pode assinar via webhook na Z2Pay, agrupados por recurso.
- [Webhooks: visão geral](https://docs.z2pay.com/docs/pt-BR/webhooks/visao-geral.md): Como o Z2Pay entrega eventos no seu servidor, qual é o formato do payload e como verificar a assinatura HMAC-SHA256.

## OpenAPI Specs

- [psp](https://docs.z2pay.com/docs/openapi/psp.json)
- [checkout](https://docs.z2pay.com/docs/openapi/checkout.json)
- [billing](https://docs.z2pay.com/docs/openapi/billing.json)