Listar cobranças
curl --request GET \
--url https://api.upag.io/v1/charges \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.upag.io/v1/charges', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://api.upag.io/v1/charges';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));Cobranças
Listar cobranças
Lista as cobranças da conta, mais recentes primeiro
GET
https://api.upag.io
/
v1
/
charges
Listar cobranças
curl --request GET \
--url https://api.upag.io/v1/charges \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.upag.io/v1/charges', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://api.upag.io/v1/charges';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));Lista as cobranças (Pix e cartão) da conta, da mais recente para a mais antiga.
Permissão:
Na listagem,
charge.read. Apenas chave secreta (sk_…).
Os exemplos usam o sandbox (
https://api.upag.dev/v1). Em produção use https://api.upag.io/v1 com sk_live_….Endpoint
curl -G https://api.upag.dev/v1/charges \
-H "Authorization: Bearer sk_test_your_api_key" \
-d "page=1" \
-d "limit=15" \
-d "includes=customer,items"
import { Upag } from 'upag';
const upag = new Upag('sk_test_your_api_key');
const { data, count } = await upag.charges.list({
page: 1,
limit: 15,
includes: 'customer,items',
});
Parâmetros
integer
default:"1"
Página, a partir de 1.
integer
default:"15"
Itens por página, mínimo 1.
string
Relações a embutir, separadas por vírgula:
customer (objeto cliente no lugar do UUID) e items (lista de itens em cada cobrança). Valor desconhecido retorna 422.Resposta
200 OK. count é o total de cobranças da conta (não só da página).
Response
{
"data": [
{
"id": "1f7d3c8a-4b52-4c9e-8a11-6d0e2f5b7c34",
"type": "pix",
"status": "paid",
"amount": 12550,
"failureCode": null,
"description": "Pedido #10482",
"meta": null,
"customer": "8c1f0a26-5d3b-4f1e-9c72-1a4e6b9d0f83",
"pix": {
"reference": "9d4c2b7f6a1e40538c9b2d7f1a6e0c34",
"qrCode": "00020101021226930014br.gov.bcb.pix...",
"expiresAt": "2026-07-28T12:00:00.000Z"
},
"splits": [],
"ipAddress": null,
"paidAt": "2026-07-27T18:31:07.554Z",
"createdAt": "2026-07-27T18:06:02.113Z",
"updatedAt": "2026-07-27T18:31:07.554Z"
}
],
"count": 1
}
splits vem sempre vazio e items só aparece com includes=items. Consulte a cobrança em Obter cobrança para ver os splits. Campos em Referência.