API VamPay
Integre pagamentos PIX e saques na sua aplicação com nossa API RESTful.
Rápida
Integração em minutos com endpoints simples
Segura
Autenticação via API Key e HTTPS
Webhooks
Notificações em tempo real
Base URL
https://api.vampay.com.brAutenticação
Todas as requisições devem incluir sua API Key no header X-API-Key. Você pode gerar sua API Key no painel de configurações.
curl -X POST "https://api.vampay.com.br/api/transactions/create" \
-H "X-API-Key: vampay_sua_api_key_aqui" \
-H "Content-Type: application/json" \
-d '{"amount": 100.00, "description": "Pedido #123"}'Respostas
Todas as respostas seguem o formato JSON com a seguinte estrutura:
{
"success": true,
"data": { ... },
"message": "Operação realizada com sucesso"
}{
"success": false,
"message": "Descrição do erro",
"code": "ERROR_CODE"
}/api/transactions/createCriar Pagamento
Cria um novo pagamento PIX e retorna o QR Code para o cliente pagar.
Request Body
| Parâmetro | Tipo |
|---|---|
amount* | number |
payerName* | string |
payerDocument* | string |
description | string |
externalId | string |
expiresIn | number |
webhookUrl | string |
Exemplo
curl -X POST "https://api.vampay.com.br/api/transactions/create" \
-H "X-API-Key: vampay_sua_api_key" \
-H "Content-Type: application/json" \
-d '{
"amount": 99.90,
"payerName": "João da Silva",
"payerDocument": "12345678900",
"description": "Assinatura Premium",
"externalId": "pedido_12345",
"webhookUrl": "https://seusite.com/webhook/pagamento"
}'Resposta
{
"success": true,
"data": {
"id": "pag_abc123xyz",
"amount": 99.90,
"status": "PENDING",
"description": "Assinatura Premium",
"externalId": "pedido_12345",
"qrCode": "00020126...",
"qrCodeBase64": "data:image/png;base64,...",
"expiresAt": "2024-01-15T14:30:00.000Z",
"createdAt": "2024-01-15T14:00:00.000Z"
}
}💡 Dica
Use o qrCodeBase64 para exibir o QR Code diretamente em uma tag <img> ou use o qrCode para gerar o código você mesmo.
Webhooks
Receba notificações em tempo real sobre pagamentos e saques.
Payload do Webhook
{
"event": "payment.completed",
"data": {
"id": "pag_abc123xyz",
"amount": 99.90,
"status": "COMPLETED",
"externalId": "pedido_12345",
"paidAt": "2024-01-15T14:05:30.000Z"
},
"timestamp": "2024-01-15T14:05:31.000Z"
}Tipos de Eventos
| Evento | Descrição |
|---|---|
payment.completed | Pagamento confirmado |
payment.expired | QR Code expirou |
withdrawal.completed | Saque concluído |
withdrawal.failed | Saque falhou |
Respondendo ao Webhook
Seu endpoint deve retornar status 200 em até 5 segundos. Em caso de falha, faremos até 3 tentativas com intervalo de 30 segundos.
// Exemplo em Node.js / Express
app.post('/webhook/vampay', (req, res) => {
const { event, data } = req.body
switch (event) {
case 'payment.completed':
// Processar pagamento confirmado (data.id)
break
case 'withdrawal.completed':
// Processar saque concluído (data.id)
break
}
res.status(200).json({ received: true })
})🔐 Segurança
Todos os webhooks incluem o header X-vp-Signature com uma assinatura HMAC-SHA256 do payload usando seu API Key como secret.
const crypto = require('crypto')
const isValidSignature = (payload, signature, apiKey) => {
const expected = crypto
.createHmac('sha256', apiKey)
.update(JSON.stringify(payload))
.digest('hex')
return crypto.timingSafeEqual(
Buffer.from(signature),
Buffer.from(expected)
)
}Pronto para integrar?
Crie sua conta e gere sua API Key para começar a receber pagamentos.
Criar conta grátis