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 — PIX (Cash-In)

https://revoxpay.com/api/pix/index.php

URL DE PRODUÇÃO — SAQUE (Cash-Out)

https://revoxpay.com/api/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.

BASE URL (PRODUÇÃO)
# URL para Transações PIX (Cash-In)
https://revoxpay.com/api/pix/index.php

# URL para Saques (Cash-Out)
https://revoxpay.com/api/index.php

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

EXEMPLO DE AUTENTICAÇÃO (JSON)
{
  "api_key": "revox_live_xxxxxxxxxxxxxxxxxxxxx",
  "...": "..."
}

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).
RESULTADO (JSON)
{
  "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 (External ID) para identificar a transação. Retornado no webhook como correlationID.
postback_urlNão string Sua URL de Webhook que receberá o aviso de pagamento aprovado. (Opcional se configurado no painel)
payerSim object Objeto com name, document (CPF/CNPJ) e opcionalmente email e telefone.
PIX CASH-IN — REQUEST (CURL)
curl -X POST https://revoxpay.com/api/pix/index.php \
-H "Content-Type: application/json" \
-d '{
  "api_key": "sua_api_key_aqui",
  "amount": 150.00,
  "requestNumber": "pedido_042",
  "postback_url": "https://seu-site.com/callback.php",
  "payer": {
    "name": "João Silva",
    "document": "12345678900",
    "email": "joao@email.com"
  }
}'
RESPONSE (JSON)
{
  "status": "success",
  "paymentCode": "00020126...",
  "idTransaction": "ORD_998",
  "amount": 150.00
}

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 (VALIDAÇÃO DO WEBHOOK)

Ao receber o webhook, valide o external_id no seu banco de dados antes de creditar qualquer valor. Nunca confie apenas no status.

RevoxPay envia o webhook a partir dos IPs:
138.117.216.143, 52.67.217.152, 177.93.216.143, 18.230.175.116 (PixUP)
54.207.214.244, 18.228.217.68, 52.67.171.187, 177.71.242.172 (Vulcaner)
Use isso para validar que a notificação é legítima.

Status Descrição
PAID Pagamento confirmado. Libere o crédito/produto no seu sistema.
WAITING_FOR_PAYMENT PIX gerado, aguardando pagamento do cliente.
EXPIRED O tempo de validade expirou sem pagamento.
WEBHOOK HANDLER (PHP)
<?php
// Seu arquivo callback.php (postback URL)
$body = file_get_contents('php://input');
$data = json_decode($body, true);

// Status de pagamento confirmado = PAID
if ($data['status'] === 'PAID') {
    $ref = $data['correlationID']; // ID que você enviou originalmente
    // Aqui: credite o usuário no seu sistema
    http_response_code(200);
    echo "OK"; 
}
?>
WEBHOOK PAYLOAD (JSON recebido)
{
  "event": "PAYMENT_CONFIRMED",
  "status": "PAID",
  "correlationID": "pedido_042",
  "value": 15000,
  "paidAt": "2026-03-04T14:30:00Z"
}

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.
STATUS CHECK (CURL)
curl -X GET "https://revoxpay.com/api/status/index.php?api_key=revox_live_...&requestNumber=REF042"
STATUS RESPONSE (JSON)
{
  "status": "success",
  "type": "PIX_CASHIN",
  "transaction_status": "PAID_OUT",
  "amount": 150.00,
  "external_id": "pedido_042",
  "date": "2026-03-04 14:30:00"
}

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 Email válido do recebedor.
PHONE Formato Internacional: +55119...
EVP Chave aleatória geratriz.
CASHOUT REQUEST (JSON)
{
  "api_key": "sua_api_key_aqui",
  "amount": 50.00,
  "pix_key": "12345678901",
  "pix_key_type": "CPF"
}
CASHOUT RESPONSE
{
  "status": "success",
  "withdrawal_id": "9942",
  "amount": 50.00,
  "fee": 1.50,
  "net_amount": 48.50,
  "status_code": "PENDING"
}