Sign in

v1

latestOpenAPI 3.1.0MIT2026-08-0659118508.8 KB
Customer

List customer reward ledger entries

Lists reward ledger entries for a customer. Each entry is a single movement — a reward earned (type: REWARD), a redemption against a reward (type: REDEMPTION), an unused reward swept at its expiry date (type: REWARD_EXPIRATION), a reward taken back after the earning capture was refunded or charged back (type: REWARD_REVERSAL), or a redemption given back as fresh credit after a refund or chargeback (type: REWARD_RESTORATION). Supports filtering by account, type, expiry date, and creation date. Results are sorted by creation date descending (newest first). See the Rewards & Redemptions guide for the full flow.

Required scope: <code style="background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em">customer:read</code>

get/customer/{id}/rewards

Path parameters

idstring uuid required

Resource Identification

Query parameters

cursorstring

The cursor parameter is used for pagination. It specifies the pointer to the start of the next set of results in a sequence of paginated data. Typically, this is a unique identifier of the last item from the previous response. If not provided, the API fetches the first page of results.

limitnumber

The limit parameter is used for pagination. It specifies the maximum number of entries to return in a single page of results. Max 100.

account_id[]string uuid
Example:458b2fc4-3092-4de3-abd4-fe1600c09420

Filter by reward account identifier. Repeat the parameter to filter by multiple accounts.

type[]'REWARD' | 'REDEMPTION' | 'REWARD_EXPIRATION' | 'REWARD_REVERSAL' | 'REWARD_RESTORATION'
Example:REWARD

Filter by ledger entry type. Repeat the parameter to filter by multiple types. Note that REWARD only matches earned rewards — credits given back after a refund or chargeback are matched by REWARD_RESTORATION.

expiration_datestring
Example:interval(2026-01-01,2027-12-31)

Filter by expiry date. Accepts a single date YYYY-MM-DD (matches that whole day) or an interval interval(YYYY-MM-DD,YYYY-MM-DD). Maximum interval span is 1 year.

created_atstring
Example:interval(2026-01-01 00:00,2026-01-31 23:59)

Filter by creation datetime in UTC. Accepts a single datetime YYYY-MM-DD HH:MM (matches that whole minute) or an interval interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM). Maximum interval span is 1 year.

Response

OK

Example response

{
  "metadata": {
    "next_cursor": "lL_j7ilk7rc",
    "count": 10
  },
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "account_id": "458b2fc4-3092-4de3-abd4-fe1600c09420",
      "type": "REWARD",
      "amount": 10,
      "expiration_date": "2027-01-15",
      "capture": {
        "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb"
      },
      "created_at": "2026-01-15T10:30:00Z"
    }
  ]
}