Endpoint
POST /api/v1/pix/in/qrcode
Cria um QR Code PIX para recebimento de pagamentos instantâneos.
URL Completa:
- Produção:
https://api.vexybank.com/api/v1/pix/in/qrcode
Headers obrigatórios
Parâmetros do corpo
Campos Obrigatórios
amountInCents
amountInCents
Tipo:
Descrição: Valor em centavos (ex: 10000 = R 0,01)
Máximo: 1.000.000.000 centavos (R$ 10.000.000,00)
numberDescrição: Valor em centavos (ex: 10000 = R 0,01)
Máximo: 1.000.000.000 centavos (R$ 10.000.000,00)
customer
customer
Tipo:
Descrição: Dados do cliente pagadorCampos obrigatórios do customer:
objectDescrição: Dados do cliente pagadorCampos obrigatórios do customer:
name(string): Nome completoemail(string): Email válidodocumentType(string): “cpf” ou “cnpj”document(string): Número do documento (apenas números)
Campos opcionais
description
description
Tipo:
Descrição: Descrição da transação
Limite: 140 caracteres
Padrão: Vazio
stringDescrição: Descrição da transação
Limite: 140 caracteres
Padrão: Vazio
postbackUrl
postbackUrl
Tipo:
Descrição: URL específica para webhooks desta transação
Formato: URL válida (https://)
stringDescrição: URL específica para webhooks desta transação
Formato: URL válida (https://)
customer.phone
customer.phone
Tipo:
Descrição: Telefone do cliente
Formato: Formato com DDD e número
stringDescrição: Telefone do cliente
Formato: Formato com DDD e número
customer.billingAddress
customer.billingAddress
Tipo:
Descrição: Endereço de cobrança do cliente
objectDescrição: Endereço de cobrança do cliente
items
items
Tipo:
Descrição: Lista de itens da compra
arrayDescrição: Lista de itens da compra
Exemplos práticos
Exemplo Básico - Cobrança Simples
Exemplo Completo - E-commerce
Exemplo B2B - CNPJ
Resposta de sucesso (200)
Campos da Resposta
| Campo | Descrição |
|---|---|
id | ID único da transação |
pix.emv | Código PIX para copiar e colar |
pix.qrCode | Imagem do QR Code em Base64 |
status | Status atual (pending - aguardando pagamento) |
fees | Taxa cobrada em centavos |
Exibindo o QR Code
Exibir Imagem
Código para Copiar
Implementações por linguagem
JavaScript/Node.js
Python
PHP
❌ Tratamento de Erros
Possíveis Erros
| Código | Erro | Causa Comum | Solução |
|---|---|---|---|
400 | Dados inválidos | CPF/CNPJ inválido, email malformado | Validar dados antes de enviar |
401 | Token inválido | Token expirado ou inválido | Renovar token de autenticação |
422 | Regra de negócio | Valor muito baixo/alto | Verificar limites permitidos |
429 | Rate limit | Muitas requisições | Implementar retry com delay |