1. Cobranças PIX
Dotfy - Documentação
  • Dotfy Module
    • Raiz
      • Conta (Dados do Seller)
        • Identificar a conta (dados do seller)
      • Cobranças PIX
        • Criar cobrança PIX
          POST
        • Listar cobranças
          GET
        • Consultar cobrança por correlationID
          GET
        • Histórico de webhooks de uma cobrança
          GET
      • Saldo
        • Consultar saldo
      • Saques e Chaves PIX
        • Listar chaves PIX cadastradas
        • Cadastrar chave PIX
        • Listar saques
        • Solicitar saque
        • Cancelar saque pendente
      • Clientes
        • Listar clientes
        • Detalhe de um cliente
      • Produtos e Links de Pagamento
        • Listar produtos
        • Criar produto
        • Detalhe do produto
        • Carrinhos abandonados do produto
      • Splits
        • Analytics de splits enviados
        • Splits recebidos
      • Disputas e MEDs
        • Listar disputas
        • Listar MEDs com estatísticas
        • Evidências de uma disputa
        • Histórico de uma disputa
      • Webhooks (Gerenciar Endpoints)
        • Listar endpoints
        • Criar endpoint
        • Atualizar endpoint
        • Remover endpoint
      • Webhooks (Eventos Recebidos)
        • EVENT:CHARGE_CREATED — cobrança criada
        • EVENT:CHARGE_PAID — cobrança paga (atualização principal)
        • EVENT:CHARGE_EXPIRED — cobrança expirada
        • EVENT:SPLIT_RECEIVED — você recebeu um split
        • EVENT:DISPUTE_OPENED — MED/disputa aberta
        • EVENT:DISPUTE_WON — disputa ganha
        • EVENT:DISPUTE_LOST — disputa perdida
        • EVENT:DISPUTE_CANCELED — disputa cancelada
        • EVENT:WITHDRAWAL_COMPLETED — saque concluído
        • EVENT:WITHDRAWAL_FAILED — saque falhou
      • Notificações
        • Listar notificações
      • Dashboard / Analytics
        • Stats gerais
        • Atividade recente
        • Atividade (timeline)
        • Receita por período
        • Volume por período
        • Taxa de conversão
        • Métodos de pagamento
        • Transações (gráfico)
        • Analytics avançado
  1. Cobranças PIX

Listar cobranças

GET
{{base_url}}/api/charges

Autenticação#

Esta rota exige Bearer Token (sua API Key) no header. Envie EXATAMENTE assim:
Substitua o valor após 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.

Lista paginada de cobranças do seller dono da API Key. Escopo: charges:read.

Requisição

Parâmetros de Consulta

Parâmetros Header

Respostas

🟢200
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff '{{base_url}}/api/charges?page=1&limit=10&status=ACTIVE' \
--header 'Authorization: Bearer {{api_key}}'
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",
      "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-05-07 16:12:35
Página anterior
Criar cobrança PIX
Próxima página
Consultar cobrança por correlationID
Built with