# API WyzeCash

> Documentação para integrar com a WyzeCash: chave de API, cobranças por Pix, cartão e cripto, saques, Pix enviado, subcontas e webhooks.

- [Documentação WyzeCash](https://docs.wyzecash.com.br/index.md): Como integrar pagamentos por Pix, cartão de crédito e cripto na WyzeCash: referência da API, webhooks e o caminho mais curto até o primeiro pagamento recebido.
- [Sua primeira cobrança](https://docs.wyzecash.com.br/inicio-rapido.md): Da chave de API ao primeiro Pix recebido, em quatro passos.
- [Autenticação](https://docs.wyzecash.com.br/autenticacao.md): Como autenticar as chamadas: formato da chave de API, permissões (escopos), IPs liberados, validade e revogação.
- [Antes de ir para produção](https://docs.wyzecash.com.br/producao.md): A lista curta do que costuma quebrar no primeiro dia.
- [Cobranças](https://docs.wyzecash.com.br/endpoints/cobrancas.md): Crie cobranças por Pix (QR Code e Copia e Cola), cartão de crédito (página de pagamento) ou cripto (endereço e valor na moeda), consulte a situação e saiba quem pagou.
- [Links de pagamento](https://docs.wyzecash.com.br/endpoints/links-de-pagamento.md): Uma página de pagamento pronta: crie o link, mande para o cliente e cada pagamento (Pix, cartão ou cripto) vira uma cobrança.
- [Saldo e tarifas](https://docs.wyzecash.com.br/endpoints/saldo.md): Saldo disponível, bloqueado, o valor mínimo do saque e a prévia da tarifa de uma operação.
- [Extrato](https://docs.wyzecash.com.br/endpoints/transacoes.md): Todas as movimentações da conta, com filtros por tipo e situação e paginação por cursor.
- [Saques](https://docs.wyzecash.com.br/endpoints/saques.md): Tire o saldo da conta para a chave Pix que você envia, com idempotência e acompanhamento.
- [Subcontas](https://docs.wyzecash.com.br/endpoints/subcontas.md): Atribua vendas a cada cliente seu, envie, transfira, divida a venda e saque para a chave Pix dele.
- [Clientes](https://docs.wyzecash.com.br/endpoints/clientes.md): Cadastre quem paga você e ligue cada cobrança a um cliente.
- [MED (devoluções)](https://docs.wyzecash.com.br/endpoints/med.md): Acompanhe pela API os pedidos de devolução abertos pelo banco de quem pagou e o valor bloqueado.
- [Entrar com a WyzeCash (OAuth)](https://docs.wyzecash.com.br/oauth.md): Ponha o botão "Entrar com a WyzeCash" no seu sistema: a pessoa entra com a conta WyzeCash dela e você lê só o nome e o resumo de vendas.
- [SDK para Node.js](https://docs.wyzecash.com.br/sdk/node.md): O pacote oficial wyzecash: cobranças, saques, subcontas, webhooks e tempo real com tipos e mensagens em português, sem dependências.
- [TypeScript](https://docs.wyzecash.com.br/sdk/typescript.md): O SDK wyzecash já é TypeScript: tipos de cada pedido, resposta e evento, com a descrição em português no editor.
- [SDK para Python](https://docs.wyzecash.com.br/sdk/python.md): O pacote oficial wyzecash para Python 3.10+: cobranças, saques, subcontas e webhooks com tipos e mensagens em português, sem dependências.
- [Go](https://docs.wyzecash.com.br/sdk/go.md): Integre a WyzeCash em Go só com a biblioteca padrão: um cliente pronto para copiar, com idempotência, novas tentativas seguras, listas, erros, webhooks e tempo real.
- [SDK para PHP](https://docs.wyzecash.com.br/sdk/php.md): O pacote oficial wyzecash/wyzecash para PHP 8.1+: cobranças, saques, subcontas e webhooks, só com cURL, e com a integração para o Laravel.
- [Convenções](https://docs.wyzecash.com.br/convencoes.md): Centavos, datas, identificadores, idempotência, paginação por cursor e cabeçalhos.
- [Erros](https://docs.wyzecash.com.br/erros.md): Formato de erro e todos os códigos que a API pode responder, com a mensagem em português pronta para o usuário.
- [Limites de requisição](https://docs.wyzecash.com.br/limites.md): 100 por minuto no geral, 20 por minuto em saque. E como não bater neles.
- [Como funcionam os webhooks](https://docs.wyzecash.com.br/webhooks/configurar.md): Quem avisa quem, o que a sua URL precisa ter e o que acontece quando ela cai.
- [Validando a assinatura](https://docs.wyzecash.com.br/webhooks/assinatura.md): Confira o X-Bukio-Signature de todo webhook antes de confiar nele, com exemplos em Node.js, PHP e Python.
- [Cobranças](https://docs.wyzecash.com.br/webhooks/cobrancas.md): payment.created, payment.paid, payment.expired e payment.refunded: quando disparam, o corpo e o jeito certo de tratar.
- [Saques](https://docs.wyzecash.com.br/webhooks/saques.md): withdrawal.requested, withdrawal.completed e withdrawal.failed: o ciclo de um saque visto pelo seu servidor.
- [Transferências](https://docs.wyzecash.com.br/webhooks/transferencias.md): transfer.received e transfer.sent: transferências entre contas WyzeCash, que são feitas no painel e avisadas pela API.
- [Subcontas](https://docs.wyzecash.com.br/webhooks/subcontas.md): subaccount.credited e subaccount.debited: cada movimento SUB- que muda o saldo de uma subconta.
- [WebSocket](https://docs.wyzecash.com.br/webhooks/websocket.md): Receba os eventos da sua conta na hora, sem precisar de um endereço HTTPS seu: entrada com a chave, inscrições, ping, reenvio do que perdeu, erros e limites.
- [Visão geral](https://docs.wyzecash.com.br/referencia/visao-geral.md): 38 endpoints, um formato de erro, uma autenticação. Com playground para testar aqui mesmo.
- [Consultar saldo](https://docs.wyzecash.com.br/referencia/saldo/consultar-saldo.md): Saldo disponível, a parte das subcontas e o que é só seu, o bloqueado, o que falta cobrir de MED e o valor mínimo do saque.
- [Prévia da tarifa](https://docs.wyzecash.com.br/referencia/saldo/previa-tarifa.md): Quanto a WyzeCash vai cobrar numa operação, para mostrar antes de confirmar.
- [Criar cobrança](https://docs.wyzecash.com.br/referencia/cobrancas/criar-cobranca.md): Gera uma cobrança (BKY-) por Pix (Copia e Cola, que também vira QR Code), cartão de crédito (link da página de pagamento) ou cripto (valor na moeda e endereço).
- [Listar cobranças](https://docs.wyzecash.com.br/referencia/cobrancas/listar-cobrancas.md): As cobranças da conta, da mais nova para a mais antiga, com filtros e paginação por cursor.
- [Consultar cobrança](https://docs.wyzecash.com.br/referencia/cobrancas/consultar-cobranca.md): A situação atual de uma cobrança, com quem pagou quando já estiver paga.
- [Formas de pagamento](https://docs.wyzecash.com.br/referencia/cobrancas/formas-de-pagamento.md): As formas que a conta pode usar agora (Pix, cartão de crédito e cripto), com a faixa de valor e as moedas aceitas.
- [Criar link](https://docs.wyzecash.com.br/referencia/links-de-pagamento/criar-link.md): Cria um link (LNK-) com página de pagamento pronta. Cada pagamento vira uma cobrança BKY-.
- [Listar links](https://docs.wyzecash.com.br/referencia/links-de-pagamento/listar-links.md): Todos os links da conta, do mais novo para o mais antigo, com a contagem de pagamentos de cada um.
- [Consultar link](https://docs.wyzecash.com.br/referencia/links-de-pagamento/consultar-link.md): Um link da conta, com situação e contagem de pagamentos.
- [Editar link](https://docs.wyzecash.com.br/referencia/links-de-pagamento/editar-link.md): Muda qualquer campo do link. Pausar é mandar active: false.
- [Excluir link](https://docs.wyzecash.com.br/referencia/links-de-pagamento/excluir-link.md): O link para de funcionar na hora. As cobranças já geradas por ele continuam.
- [Cobranças do link](https://docs.wyzecash.com.br/referencia/links-de-pagamento/cobrancas-do-link.md): As cobranças BKY- geradas por um link, das mais novas para as mais antigas.
- [Listar movimentações](https://docs.wyzecash.com.br/referencia/extrato/listar-movimentacoes.md): O livro-razão da conta: toda entrada e saída, com filtros por tipo e situação.
- [Consultar movimentação](https://docs.wyzecash.com.br/referencia/extrato/consultar-movimentacao.md): Uma movimentação do extrato pelo código com prefixo.
- [Extrato resumido](https://docs.wyzecash.com.br/referencia/extrato/extrato-resumido.md): O extrato como o painel mostra: movimentações, cobranças em aberto e pedidos de MED, com título, cor e totais já calculados.
- [Pedir saque](https://docs.wyzecash.com.br/referencia/saques/pedir-saque.md): Manda o saldo disponível por Pix para a chave que você envia no pedido (SAQ-API-).
- [Listar saques](https://docs.wyzecash.com.br/referencia/saques/listar-saques.md): Os saques da conta (pela API, painel, app ou saque automático), do mais novo para o mais antigo.
- [Consultar saque](https://docs.wyzecash.com.br/referencia/saques/consultar-saque.md): A situação atual de um saque, com o EndToEndId quando concluído.
- [Criar subconta](https://docs.wyzecash.com.br/referencia/subcontas/criar-subconta.md): Cria uma subconta (sacc_) para um cliente seu, com comissão por venda, taxa por saque e a chave Pix dele.
- [Listar subcontas](https://docs.wyzecash.com.br/referencia/subcontas/listar-subcontas.md): As subcontas da conta com o saldo atribuído de cada uma e o total atribuído.
- [Consultar subconta](https://docs.wyzecash.com.br/referencia/subcontas/consultar-subconta.md): Uma subconta com o saldo atribuído atual, o e-mail, o metadata e a chave Pix do cliente.
- [Editar subconta](https://docs.wyzecash.com.br/referencia/subcontas/editar-subconta.md): Muda nome, e-mail, identificador, comissão, taxa por saque, metadata, chave Pix, ou ativa e desativa.
- [Configuração das subcontas](https://docs.wyzecash.com.br/referencia/subcontas/configuracao-das-subcontas.md): A taxa global, os limites padrão das subcontas novas e o bloqueio automático por MED.
- [Mudar a configuração das subcontas](https://docs.wyzecash.com.br/referencia/subcontas/mudar-configuracao.md): Muda a taxa global, os limites padrão e o bloqueio automático por MED.
- [Exemplo da taxa das subcontas](https://docs.wyzecash.com.br/referencia/subcontas/exemplo-da-configuracao.md): Quanto fica com você, com a subconta e com a WyzeCash numa venda e num saque, com a taxa informada.
- [Movimentos da subconta](https://docs.wyzecash.com.br/referencia/subcontas/movimentos-da-subconta.md): Os movimentos SUB- de uma subconta, com filtro por período e tipo: vendas, envios, transferências, saques, devoluções, estornos e MED.
- [Devolver à principal](https://docs.wyzecash.com.br/referencia/subcontas/devolver-a-principal.md): Tira um valor do saldo atribuído à subconta. O dinheiro já estava no seu saldo; só deixa de ser do cliente.
- [Enviar para a subconta](https://docs.wyzecash.com.br/referencia/subcontas/enviar-para-subconta.md): Passa parte do seu saldo livre para uma subconta, sem tarifa.
- [Transferir entre subcontas](https://docs.wyzecash.com.br/referencia/subcontas/transferir-entre-subcontas.md): Passa saldo de uma subconta para outra sua, sem tarifa.
- [Saque da subconta](https://docs.wyzecash.com.br/referencia/subcontas/saque-da-subconta.md): Manda o saldo atribuído a uma subconta por Pix para a chave do cliente (a enviada ou a guardada na subconta).
- [Excluir subconta](https://docs.wyzecash.com.br/referencia/subcontas/excluir-subconta.md): Devolve o saldo à conta principal, tira a subconta da API e libera o externalId.
- [Listar clientes](https://docs.wyzecash.com.br/referencia/clientes/listar-clientes.md): Todos os clientes ativos da conta, em lista simples.
- [Consultar cliente](https://docs.wyzecash.com.br/referencia/clientes/consultar-cliente.md): Um cliente da conta.
- [Criar cliente](https://docs.wyzecash.com.br/referencia/clientes/criar-cliente.md): Cadastra quem paga você, para ligar cobranças a ele.
- [Editar cliente](https://docs.wyzecash.com.br/referencia/clientes/editar-cliente.md): Muda nome, e-mail, celular ou documento. null limpa o campo.
- [Excluir cliente](https://docs.wyzecash.com.br/referencia/clientes/excluir-cliente.md): Esconde o cliente. As cobranças antigas continuam com o nome dele.
- [Listar pedidos de MED](https://docs.wyzecash.com.br/referencia/med/listar-meds.md): Os pedidos de devolução (MED-) abertos contra Pix recebidos na conta, do mais novo para o mais antigo.
- [Consultar pedido de MED](https://docs.wyzecash.com.br/referencia/med/consultar-med.md): Um pedido de devolução: valor, quanto está bloqueado, prazo, defesa e decisão.
- [Responder MED](https://docs.wyzecash.com.br/referencia/med/responder-med.md): Manda a defesa de um pedido de MED, com as provas, num pedido só.
- [Servidor MCP](https://docs.wyzecash.com.br/mcp/visao-geral.md): O servidor MCP oficial da WyzeCash: a API, a documentação e prompts prontos para a sua IA.
- [Autenticação MCP](https://docs.wyzecash.com.br/mcp/autenticacao.md): A chave de API é opcional: sem ela, a IA lê a documentação; com ela, usa a sua conta com as permissões da chave.
- [Configurar no Cursor](https://docs.wyzecash.com.br/mcp/cursor.md): Conecte o MCP da WyzeCash ao Cursor pelo HTTP, sem instalar nada.
- [Configurar no Claude Code](https://docs.wyzecash.com.br/mcp/claude-code.md): Conecte o MCP da WyzeCash ao Claude Code com um comando.
- [Configurar no Codex](https://docs.wyzecash.com.br/mcp/codex.md): Conecte o MCP da WyzeCash ao Codex pelo arquivo de configuração.
- [Configurar no VS Code](https://docs.wyzecash.com.br/mcp/vscode.md): Conecte o MCP da WyzeCash ao chat do VS Code, no modo Agent.
- [Configurar no Claude Desktop](https://docs.wyzecash.com.br/mcp/claude-desktop.md): Conecte o MCP da WyzeCash ao Claude Desktop pelo arquivo de configuração.
- [Ferramentas](https://docs.wyzecash.com.br/mcp/ferramentas.md): As ferramentas do MCP da WyzeCash: documentação e código sem chave, e as da sua conta com a chave de API.
- [Prompts](https://docs.wyzecash.com.br/mcp/prompts.md): Os dez prompts prontos do MCP da WyzeCash, cada um com os endpoints que usa.
- [Cobrança Pix](https://docs.wyzecash.com.br/mcp/prompts/criar-cobranca-pix.md): Integra a cobrança Pix no seu sistema: código, QR Code e webhook.
- [Cobrança no cartão](https://docs.wyzecash.com.br/mcp/prompts/cobranca-cartao.md): Integra a venda no cartão de crédito: a página segura de pagamento e o webhook.
- [Cobrança em cripto](https://docs.wyzecash.com.br/mcp/prompts/cobranca-cripto.md): Integra o pagamento em cripto: moeda, valor, endereço e webhook.
- [Link de pagamento](https://docs.wyzecash.com.br/mcp/prompts/link-de-pagamento.md): Cria um link de pagamento pronto e acompanha as vendas dele.
- [Receber os webhooks](https://docs.wyzecash.com.br/mcp/prompts/configurar-webhook.md): Cria a rota que recebe os avisos da WyzeCash, confere a assinatura e trata cada evento.
- [Conferir a assinatura](https://docs.wyzecash.com.br/mcp/prompts/verificar-assinatura.md): Só a função que confere o cabeçalho X-Bukio-Signature, com um teste.
- [Saldo e extrato](https://docs.wyzecash.com.br/mcp/prompts/saldo-e-extrato.md): Mostra o saldo, o extrato e as tarifas da conta, só para consultar.
- [Subcontas](https://docs.wyzecash.com.br/mcp/prompts/subcontas.md): Separa o saldo de cada cliente seu em subcontas e divide as vendas.
- [MED](https://docs.wyzecash.com.br/mcp/prompts/med.md): Acompanha os pedidos de devolução (MED) das vendas no Pix.
- [Testar a chave](https://docs.wyzecash.com.br/mcp/prompts/testar-chave.md): Confere se a chave configurada na IA funciona e o que ela pode fazer.
- [Exemplos](https://docs.wyzecash.com.br/mcp/exemplos.md): O que pedir para a IA e o que ela faz por trás, ferramenta por ferramenta.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.