Skip to main content
GET
Get point history

Authorizations

X-Channel-Id
string
header
required

Merchant storefront identifier. Provided during onboarding.

X-Session-Id
string
header
required

Diner session identifier from the Storefront API's GET /channel. Log in returns a new one.

Query Parameters

state
enum<string>
  • awarded: points earned that have an expiry date still to come
  • deducted: points used
  • expiring: points earned that expire in the next 30 days
  • expired: points earned whose expiry date has passed, including any fully used before then
Available options:
awarded,
deducted,
expiring,
expired
page
integer
default:1
Required range: x >= 1
per_page
integer
default:20
Required range: 1 <= x <= 100

Response

One page of point transactions

object
string
Example:

"point_transaction"

current_page
integer
per_page
integer
total_count
integer
total_pages
integer
items
object[]