GET/api/v1/orders

Listar compras

Bearer tokenImplementadoescopo read:orders

Contrato OpenAPI

operationId: listOrders · Implementada

Parâmetros

Nome	Local	Obrigatório	Tipo
`limit`	query	não	integer
`offset`	query	não	integer

Respostas

HTTP	Significado
`200`	Compras do usuário
`default`	Erro padronizado

Lista as orders (cobranças de créditos avulsos ou assinatura) do usuário associado ao Bearer token. Suporta paginação. Responde 200 OK.

Escopo necessário: read:orders (ver Escopos).

Query params

Param	Tipo	Padrão	Restrições
`limit`	inteiro	`20`	máximo `100`
`offset`	inteiro	`0`	deslocamento para paginação (máximo `10000`)

Ver Paginação.

Exemplo de request

cURL

curl "https://avatrix.io/api/v1/orders?limit=20&offset=0" \
  -H "Authorization: Bearer av_xxxxxxxxxxxxxxxx"

Resposta — 200

A lista vem dentro do envelope padrão:

JSON

{
  "success": true,
  "data": {
    "orders": [
      {
        "id": "ord_xxxxxxxx",
        "amount": 49.90,
        "creditsPurchased": 1000,
        "paymentMethod": "pushinpay",
        "status": "paid",
        "createdAt": "2026-06-16T12:00:00.000Z"
      }
    ],
    "limit": 20,
    "offset": 0
  }
}

O data traz as orders vinculadas ao seu token (restritas à sua conta), da mais recente para a mais antiga, e os metadados de paginação. Para o QR Code PIX e demais detalhes use GET /api/v1/orders/:id.

Segurança

A listagem nunca expõe CPF, QR Code PIX nem IDs de gateway. Para obter o QR Code PIX de uma cobrança específica (do próprio usuário), use GET /api/v1/orders/:id — que ainda assim nunca expõe CPF, nome do pagador, end-to-end id nem o ID da transação no gateway.

Erros relevantes

Código	HTTP	Quando
`UNAUTHORIZED`	401	token ausente, inválido, expirado ou revogado
`FORBIDDEN`	403	token sem `read:orders`
`RATE_LIMITED`	429	rate limit (60 req/min por token), com `Retry-After`

Ver Erros.