Charges list

A paginated list of individual charges (payments and refunds) at the requested site, filterable by status, processor, completion date, revenue date, payout date, and more. A per-processor net total is returned alongside the page of data so dashboards can show a running total without needing to fetch every page.

For large date ranges or background CSV delivery, use /shop/reports/charge-list/queue.

site_idstring uuid

Restrict the report to charges at the given site.

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

completed_fromstring date-time

Restrict to charges completed on or after this time.

completed_tostring date-time

Restrict to charges completed on or before this time.

created_fromstring date-time

Restrict to charges created on or after this time.

created_tostring date-time

Restrict to charges created on or before this time.

revenue_date_fromstring date

Restrict to charges with a revenue date on or after this date.

revenue_date_tostring date

Restrict to charges with a revenue date on or before this date.

payout_date_fromstring date

Restrict to charges with a payout date on or after this date.

payout_date_tostring date

Restrict to charges with a payout date on or before this date.

statusstring

Example:complete

The charge status to include. Defaults to complete for the main charge list and to all for the pay-by-link variant.

chargeable_typestring

Filter to charges against a specific chargeable type (e.g. order, membership).

charge_typestring

Filter to a particular charge type (e.g. payment, refund).

processorstring

Filter to charges that went through a specific payment processor (e.g. adyen, stripe, cash).

details_sourcestring

Filter to charges where the payment details came from a specific source (e.g. pay_by_link).

order_statusstring

Filter to charges whose parent order has a specific status.

created_bystring object-id

Filter to charges created by a specific user ID.

Response

The charges were successfully retrieved.

Example response

{
  "data": [
    {
      "id": "60a8c0901d210625e3a87667",
      "charge_type": "payment",
      "chargeable_type": "order",
      "order_ref": "TRY03",
      "order_status": "settled",
      "revenue_date": "2026-06-15",
      "payout_date": "2026-06-18",
      "customer_name": "Jane Doe",
      "processor": "adyen",
      "processor_type": "card",
      "processor_id": "PSP_REF_123",
      "amount": 15000,
      "currency": "gbp",
      "status": "complete"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  },
  "processor_totals": [
    {
      "processor": "adyen",
      "amount": 250000
    }
  ]
}

Charges list

Query parameters

Response

Example response

Changes