Integração — API v2

Página de apoio para dev/testes. As regras atuais exigem Nome/CPF/CNPJ em depósito e saque (Pix).

Campos obrigatórios (Pix)

  • Depósito (/v2/pix/qrcode e /v2/checkout/pix): payerName + payerDocument (CPF/CNPJ)
  • Saque (/v2/pix/payment): debtorName + debtorDocument (CPF/CNPJ)

BR Code (copia-e-cola) sem PIX_KEY

O BR Code é gerado a partir do banco (config.pix_receiver_key, pix_receiver_name, pix_receiver_city). Se não estiver configurado, o depósito ainda é criado, mas brcode pode vir vazio.

-- Adiciona configurações do recebedor Pix (para gerar BR Code/QR sem usar .env)
-- Execute apenas uma vez no seu banco.

ALTER TABLE `config`
  ADD COLUMN `pix_receiver_key` VARCHAR(255) NULL DEFAULT NULL,
  ADD COLUMN `pix_receiver_name` VARCHAR(255) NULL DEFAULT NULL,
  ADD COLUMN `pix_receiver_city` VARCHAR(255) NULL DEFAULT NULL;

Exemplos rápidos

Depósito: /v2/pix/qrcode
{
  "amount": 10.50,
  "payerName": "João da Silva",
  "payerDocument": "123.456.789-09",
  "payerQuestion": "Pedido #123",
  "external_id": "pedido-123",
  "expires_in_minutes": 30
}
Saque: /v2/pix/payment
{
  "amount": 25.00,
  "description": "Saque do usuário",
  "debtorName": "João da Silva",
  "debtorDocument": "123.456.789-09",
  "creditParty": { "key": "CHAVE_PIX_DESTINO", "keyType": "EVP" }
}