Pagamentos

Consultar e listar cobranças

Recupere uma cobrança específica pelo id ou percorra a lista das suas cobranças, filtrando por status e paginando com cursor.

Recuperar uma cobrança

GET/api/v1/charges/:id

Retorna o objeto charge completo (mesmo shape de criação). Cobrança inexistente ou de outra conta retorna 404 not_found.

cURL

curl https://api.verdin.com.br/api/v1/charges/clx7a1b2c3d4e5f6g7h8i9j0k \
  -H "Authorization: Bearer vrd_live_..."

Node.js

const id = "clx7a1b2c3d4e5f6g7h8i9j0k";
const res = await fetch(`https://api.verdin.com.br/api/v1/charges/${id}`, {
  headers: { Authorization: `Bearer ${process.env.VERDIN_API_KEY}` },
});
if (res.status === 404) throw new Error("Cobrança não encontrada");
const charge = await res.json();

Listar cobranças

GET/api/v1/charges

Retorna suas cobranças em ordem decrescente de criação, num objeto de lista paginado.

Campo	Tipo	Descrição
`status`	stringopcional	Filtra por status: `pending`, `paid`, `expired` ou `canceled`.
`limit`	integeropcional	Quantidade de itens por página (padrão 20, máximo 100).
`starting_after`	stringopcional	Cursor de paginação: id da última cobrança da página anterior. Retorna os itens seguintes.

Filtrar por status

curl "https://api.verdin.com.br/api/v1/charges?status=paid&limit=2" \
  -H "Authorization: Bearer vrd_live_..."

Próxima página (cursor)

curl "https://api.verdin.com.br/api/v1/charges?limit=20&starting_after=clx_ultima_id" \
  -H "Authorization: Bearer vrd_live_..."

Resposta da lista

A lista vem no formato padrão { object: "list", data, has_more }. Quando has_more é true, use o id do último item como starting_after para buscar a próxima página.

200 OK

{
  "object": "list",
  "data": [
    {
      "id": "clx7a1b2c3d4e5f6g7h8i9j0k",
      "object": "charge",
      "status": "paid",
      "amount": 4990,
      "fee": 74,
      "net": 4916,
      "currency": "BRL",
      "description": "Plano Pro — mensal",
      "payment_method": "pix",
      "customer": { "name": "Ana Souza", "email": "ana@exemplo.com", "document": null },
      "pix": {
        "txid": "VRD7A1B2C3D4E5F6G7H8I9J0",
        "brcode": "00020126360014BR.GOV.BCB.PIX...6304AB1F",
        "qrcode_url": "https://api.verdin.com.br/api/v1/charges/clx7a1b2c3d4e5f6g7h8i9j0k/qrcode"
      },
      "payment_url": "https://api.verdin.com.br/pay/clx7a1b2c3d4e5f6g7h8i9j0k",
      "metadata": { "pedido_id": "A-1042" },
      "paid_at": "2026-07-04T12:05:11.000Z",
      "expires_at": "2026-07-04T13:00:00.000Z",
      "created_at": "2026-07-04T12:00:00.000Z"
    }
  ],
  "has_more": true
}

Criar cobrança PIXVolte para a criação.QR CodeRenderize o QR da cobrança.