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

Utilizamos códigos HTTP para indicar o resultado. Em caso de erro, retornamos um JSON explicando o motivo.

Status	Definição
200 OK	Sucesso total.
400 Bad Request	Faltam campos ou os dados são inválidos.
401 Unauthorized	Sua API Key está errada ou inativa.

Exemplo de Resposta de Erro

RESULTADO (JSON)

{
  "status": "error",
  "message": "Chave de API inválida",
  "error_code": "auth_invalid"
}

Gerar QRCode

Cria uma cobrança PIX dinâmica para seu cliente.

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).
requestNumberSim	string	ID único do pedido no seu sistema.
payer	object	Objeto com `name`, `document` e `email`.

Notificações (Webhook)

Sempre que um usuário concluir um pagamento, nosso servidor enviará um POST para a URL configurada no seu painel.

Status	Descrição
PAID	Pagamento confirmado e liquidado.
EXPIRED	O tempo limite do PIX acabou sem pagamento.

Realizar Saque

Automatize o envio de dinheiro para seus clientes usando seu saldo disponível.

Tipos de Chaves Suportadas

Tipo	Exemplo
CPF	12345678900 (apenas números).
EMAIL	usuario@email.com.
PHONE	+5511999999999.
EVP	Chave aleatória forte.