Skip to main content
GET
Get customer loyalty balances and ledger

Authorizations

Authorization
string
header
required

Merchant-bound customer session JWT returned by OTP verification.

Path Parameters

locationId
string
required
Required string length: 1 - 128

Query Parameters

limit
integer
Required range: 1 <= x <= 30
cursor
string
Required string length: 1 - 512

Response

Loyalty ledger.

enabled
boolean
required
authority
enum<string>
Available options:
SQUARE,
LIP
programId
string
Required string length: 1 - 128
enrollmentRequired
boolean
balances
object[]
entries
object[]
nextCursor
string
{key}
any