Skip to content
/
List customer reward ledg...

List customer reward ledger entries

Request

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: customer:read

Security
accountId and apiKey
Path
idstring, (uuid)required

Resource Identification

Query
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)

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

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

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.

Enum:"REWARD""REDEMPTION""REWARD_EXPIRATION""REWARD_REVERSAL""REWARD_RESTORATION"
Example:type[]=REWARD
expiration_datestring

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.

Example:expiration_date=interval(2026-01-01,2027-12-31)
created_atstring

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.

Example:created_at=interval(2026-01-01 00:00,2026-01-31 23:59)
curl -i -X GET \
  'https://api.test.easypay.pt/2.0/customer/{id}/rewards?cursor=string&limit=0&account_id%5B%5D=458b2fc4-3092-4de3-abd4-fe1600c09420&type%5B%5D=REWARD&expiration_date=interval(2026-01-01%2C2027-12-31)&created_at=interval(2026-01-01%2000%3A00%2C2026-01-31%2023%3A59)' \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92'

Responses

OK

Bodyapplication/json
metadataobject(Metadata)required

An object containing additional information about the response. It includes details that help manage and navigate the retrieved data.

dataArray of objects(reward-ledger-entry)read-onlyrequired
Response
Success
{
  "metadata": {
    "next_cursor": "lL_j7ilk7rc",
    "count": 6
  },
  "data": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}