Paginação e respostas

Como as listas são paginadas e o formato das respostas de cada grupo de rotas.

Listas

As listas (GET /api/v1/charges, /payment-links, /webhook-endpoints, /accounts e as de cada subconta) usam page e limit:

Parâmetro	Padrão	Máximo
`page`	1	—
`limit`	20	100

A resposta traz os itens e o total:

{
  "data": [ { "id": "…", "object": "charge", "status": "pending" } ],
  "total": 134,
  "page": 1,
  "limit": 20
}

Para ler tudo, avance page até page * limit >= total. Os filtros de cada lista (status, cliente, referência externa, datas) estão na Referência da API.

curl "https://api.confidoscm.com/api/v1/charges?status=pending&page=2&limit=50" -H "X-API-Key: $CONFIDO_API_KEY"

Formato das respostas

Rotas	Resposta de sucesso
Vendas (`/payments`) e tokenização (`/card-tokens`)	Dentro de um envelope: `{ "data": …, "timestamp": "…" }`
Cobranças, links, subcontas, webhooks	O objeto direto (ou a lista acima)

Na venda, o pagamento fica em data.payment (na criação) ou em data (na consulta):

{ "data": { "payment": { "publicId": "pay_9f2c4e1a7b3d", "status": "pending" }, "replayed": true }, "timestamp": "2026-11-03T18:00:00Z" }

Ids

Prefixo	O que é
`pay_…`	Pagamento (venda). Use nas consultas, nos webhooks e no painel.
`chr_…`	Cobrança. `GET /api/v1/charges/{id}` aceita o `chr_…` ou o id (uuid).
`acct_…`	Subconta (Connect). Vai no cabeçalho `Confido-Account`.

Os demais recursos usam id em formato uuid.