Referência

Referência da API

Todos os endpoints da API pública v1 num só lugar. Base URL de produção: https://api.verdinpay.com — em desenvolvimento, http://localhost:3900. Autentique com Authorization: Bearer vrd_live_...

Respostas em snake_case, valores monetários sempre em centavos e datas em ISO 8601 (UTC). Listas seguem o formato { object: "list", data, has_more }. Erros seguem este formato.

Cobranças

Criar cobrança

POST/api/v1/charges

Corpo: amount (centavos, obrigatório), description (obrigatório), customer, metadata, expires_in_minutes. Retorna 201 com o objeto charge. Detalhes.

Recuperar cobrança

GET/api/v1/charges/:id

Retorna o objeto charge ou 404 not_found.

Listar cobranças

GET/api/v1/charges

Query: status, limit (máx 100), starting_after. Retorna { object: "list", data, has_more }.

QR Code da cobrança

GET/api/v1/charges/:id/qrcode

Retorna a imagem PNG do BR Code. Detalhes.

Objeto charge

charge

{
  "id": "clx...",
  "object": "charge",
  "status": "pending",
  "amount": 4990,
  "fee": 74,
  "net": 4916,
  "currency": "BRL",
  "description": "Plano Pro — mensal",
  "payment_method": "pix",
  "customer": { "name": "...", "email": "...", "document": null },
  "pix": { "txid": "...", "brcode": "...", "qrcode_url": "..." },
  "payment_url": "https://verdinpay.com/pay/clx...",
  "metadata": null,
  "paid_at": null,
  "expires_at": "2026-07-04T13:00:00.000Z",
  "created_at": "2026-07-04T12:00:00.000Z"
}

Saldo

Consultar saldo

GET/api/v1/balance

Retorna o saldo disponível da conta (em centavos) e a moeda:

200 OK

{
  "available": 12990,
  "currency": "BRL"
}

Webhooks

Eventos charge.paid, charge.expired, charge.refunded e charge.chargeback, entregues via POST no seu endpoint com o cabeçalho verdin-signature (HMAC-SHA256). Até 6 tentativas, timeout de 8s. Visão geral · Verificação da assinatura.