Pular para o conteúdo principal
GET
/
charges
Listar cobranças
curl --request GET \
  --url https://api.pague.dev/v1/charges \
  --header 'X-API-Key: <x-api-key>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Produto Premium",
      "currency": "BRL",
      "status": "active",
      "slug": "produto-premium-2024",
      "url": "https://pay.pague.dev/produto-premium-2024",
      "paymentMethods": [
        "pix",
        "credit_card"
      ],
      "maxInstallments": 6,
      "notifications": [
        "email"
      ],
      "allowCoupons": true,
      "paymentsCount": 5,
      "totalCollected": 495,
      "createdAt": "2023-11-07T05:31:56Z",
      "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": {},
      "amount": 99.9,
      "expiresAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 100,
  "page": 1,
  "limit": 20,
  "totalPages": 5
}

Cabeçalhos

X-API-Key
string
obrigatório

Chave de API de integração (pd_live_* para produção, pd_test_* para sandbox)

Parâmetros de consulta

page
integer
padrão:1

Número da página

Intervalo obrigatório: x >= 1
limit
integer
padrão:20

Itens por página

Intervalo obrigatório: 1 <= x <= 100

Buscar por nome ou slug

status
enum<string>

Filtrar por status

Opções disponíveis:
active,
expired,
disabled,
paid
projectId
string<uuid>

Filtrar por ID do projeto

Resposta

Lista de cobranças

items
object[]
obrigatório

Lista de cobranças

total
integer
obrigatório

Número total de cobranças

Exemplo:

100

page
integer
obrigatório

Página atual

Exemplo:

1

limit
integer
obrigatório

Itens por página

Exemplo:

20

totalPages
integer
obrigatório

Número total de páginas

Exemplo:

5