Listar cobranças
GET
/api/charges
Autenticação
Bearer pela sua API Key real (vk_live_* produção, vk_test_* sandbox). Crie a chave em https://app.dotfy.com.br/dashboard/chaves-api. Sem o header → 401. Com chave inválida/revogada → 401. Com chave sem o escopo necessário → 403 insufficient_scope.charges:read.method é PIX ou CARD; em cartão vêm também cardBrand e installments (ambos null em PIX).Requisição
Parâmetros de Consulta
Parâmetros Header
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/charges?page=1&limit=10&status=ACTIVE' \
--header 'Authorization: Bearer <token>'Response Response Example
{
"transactions": [
{
"id": "clxxx0001",
"correlationId": "dotfy-1714000000000-abc12345",
"transactionId": "E1823...",
"customer": "Maria Silva",
"email": "maria@exemplo.com",
"phone": "+5511999998888",
"taxId": "12345678901",
"amount": 29.90,
"status": "completed",
"method": "PIX",
"cardBrand": null,
"installments": null,
"date": "2026-05-07T14:35:12.000Z",
"createdAt": "2026-05-07T14:30:00.000Z",
"paidAt": "2026-05-07T14:35:12.000Z",
"expiresAt": "2026-05-07T15:30:00.000Z",
"description": "Pedido #1234",
"brCode": "00020126360014BR.GOV.BCB.PIX...",
"qrCodeImage": "data:image/png;base64,...",
"paymentLink": "https://app.dotfy.com.br/checkout/...",
"payerName": "Maria Silva",
"payerTaxId": "123.***.***-01"
}
],
"total": 142,
"page": 1,
"limit": 10,
"totalPages": 15
}Modificado em 2026-07-02 06:57:27