> ## Documentation Index
> Fetch the complete documentation index at: https://bukio.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Documentação WyzeCash

> 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.

A WyzeCash é um gateway de pagamentos: **Pix, cartão de crédito e cripto**. A API existe para você cobrar sem construir a parte difícil: QR Code e Copia e Cola, página de pagamento no cartão, endereço e cotação da cripto, conciliação, aviso de pagamento com reenvio, controle de saldo, saques.

O ciclo é sempre o mesmo, e vale entender antes de escrever qualquer linha:

1. **Você cria a cobrança** com o valor, a forma de pagamento (`pix`, `card` ou `crypto`) e, se quiser, uma descrição e o cliente.
2. **A resposta traz o que o cliente precisa para pagar:** no Pix, o código Copia e Cola, que também vira QR Code; no cartão, o link da página de pagamento; na cripto, o valor na moeda e o endereço.
3. **O cliente paga** no app do banco, na página segura do cartão ou na carteira dele. Você não participa desse passo, e é de propósito: nenhum dado bancário ou de cartão passa pelo seu servidor.
4. **A gente avisa.** Um `POST` assinado na sua URL, o valor entra no seu saldo e a situação fica disponível para consulta quando você quiser.

A API é REST sobre JSON e autentica com um cabeçalho. Não existe SDK obrigatório: qualquer linguagem que faça requisição HTTP integra, e os exemplos daqui vêm em cURL, JavaScript, Python e PHP.

> [!TIP]
>
> **Vai usar com uma IA?** Passe este link para ela ler a documentação inteira, em texto simples: [https://bukio-backend-production.up.railway.app/llms-full.txt](https://bukio-backend-production.up.railway.app/llms-full.txt). O índice fica em [llms.txt](https://bukio-backend-production.up.railway.app/llms.txt), e no Claude, Cursor ou VS Code também dá para usar o [MCP da WyzeCash](https://bukio.mintlify.site/mcp/visao-geral.md).

> [card] [Sua primeira cobrança](https://bukio.mintlify.site/inicio-rapido.md)
>
> Do zero ao Pix recebido, em quatro passos.

> [card] [Referência da API](https://bukio.mintlify.site/referencia/visao-geral.md)
>
> Os 35 endpoints, com playground para testar na hora.

> [card] [Webhooks](https://bukio.mintlify.site/webhooks/configurar.md)
>
> Como a gente te avisa, e como você confere que fomos nós.

> [card] [Antes de ir para produção](https://bukio.mintlify.site/producao.md)
>
> A lista curta do que costuma quebrar no primeiro dia.

## O caminho mais curto

**1. Pegue a chave de API**

No painel, em **Integrações e API › Chaves de API**, crie uma chave `bk_live_`. Ela é mostrada uma vez só.

**2. Crie a cobrança**

```bash theme={null}
curl -X POST https://bukio-backend-production.up.railway.app/v1/payments \
  -H "Authorization: Bearer bk_live_SUA_CHAVE" \
  -H "Idempotency-Key: pedido-1842" \
  -H "Content-Type: application/json" \
  -d '{ "amount": 15000, "description": "Pedido 1842" }'
```

A resposta traz `copyPaste`: o código Pix Copia e Cola da cobrança `BKY-...`.

**3. Mostre para quem vai pagar**

Como QR Code (qualquer biblioteca gera a imagem a partir do `copyPaste`) e como texto com botão "Copiar".

**4. Receba o aviso**

Cadastre a URL do seu servidor em **Integrações e API › Webhooks**. Quando o Pix cair, chega um `payment.paid` assinado. Valide a assinatura e libere o pedido.

## O que dá para fazer

| Recurso | O que faz |
| - | - |
| [Cobranças](https://bukio.mintlify.site/endpoints/cobrancas.md) | criar e consultar cobranças (`BKY-`) por Pix, cartão de crédito ou cripto |
| [Links de pagamento](https://bukio.mintlify.site/endpoints/links-de-pagamento.md) | uma página de pagamento pronta (`LNK-`), sem tela para programar |
| [Saldo e extrato](https://bukio.mintlify.site/endpoints/saldo.md) | saldo disponível, bloqueado e todas as movimentações |
| [Saques](https://bukio.mintlify.site/endpoints/saques.md) | Pix para qualquer chave enviada no pedido ou um Copia e Cola (`SAQ-API-`) |
| [Subcontas](https://bukio.mintlify.site/endpoints/subcontas.md) | saldo atribuído a cada cliente seu, comissão e saque para ele |
| [Clientes](https://bukio.mintlify.site/endpoints/clientes.md) | cadastro de quem paga você |
| [MED](https://bukio.mintlify.site/endpoints/med.md) | pedidos de devolução abertos pelo banco de quem pagou |
| [Webhooks](https://bukio.mintlify.site/webhooks/configurar.md) | avisos assinados no seu servidor a cada evento |

## O que fica no painel

Por segurança, algumas ações só acontecem no painel WyzeCash, com a sua sessão e o código do app autenticador: criar e revogar chaves de API, configurar webhooks, transferências entre contas WyzeCash, estornos, a defesa de um MED e as chaves Pix favoritas usadas no saque. Uma chave de API vazada não consegue desviar os seus webhooks nem cadastrar uma chave Pix nova.

> [!NOTE]
>
> Não existe ambiente de testes: toda chave é de produção e todo Pix é real. Para testar, use valores pequenos.


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