Visão geral da API
O que a API da WysePay faz e como ela funciona.
Com a API você cobra por Pix a partir do seu sistema: gera o QR Code e o código copia e cola para o cliente, cria links de pagamento e é avisado por webhook quando o dinheiro cai.
O que dá para fazer
| Você quer… | Use |
|---|---|
| Mostrar um Pix no seu site ou app | POST /api/v1/charges/pix |
| Mandar um link para o cliente pagar | POST /api/v1/payment-links |
| Saber se uma cobrança foi paga | Webhook transaction.paid ou GET /api/v1/transactions/{id} |
| Conciliar vendas | GET /api/v1/transactions, com paginação |
| Manter os seus clientes | /api/v1/customers |
| Ver o saldo e sacar | /api/v1/balance e /api/v1/withdrawals |
| Testar sem dinheiro real | Modo teste |
Como a API funciona
- Endereço:
https://api.wysepay.com.br. Todas as rotas começam com/api/v1. - Autenticação: a sua chave de API no header
x-api-key(ouAuthorization: Bearer), com as permissões que você der a ela. Veja Autenticação e permissões. - Formato: JSON no corpo e nas respostas, com
Content-Type: application/json. - Valores em centavos:
8990é R$ 89,90. O mínimo de uma cobrança é500(R$ 5,00). - Datas em ISO 8601, UTC: por exemplo,
2026-10-04T15:30:00.000Z. - Teste e produção com o mesmo endereço: o que define o modo é a chave. Uma chave
wyp_test_nunca movimenta dinheiro.
O caminho de um pagamento
Você cria a cobrança. Pela API, com o valor, a descrição e os dados de quem paga. A resposta traz o código Pix.
O cliente paga pelo app do banco, lendo o QR Code ou colando o código.
A WysePay avisa o seu sistema. O webhook transaction.paid chega na sua URL em segundos. É nele que você libera o pedido.
O dinheiro entra no seu saldo, já descontada a taxa, e fica disponível para saque conforme o prazo de liberação da sua conta.
Pronto para tentar? Vá ao Começo rápido.