# Docs - [Documentação da WysePay](/): Receba por Pix pela API, por links de pagamento ou direto pelo painel. - API: Integre cobranças Pix no seu sistema - [Visão geral da API](/api): O que a API da WysePay faz e como ela funciona. - [Começo rápido](/api/comeco-rapido): Gere um Pix de teste, simule o pagamento e receba o webhook, sem dinheiro real. - **Conceitos** - [Autenticação e permissões](/api/autenticacao): Chaves de API, modo teste e produção, permissões por recurso e IPs permitidos. - [Cobranças Pix](/api/cobrancas-pix): Gere um Pix para o cliente pagar e acompanhe até a confirmação. - [Links de pagamento](/api/links-de-pagamento): Um checkout pronto, com a sua marca, para enviar ao cliente. - [Clientes](/api/clientes): A carteira de clientes da conta, um por CPF ou CNPJ. - [Saldo e saques](/api/saques): Consulte o saldo e saque para uma chave Pix pela API, com segurança. - [Webhooks](/api/webhooks): Seja avisado no seu servidor quando um pagamento é confirmado. - [Modo teste](/api/modo-teste): Integre e teste o caminho completo sem dinheiro real. - [Paginação](/api/paginacao): Como percorrer listas de transações, links, clientes e saques. - [Erros](/api/erros): O formato das respostas de erro e o que cada status quer dizer. - [Limites e idempotência](/api/limites-e-idempotencia): Quantas chamadas por minuto e como repetir sem duplicar cobranças. - **Referência** - [Gerar uma cobrança Pix](/api/referencia/gerar-pix): Cria a cobrança e devolve o código Pix (copia e cola e QR Code). O status começa em `WAITING_PAYMENT`; quando o cliente pagar, chega o webhook `transaction.paid`. Permissão da chave: `charges:write`. - [Listar transações](/api/referencia/listar-transacoes): As cobranças da conta, da mais nova para a mais antiga, com filtros. Veja Paginação. Permissão da chave: `transactions:read`. - [Consultar uma transação](/api/referencia/consultar-transacao): A situação atual da cobrança. Um Pix vencido sem pagamento aparece como `EXPIRED`. Permissão da chave: `transactions:read`. - [Criar um link de pagamento](/api/referencia/criar-link): Cria um checkout com o valor e a descrição. Envie a `url` ao cliente: ele preenche os dados, paga com Pix e vê o comprovante. Permissão da chave: `payment_links:write`. - [Listar links de pagamento](/api/referencia/listar-links): Os links da conta, do mais novo para o mais antigo. Permissão da chave: `payment_links:read`. - [Consultar um link](/api/referencia/consultar-link): Um link de pagamento e se ele ainda aceita pagamentos (`active`). Permissão da chave: `payment_links:read`. - [Desativar um link](/api/referencia/desativar-link): O link para de aceitar pagamentos e o checkout mostra que ele não está disponível. Cobranças já geradas continuam valendo. Permissão da chave: `payment_links:write`. - [Cadastrar um cliente](/api/referencia/cadastrar-cliente): Cadastra o cliente, ou atualiza o que já tem esse CPF ou CNPJ (há um cliente por documento). Campos não enviados ficam como estavam. Permissão da chave: `customers:write`. - [Listar clientes](/api/referencia/listar-clientes): Os clientes da conta, do mais novo para o mais antigo. Filtre por `document` para achar um CPF ou CNPJ. Permissão da chave: `customers:read`. - [Consultar um cliente](/api/referencia/consultar-cliente): Os dados e o endereço de um cliente. Permissão da chave: `customers:read`. - [Atualizar um cliente](/api/referencia/atualizar-cliente): Muda os campos enviados. O CPF ou CNPJ não muda. Permissão da chave: `customers:write`. - [Consultar o saldo](/api/referencia/consultar-saldo): Disponível, a liberar e bloqueado, e quanto dá para sacar agora. Permissão da chave: `balance:read`. - [Sacar para uma chave Pix](/api/referencia/sacar): Tira o valor do saldo e envia para a chave Pix. Precisa da permissão `withdrawals:write`, que vem desligada, e respeita o limite diário e os IPs da chave. Com chave de teste, o saque é simulado e pago na hora. Permissão da chave: `withdrawals:write`. - [Listar saques](/api/referencia/listar-saques): Os saques da conta (pelo painel e pela API), do mais novo para o mais antigo. Permissão da chave: `withdrawals:read`. - [Consultar um saque](/api/referencia/consultar-saque): A situação de um saque. Permissão da chave: `withdrawals:read`. - [Simular o pagamento](/api/referencia/simular-pagamento): Só com chave de teste: marca a cobrança de teste como paga e envia o webhook `transaction.paid`, como num pagamento real. Permissão da chave: `charges:write`. - Eventos de webhook - [MED aberto](/api/referencia/eventos/dispute-created): O pagador contestou um pagamento pelo banco dele. - [MED perdido](/api/referencia/eventos/dispute-lost): A devolução foi confirmada: o valor foi devolvido ao pagador. - [MED respondido](/api/referencia/eventos/dispute-responded): A sua defesa do MED foi enviada. - [MED ganho](/api/referencia/eventos/dispute-won): A contestação foi negada: o valor volta a ficar disponível para você. - [Cobrança criada](/api/referencia/eventos/transaction-created): Um Pix foi gerado (pela API, pelo painel ou por um link). - [Cobrança vencida](/api/referencia/eventos/transaction-expired): O Pix passou do `expiresAt` sem pagamento. Cancele o pedido ou gere uma cobrança nova. - [Cobrança paga](/api/referencia/eventos/transaction-paid): O pagamento foi confirmado. Use este evento para liberar o pedido. - [Saque criado](/api/referencia/eventos/withdrawal-created): Um saque foi pedido, pelo painel ou pela API. - [Saque não concluído](/api/referencia/eventos/withdrawal-failed): O saque não foi feito; o valor voltou ao saldo. - [Saque pago](/api/referencia/eventos/withdrawal-paid): O dinheiro chegou na chave Pix de destino. - [Saque pago em parte](/api/referencia/eventos/withdrawal-partially-paid): Parte das transferências do saque não foi concluída; o valor dela voltou ao saldo. - [OpenAPI, Postman e IA](/api/openapi): Baixe a especificação da API, a coleção do Postman e o texto para assistentes de código. - Painel: Guias para quem vende - [Guias do painel](/painel): Tudo o que dá para fazer no painel da WysePay, sem programar. - **Conta e verificação** - [Criar conta e liberar produção](/painel/criar-conta): Do cadastro ao primeiro pagamento real. - [Verificação](/painel/verificacao): Identidade do responsável e, para CNPJ, a verificação da empresa. - **Vender** - [Nova cobrança](/painel/nova-cobranca): Gere um Pix na hora ou crie um link de pagamento. - [Links de pagamento](/painel/links-de-pagamento): Venda sem site: um link com checkout da sua marca. - [Personalizar o checkout](/painel/personalizar-checkout): Logo, cores, fonte e textos do checkout dos seus links. - **Vendas e clientes** - [Vendas](/painel/vendas): Cada venda, paga ou não, e como recuperar as abandonadas. - [Clientes](/painel/clientes): A sua carteira de clientes, um por CPF ou CNPJ. - [Extrato e relatórios](/painel/relatorios): Entradas e saídas do saldo e as exportações para a contabilidade. - **Dinheiro** - [Saldo e saques](/painel/saldo-e-saques): Quando o dinheiro fica disponível e como sacar. - [Taxas e planos](/painel/taxas-e-planos): Como a taxa é cobrada e como escolher o seu plano. - [MED](/painel/med): O que fazer quando um pagamento é contestado. - [Notificações](/painel/notificacoes): Avisos por e-mail e no celular.