# WovePay > Documentação oficial da API WovePay: PIX, cripto, webhooks, conta, MED, cobranças e subcontas para integradores. ## Atual — Guias — Começar - [Primeira integração](https://docs.WovePay.com.br/pages/guides/primeira-integracao.md): Do zero ao primeiro PIX recebido — chave de API, saldo, cobrança e webhook - [Conceitos fundamentais](https://docs.WovePay.com.br/pages/guides/conceitos.md): Conta, trilhos PIX, saldo, verificação, subcontas e envelope da API ## Atual — Guias — Integração - [Chaves de API](https://docs.WovePay.com.br/pages/guides/authentication.md): Criar, rotacionar e proteger wp_live_ — header X-API-Key, trilho e IP allowlist - [Permissões da API key](https://docs.WovePay.com.br/pages/guides/api-permissions.md): Lista completa de permissões por rota e presets read, write e full - [Rotas da API pública](https://docs.WovePay.com.br/api-reference/escopo-api-publica.md): Todas as rotas /v1 disponíveis com chave wp_live_ - [Erros e códigos HTTP](https://docs.WovePay.com.br/api-reference/guides/errors.md): Envelope de erro da API v1, status comuns e boas práticas ## Atual — Guias — Tutoriais - [Criar chave de API](https://docs.WovePay.com.br/tutorials/api-key.md): Passo a passo no dashboard: acessar API, criar, configurar e copiar o secret wp_live_ - [Receber PIX](https://docs.WovePay.com.br/pages/guides/receber-pix.md): Tutorial: gerar QR, exibir no checkout, confirmar pagamento e reconciliar - [Recuperador de vendas](https://docs.WovePay.com.br/pages/guides/recuperador-vendas.md): Tutorial: buscar cobranças pendentes, extrair dados do cliente do link de pagamento e montar fluxos de recuperação - [Webhooks na prática](https://docs.WovePay.com.br/pages/guides/webhooks-pratica.md): Endpoint, cadastro, validação HMAC, idempotência e eventos essenciais - [WebSocket na prática](https://docs.WovePay.com.br/pages/guides/websocket-pratica.md): Conecte um bot ou worker à WovePay e receba payment.paid sem webhook HTTP. - [Integração com IA](https://docs.WovePay.com.br/pages/guides/integracao-ia.md): Use llms.txt, OpenAPI e a documentação WovePay em assistentes de código e agentes ## Atual — Guias — Ajuda - [Perguntas frequentes](https://docs.WovePay.com.br/pages/faq/index.md): Respostas sobre API key, trilhos, webhooks e integração com IA - [Troubleshooting](https://docs.WovePay.com.br/pages/guides/troubleshooting.md): Problemas comuns na integração com a API WovePay - [Glossário](https://docs.WovePay.com.br/pages/glossario.md): Termos da API e da plataforma WovePay ## Atual — API Reference — Introdução - [Visão geral](https://docs.WovePay.com.br/api-reference/overview.md): Base URL, chave de API e formato das respostas - [Rate limiting](https://docs.WovePay.com.br/api-reference/rate-limiting.md): Limites de requisição na API pública WovePay ## Atual — API Reference — Webhooks - [Webhooks](https://docs.WovePay.com.br/api-reference/guides/webhooks.md): Receba eventos da WovePay no seu servidor — configuração, eventos, assinatura HMAC e API. ## Atual — API Reference — Webhooks — Endpoints - [Cadastrar webhook](https://docs.WovePay.com.br/api-reference/endpoint/webhooks/create.md): Cadastra URL de eventos vinculada à API key. - [Listar webhooks](https://docs.WovePay.com.br/api-reference/endpoint/webhooks/list.md): Lista webhooks da API key. - [Consultar webhook](https://docs.WovePay.com.br/api-reference/endpoint/webhooks/get.md): Consulta webhook pelo ID. - [Atualizar webhook](https://docs.WovePay.com.br/api-reference/endpoint/webhooks/update.md): Atualiza URL, eventos ou status. - [Revogar webhook](https://docs.WovePay.com.br/api-reference/endpoint/webhooks/delete.md): Desativa e remove o endpoint. ## Atual — API Reference — WebSocket - [WebSocket](https://docs.WovePay.com.br/api-reference/guides/websocket.md): Receba eventos em tempo real sem porta pública — autenticação, subscribe com wildcards, ACK, heartbeat e segurança. ## Atual — API Reference — PIX - [Guia de integração PIX](https://docs.WovePay.com.br/api-reference/guides/pix.md): Receber PIX, enviar PIX, reembolsar depósitos, transferências programadas, PIX automático e disputas MED pela API pública. ## Atual — API Reference — PIX — Receber - [Criar cobrança PIX](https://docs.WovePay.com.br/api-reference/endpoint/payment-pix/create.md): Gera QR Code para o cliente pagar. - [Consultar cobrança PIX](https://docs.WovePay.com.br/api-reference/endpoint/payment-pix/get.md): Consulta cobrança PIX (receber) pelo ID interno WovePay ou `externalReference`. - [Listar cobranças PIX](https://docs.WovePay.com.br/api-reference/endpoint/payment-pix/list.md): Lista cobranças PIX (PIX_IN) com paginação e filtros. ## Atual — API Reference — PIX — Enviar - [Enviar PIX](https://docs.WovePay.com.br/api-reference/endpoint/transfer-pix/create.md): Envia PIX para chave PIX ou copia e cola (BR Code). - [Consultar envio PIX](https://docs.WovePay.com.br/api-reference/endpoint/transfer-pix/get.md): Consulta envio PIX (PIX_OUT) pelo ID interno ou `externalReference`. - [Listar envios PIX](https://docs.WovePay.com.br/api-reference/endpoint/transfer-pix/list.md): Lista transferências PIX (PIX_OUT) com paginação e filtros. ## Atual — API Reference — PIX — Programadas - [Criar programação](https://docs.WovePay.com.br/api-reference/endpoint/transfer-scheduled/create.md): Agenda transferência única, recorrente ou automática por saldo. - [Listar programações](https://docs.WovePay.com.br/api-reference/endpoint/transfer-scheduled/list.md): Lista transferências programadas ativas, pausadas e concluídas. - [Consultar programação](https://docs.WovePay.com.br/api-reference/endpoint/transfer-scheduled/get.md): Retorna uma programação de transferência por id. - [Atualizar programação](https://docs.WovePay.com.br/api-reference/endpoint/transfer-scheduled/update.md): Pausar, retomar ou alterar data, recorrência e limiares. - [Cancelar programação](https://docs.WovePay.com.br/api-reference/endpoint/transfer-scheduled/cancel.md): Encerra uma programação de transferência. - [Executar agora](https://docs.WovePay.com.br/api-reference/endpoint/transfer-scheduled/run-now.md): Dispara manualmente uma programação de transferência. ## Atual — API Reference — PIX — Reembolso - [Solicitar reembolso PIX](https://docs.WovePay.com.br/api-reference/endpoint/refunds/create.md): Devolve um depósito PIX recebido (estorno no SPI). - [Consultar reembolso PIX](https://docs.WovePay.com.br/api-reference/endpoint/refunds/get.md): Consulta estorno por ID da transação, refundId ou e2eId. - [Listar reembolsos PIX](https://docs.WovePay.com.br/api-reference/endpoint/refunds/list.md): Lista depósitos com estorno solicitado, em andamento ou concluído. ## Atual — API Reference — PIX — MED - [Listar disputas MED](https://docs.WovePay.com.br/api-reference/endpoint/meds/list.md): Lista disputas MED do trilho PADRAO com paginação e filtros. - [Consultar disputa MED](https://docs.WovePay.com.br/api-reference/endpoint/meds/get.md): Consulta por id, protocol ou providerInfractionId. - [Enviar evidências MED](https://docs.WovePay.com.br/api-reference/endpoint/meds/evidence.md): Envia defesa enquanto status for OPEN. JSON ou multipart. ## Atual — API Reference — Conta - [Conta](https://docs.WovePay.com.br/api-reference/guides/conta.md): Saldo disponível no trilho PADRAO, extrato unificado, transferência interna e recarga de celular. ## Atual — API Reference — Conta — Saldo e extrato - [Saldo da conta](https://docs.WovePay.com.br/api-reference/endpoint/account/balance.md): Saldo disponível e pendente no trilho PADRAO. - [Extrato da conta](https://docs.WovePay.com.br/api-reference/endpoint/account/transactions.md): Lista todas as transações da conta com paginação e filtros. ## Atual — API Reference — Conta — Transferência interna - [Transferência interna](https://docs.WovePay.com.br/api-reference/endpoint/transfer-internal/create.md): Transfere saldo entre contas WovePay pelo e-mail do destinatário. Sem taxa. - [Consultar transferência interna](https://docs.WovePay.com.br/api-reference/endpoint/transfer-internal/get.md): Consulta transferência interna pelo ID. - [Listar transferências internas](https://docs.WovePay.com.br/api-reference/endpoint/transfer-internal/list.md): Lista envios e recebimentos internos (INTERNAL_TRANSFER_*) com paginação e filtros. ## Atual — API Reference — Loja - [Loja (Vendas)](https://docs.WovePay.com.br/api-reference/guides/loja.md): API pública v1 para clientes, produtos, cupons e links de pagamento. ## Atual — API Reference — Loja — Clientes - [Cadastrar cliente](https://docs.WovePay.com.br/api-reference/endpoint/customers/create.md): Cadastra pagador (CPF/CNPJ) para cobranças e assinaturas. - [Consultar cliente](https://docs.WovePay.com.br/api-reference/endpoint/customers/get.md): Por `id` interno ou `externalId` do cliente. - [Listar clientes](https://docs.WovePay.com.br/api-reference/endpoint/customers/list.md): Lista clientes de cobrança da conta. - [Atualizar cliente](https://docs.WovePay.com.br/api-reference/endpoint/customers/update.md): Atualiza dados do cliente. - [Excluir cliente](https://docs.WovePay.com.br/api-reference/endpoint/customers/delete.md): Remove cliente do cadastro. ## Atual — API Reference — Loja — Produtos - [Criar produto](https://docs.WovePay.com.br/api-reference/endpoint/products/create.md): Cadastra produto e regras de entrega digital. - [Consultar produto](https://docs.WovePay.com.br/api-reference/endpoint/products/get.md): Consulta um produto pelo ID. - [Listar produtos](https://docs.WovePay.com.br/api-reference/endpoint/products/list.md): Lista o catálogo de produtos com paginação. - [Atualizar produto](https://docs.WovePay.com.br/api-reference/endpoint/products/update.md): Atualiza um produto. - [Excluir produto](https://docs.WovePay.com.br/api-reference/endpoint/products/delete.md): Exclui um produto. ## Atual — API Reference — Loja — Cupons - [Criar cupom](https://docs.WovePay.com.br/api-reference/endpoint/coupons/create.md): Cria cupom de desconto para links de pagamento. - [Consultar cupom](https://docs.WovePay.com.br/api-reference/endpoint/coupons/get.md): Consulta um cupom pelo ID. - [Listar cupons](https://docs.WovePay.com.br/api-reference/endpoint/coupons/list.md): Lista cupons com paginação. - [Atualizar cupom](https://docs.WovePay.com.br/api-reference/endpoint/coupons/update.md): Atualiza um cupom. - [Excluir cupom](https://docs.WovePay.com.br/api-reference/endpoint/coupons/delete.md): Exclui um cupom. - [Validar cupom](https://docs.WovePay.com.br/api-reference/endpoint/coupons/validate.md): Valida cupom e retorna valor com desconto antes do checkout. ## Atual — API Reference — Loja — Links de pagamento - [Criar link de pagamento](https://docs.WovePay.com.br/api-reference/endpoint/payment-links/create.md): Cria um link reutilizável com checkout hospedado WovePay. - [Consultar link de pagamento](https://docs.WovePay.com.br/api-reference/endpoint/payment-links/get.md): Consulta um link de pagamento pelo ID. - [Listar links de pagamento](https://docs.WovePay.com.br/api-reference/endpoint/payment-links/list.md): Lista links de pagamento com paginação. - [Atualizar link de pagamento](https://docs.WovePay.com.br/api-reference/endpoint/payment-links/update.md): Atualiza configuração de um link de pagamento. - [Ativar ou desativar link](https://docs.WovePay.com.br/api-reference/endpoint/payment-links/status.md): Ativa ou desativa um link de pagamento. - [Excluir link de pagamento](https://docs.WovePay.com.br/api-reference/endpoint/payment-links/delete.md): Exclui um link de pagamento. - [Consultar sessão de checkout](https://docs.WovePay.com.br/api-reference/endpoint/payment-links/sessions-get.md): Consulta status da sessão de checkout. ## Atual — API Reference — Subcontas - [Subcontas merchant](https://docs.WovePay.com.br/api-reference/guides/subcontas.md): Carteiras lógicas sob a conta principal: CRUD, saldo, limites, PIX com subaccountId e pricing. ## Atual — API Reference — Subcontas — Gerenciar - [Criar subconta](https://docs.WovePay.com.br/api-reference/endpoint/subaccount/create.md): Cria subconta merchant (KYC PF/PJ) e, opcionalmente, já habilita o Portal Wallet com e-mail e senha. - [Consultar subconta](https://docs.WovePay.com.br/api-reference/endpoint/subaccount/get.md): Retorna subconta por ID interno WovePay. - [Consultar subconta por referência](https://docs.WovePay.com.br/api-reference/endpoint/subaccount/get-by-ref.md): Retorna subconta pelo externalReference informado na criação. - [Listar subcontas](https://docs.WovePay.com.br/api-reference/endpoint/subaccount/list.md): Lista subcontas da conta com paginação. - [Atualizar subconta](https://docs.WovePay.com.br/api-reference/endpoint/subaccount/update.md): Altera nome e/ou status da subconta. - [Excluir subconta](https://docs.WovePay.com.br/api-reference/endpoint/subaccount/delete.md): Remove a subconta da sua conta quando o saldo estiver zerado. ## Atual — API Reference — Subcontas — Saldo e movimentação - [Saldo da subconta](https://docs.WovePay.com.br/api-reference/endpoint/subaccount/balance.md): Consulta saldo por id ou externalReference. - [Adicionar saldo à subconta](https://docs.WovePay.com.br/api-reference/endpoint/subaccount/add-balance.md): Transfere saldo da conta principal para a subconta. - [Remover saldo da subconta](https://docs.WovePay.com.br/api-reference/endpoint/subaccount/remove-balance.md): Transfere saldo da subconta de volta à conta principal. - [Transferir entre subcontas](https://docs.WovePay.com.br/api-reference/endpoint/subaccount/transfer.md): Move saldo entre duas subcontas da mesma conta principal. ## Atual — API Reference — Subcontas — Controles - [Bloquear subconta](https://docs.WovePay.com.br/api-reference/endpoint/subaccount/lock.md): Aplica modo de bloqueio operacional na subconta. - [Desbloquear subconta](https://docs.WovePay.com.br/api-reference/endpoint/subaccount/unlock.md): Remove bloqueio operacional da subconta. - [Definir limites da subconta](https://docs.WovePay.com.br/api-reference/endpoint/subaccount/set-limits.md): Configura limites diário, mensal e por transação. - [Definir taxas da subconta](https://docs.WovePay.com.br/api-reference/endpoint/subaccount/set-pricing.md): Acréscimo de taxa PIX entrada/saída somado à taxa da conta principal. - [Consultar taxas da subconta](https://docs.WovePay.com.br/api-reference/endpoint/subaccount/pricing.md): Preview das taxas PIX entrada/saída com markup da subconta. ## Atual — API Reference — Subcontas — Portal Wallet - [Status do Portal Wallet](https://docs.WovePay.com.br/api-reference/endpoint/subaccount/portal/status.md): Consulta o estado do login do operador na subconta. - [Configurar Portal Wallet](https://docs.WovePay.com.br/api-reference/endpoint/subaccount/portal/setup.md): Cria ou redefine e-mail e senha do operador na subconta. - [Alterar e-mail do Portal Wallet](https://docs.WovePay.com.br/api-reference/endpoint/subaccount/portal/update-email.md): Atualiza o e-mail de login do operador da subconta. - [Revogar Portal Wallet](https://docs.WovePay.com.br/api-reference/endpoint/subaccount/portal/revoke.md): Desativa o acesso do operador ao wallet da subconta. - [Resetar 2FA do Portal Wallet](https://docs.WovePay.com.br/api-reference/endpoint/subaccount/portal/reset-2fa.md): Remove o segundo fator do operador da subconta. ## Atual — MCP — Começar - [MCP Server](https://docs.WovePay.com.br/pages/mcp/overview.md): Servidor Model Context Protocol oficial da WovePay — API, docs e ferramentas compostas para agentes - [Autenticação MCP](https://docs.WovePay.com.br/pages/mcp/authentication.md): Como passar a API key para o WovePay MCP Server (stdio e HTTP remoto) ## Atual — MCP — Configurar - [Cursor](https://docs.WovePay.com.br/pages/mcp/cursor.md): Configure o WovePay MCP Server no Cursor (stdio local ou remoto HTTP) - [Claude Desktop](https://docs.WovePay.com.br/pages/mcp/claude-desktop.md): Configure o WovePay MCP Server no Claude Desktop - [Servidor remoto](https://docs.WovePay.com.br/pages/mcp/remote.md): mcp.WovePay.com.br — endpoint HTTP, health check e deploy ## Atual — MCP — Referência - [Tools](https://docs.WovePay.com.br/pages/mcp/tools.md): Referência de tools do WovePay MCP — discovery, auto-geradas, compostas e docs - [Prompts](https://docs.WovePay.com.br/pages/mcp/prompts.md): Prompts MCP registrados pelo WovePay MCP Server para fluxos comuns - [Exemplos](https://docs.WovePay.com.br/pages/mcp/examples.md): Prompts e fluxos prontos para usar com o WovePay MCP Server ## OpenAPI Specs - [openapi](https://docs.WovePay.com.br/openapi.yaml)