List charges

Returns your charges, newest first, one page at a time.

GET/charges

Query parameters

statusstring

pending, paid, failed, canceled or refunded

created_from / created_todate

ISO-8601 date or date-time range on created_at

qstring

Free search: charge id, reference, customer name, email or document

pageinteger

Starts at 1

per_pageinteger

1 to 100, default 50

Requestbash

curl "https://api.armhed.lat/charges?status=paid&created_from=2026-10-01&per_page=20" -u "$CLIENT_ID:$API_KEY"

200 OKjson

{
  "object": "list",
  "data": [
    {
      "object": "charge",
      "id": "6dcf2aee0d6148e1a12b78db78",
      "reference": "order-1042",
      "status": "paid",
      "amount": 4990,
      "fee": 99,
      "currency": "BRL",
      "pix": { "end_to_end_id": "E22896431202610311207sjUGQflhcVE" },
      "customer": { "name": "Ana Souza", "email": "ana@example.com", "phone": "11987654321", "document": "24577481600" },
      "payer": { "name": "ANA SOUZA", "document": "24577481600" },
      "created_at": "2026-10-31T12:00:00Z",
      "updated_at": "2026-10-31T12:03:12Z",
      "paid_at": "2026-10-31T12:03:11Z"
    }
  ],
  "page": 1,
  "per_page": 20,
  "total": 1
}

List items are a summary of the charge; call GET /charges/{id} for every field.