Começando
A API RevoxPay permite que você integre pagamentos PIX e processamento de saques de forma instantânea em seu sistema. Utilizamos JSON em todas as comunicações.
URL DE PRODUÇÃO
https://revoxpay.com/api/pix/index.php
Checklist de Integração
1. Obtenha sua API Key no painel administrativo.
2. Realize uma chamada POST para gerar um QRCode.
3. Configure sua URL de Webhook para escutar pagamentos aprovados.
Autenticação
Nossa autenticação é simplificada. Todas as requisições devem incluir o campo api_key no
corpo (body) da mensagem enviada via JSON.
MANTENHA SUA CHAVE SEGURA
Nunca exponha sua API Key em código front-end (JavaScript). Todas as chamadas devem ser feitas a partir do seu Servidor (Backend).
Respostas HTTP
Nossa API utiliza códigos de status padrão. Abaixo, listamos os erros mais comuns que você deve tratar no seu sistema.
| Status | Código de Erro | Definição |
|---|---|---|
| 200 OK | - | Sucesso total. Transação criada ou processada. |
| 400 Bad Request | invalid_json |
O corpo da requisição não é um JSON válido. |
| 400 Bad Request | insufficient_balance |
Saldo insuficiente para realizar o saque. |
| 400 Bad Request | invalid_amount |
O valor enviado é menor que o mínimo ou inválido. |
| 401 Unauthorized | auth_failed |
Sua API Key está errada, inativa ou sem permissão. |
| 403 Forbidden | unauthorized_ip |
Requisição bloqueada por segurança (Ips não autorizados). |
Exemplo de Resposta de Erro
{
"status": "error",
"message": "Saldo insuficiente para esta operação",
"error_code": "insufficient_balance",
"current_balance": 15.50
}Gerar QRCode
Cria uma cobrança PIX dinâmica. Por padrão, todos os QRCodes gerados têm validade de 24 horas.
Dica: Envie o objeto payer
para melhorar a rastreabilidade e facilitar a identificação do cliente no seu painel.
Parâmetros da Requisição
| Atributo | Tipo | Descrição |
|---|---|---|
| api_keySim | string | Sua chave secreta da RevoxPay. |
| amountSim | float | Valor bruto do Pix (ex: 20.00). Mínimo: R$ 1.00. |
| requestNumberSim | string | Seu ID único (Referência Externa). |
| payer | object | Objeto com name e document (CPF/CNPJ). |
Notificações (Webhook)
O Webhook é o coração da integração. Nosso servidor notificará sua URL assim que o status do PIX mudar.
SEGURANÇA (IP WHITELISTING)
Para garantir que o webhook veio da RevoxPay, você deve
aceitar apenas requisições dos seguintes IPs:
138.117.216.143, 52.67.217.152
| Status | Descrição |
|---|---|
| PAID | Pagamento confirmado. Libere o crédito/produto. |
| EXPIRED | O tempo de 24h expirou sem pagamento. |
Consultar Status
Verifique manualmente o status de uma transação (Polling) caso o Webhook falhe.
Uso: Recomendamos checar a cada 30 segundos.
Parâmetros (Query String ou JSON)
| Atributo | Tipo | Definição |
|---|---|---|
| api_keySim | string | Sua chave de API. |
| requestNumberSim | string | O ID que você enviou ao gerar o PIX. |
Realizar Saque (Cashout)
Envie pagamentos PIX para seus clientes de forma automatizada e instantânea.
TAXAS
Consulte sua taxa de saque no menu Configurações do painel.
Dicionário de Chaves
| Tipo | Descrição / Formato |
|---|---|
| CPF | Apenas números do documento. |
| CNPJ | Apenas números do documento empresarial. |
| Email válido do recebedor. | |
| PHONE | Formato Internacional: +55119... |
| EVP | Chave aleatória geratriz. |