Documentação API

Início Rápido

Integre pagamentos PIX no seu sistema em 3 passos simples:

1

Crie sua conta

Registre-se em www.vexopay.com.br/register

2

Gere suas API Keys

Vá em API Keys e gere suas credenciais (client_id + client_secret)

3

Integre

Use as credenciais nos headers das requisições HTTP conforme documentado abaixo.

Autenticação

Todas as requisições à API exigem as credenciais nos headers:

// Headers obrigatórios em todas as requisições
ci: vxp_ci_xxxxxxxxxxxxxxxx   // seu client_id
cs: vxp_cs_xxxxxxxxxxxxxxxx   // seu client_secret
Content-Type: application/json

Base URL

https://www.vexopay.com.br

Taxas

2% + R$ 0,50 por transação

Valor	Taxa	Você Recebe
R$ 10,00	R$ 0,70	R$ 9,30
R$ 50,00	R$ 1,50	R$ 48,50
R$ 100,00	R$ 2,50	R$ 97,50
R$ 500,00	R$ 10,50	R$ 489,50
R$ 1.000,00	R$ 20,50	R$ 979,50

Sem mensalidade. Sem fidelidade. Sem taxa de adesão.

Criar Cobrança PIX (Cash-in)

POST /api/gateway/pix-create

Gera uma cobrança PIX com QR Code e código copia e cola.

Parâmetros (body JSON)

Campo	Tipo	Obrigatório	Descrição
`amount`	number	Sim	Valor em reais (mín: 1.00)
`payerName`	string	Sim	Nome do pagador
`payerDocument`	string	Sim	CPF do pagador (apenas números)
`description`	string	Não	Descrição da cobrança

curl -X POST https://www.vexopay.com.br/api/gateway/pix-create \ -H "Content-Type: application/json" \ -H "ci: vxp_ci_SEU_CLIENT_ID" \ -H "cs: vxp_cs_SEU_CLIENT_SECRET" \ -d '{ "amount": 50.00, "payerName": "João Silva", "payerDocument": "12345678909", "description": "Assinatura mensal" }'

const response = await fetch('https://www.vexopay.com.br/api/gateway/pix-create', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'ci': 'vxp_ci_SEU_CLIENT_ID',
    'cs': 'vxp_cs_SEU_CLIENT_SECRET',
  },
  body: JSON.stringify({
    amount: 50.00,
    payerName: 'João Silva',
    payerDocument: '12345678909',
    description: 'Assinatura mensal',
  }),
});

const data = await response.json();
console.log(data.data.qrCodeBase64);  // QR Code em Base64
console.log(data.data.copyPaste);      // Código copia e cola

import requests response = requests.post( 'https://www.vexopay.com.br/api/gateway/pix-create', headers={ 'ci': 'vxp_ci_SEU_CLIENT_ID', 'cs': 'vxp_cs_SEU_CLIENT_SECRET', }, json={ 'amount': 50.00, 'payerName': 'João Silva', 'payerDocument': '12345678909', } ) data = response.json() print(data['data']['copyPaste']) # Código PIX

$ch = curl_init('https://www.vexopay.com.br/api/gateway/pix-create');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'ci: vxp_ci_SEU_CLIENT_ID',
        'cs: vxp_cs_SEU_CLIENT_SECRET',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'amount' => 50.00,
        'payerName' => 'João Silva',
        'payerDocument' => '12345678909',
    ]),
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
echo $data['data']['copyPaste']; // Código PIX

Resposta de Sucesso (201)

{
  "success": true,
  "data": {
    "transactionId": "vxp_abc123def456...",
    "amount": 50.00,
    "fee": 1.50,
    "netAmount": 48.50,
    "status": "pending",
    "qrCodeBase64": "data:image/png;base64,...",
    "qrCodeUrl": "https://...",
    "copyPaste": "00020126...",
    "expiresAt": "2025-12-31T23:59:59Z"
  }
}

Consultar Status

GET /api/gateway/pix-status?transactionId=vxp_xxx

curl https://www.vexopay.com.br/api/gateway/pix-status?transactionId=vxp_abc123 \ -H "ci: vxp_ci_SEU_CLIENT_ID" \ -H "cs: vxp_cs_SEU_CLIENT_SECRET"

Resposta

{
  "success": true,
  "data": {
    "transactionId": "vxp_abc123...",
    "type": "pix_in",
    "amount": 50.00,
    "fee": 1.50,
    "netAmount": 48.50,
    "status": "paid",
    "payerName": "João Silva",
    "createdAt": "2025-01-15T14:30:00Z"
  }
}

Possíveis Status

Status	Descrição
`pending`	Aguardando pagamento do PIX
`paid`	Pagamento confirmado
`failed`	Pagamento falhou
`expired`	QR Code expirou
`refunded`	Pagamento estornado

Consultar Saldo

GET /api/gateway/balance

curl https://www.vexopay.com.br/api/gateway/balance \ -H "ci: vxp_ci_SEU_CLIENT_ID" \ -H "cs: vxp_cs_SEU_CLIENT_SECRET"

Resposta

{
  "success": true,
  "data": {
    "balance": 1250.00,
    "totalReceived": 5000.00,
    "totalWithdrawn": 3500.00,
    "totalFees": 250.00,
    "transactionsCount": 42,
    "currency": "BRL"
  }
}

Webhooks

Configure a URL de webhook no seu perfil para receber notificações em tempo real quando um pagamento for confirmado.

Payload recebido no seu webhook

{
  "event": "payment.completed",
  "data": {
    "transactionId": "vxp_abc123...",
    "amount": 50.00,
    "fee": 1.50,
    "netAmount": 48.50,
    "status": "paid",
    "payerName": "João Silva",
    "paidAt": "2025-01-15T14:35:00Z"
  }
}

// Eventos possíveis:
// payment.completed — pagamento confirmado
// payment.failed — pagamento falhou
// payment.expired — QR code expirou

IP Whitelist (Opcional)

Para maior segurança, você pode restringir o uso da sua API Key a IPs específicos. Configure na página API Keys.

Como funciona

Configuração	Comportamento
`Sem IPs`	Aceita requisições de qualquer IP (padrão)
`Com IPs`	Aceita apenas requisições dos IPs listados

Resposta quando IP bloqueado (403)

{ "error": "IP não autorizado (203.0.113.50). Configure seus IPs permitidos na página API Keys." }

💡 Dica: Configure IPs permitidos sempre que possível para proteger suas credenciais contra uso não autorizado.

Códigos de Erro

HTTP Code	Significado
`400`	Parâmetros inválidos ou ausentes
`401`	Credenciais (ci/cs) inválidas ou ausentes
`403`	Conta suspensa ou sem permissão
`404`	Recurso não encontrado
`405`	Método HTTP não permitido
`429`	Limite de requisições excedido
`500`	Erro interno do servidor
`502`	Erro de comunicação com processador de pagamento