Get Loyalty Balances

Retrieve the list of loyalty balance (credit) transactions across all members.

When to Use

▾

Use this endpoint when:

• Auditing loyalty credit movements
• Building a loyalty-balance transaction report

How to Use

▾

Endpoint

GET/v3/loyalty/balances

GET /v3/loyalty/balances with signed authentication headers.

---

Request Parameters

▾

No request body. Authenticated headers only.

Response Parameters

▾

itemsARRAY

Example: (Refer to explanation below)

codeSTRING

Successfully call this endpoint. If fail, will return error code object (Refer Appendix 1: Error Codes)

Example: "SUCCESS"

metaOBJECT

Pagination metadata

countINTEGER

Total number of records returned

Example: 50

cursorSTRING

Cursor for fetching the next page (empty if no more pages)

Example: ""

idSTRING

Example: "1647502414730379278"

storeOBJECT

idSTRING

Store ID

Example: "1601912947341252990"

merchantSettlementIdSTRING

Merchant Settlement ID

Example: "1596124535165747709"

nameSTRING

Store Name

Example: "Mountain Food - Aeon Mall Shah Alam"

imageUrlSTRING

Store image URL

Example: "https://storage.googleapis.com/rm-prod-asset/img/store.png"

addressLine1STRING

Store Address 1

Example: "B-5-30, 5th Floor, Block Bougainvillea,"

addressLine2STRING

Store Address 2

Example: "PJU 6A, Lebuhraya SPRINT, 10 Boulevard,"

postCodeSTRING

Postcode of store

Example: "47400"

citySTRING

City of store

Example: "Petaling Jaya"

stateSTRING

State of store

Example: "Selangor"

countrySTRING

Country of store

Example: "Malaysia"

countryCodeSTRING

Country code of store contact number

Example: "60"

phoneNumberSTRING

Phone number of store

Example: "377334080"

geoLocationOBJECT

Geo Location (latitude and longitude) of store

Example: {"latitude": 3.1349857, "longitude": 101.6136659 }

statusSTRING

Current status of store

Example: "ACTIVE"

createdAtDATETIME

Creation date time of store

Example: "2020-09-14T03:01:20Z"

updatedAtDATETIME

Last update date time of store

Example: "2020-09-14T03:01:20Z"

transactionIdSTRING

Example: ""

methodSTRING

Example: "LOYALTY_CREDIT"

typeSTRING

Example: "QUICK_PAY"

orderOBJECT

idSTRINGrequired

Order ID (from Merchant), max: 24

Example: "134850717797247290"

titleSTRINGrequired

Example: ""

detailSTRINGrequired

Example: ""

additionalDataSTRING

Order additional data

Example: ""

amountINTEGERrequired

Amount of order in cent (min RM 0.10 or amount: 10)

Example: 100

memberProfileOBJECT

Loyalty member profile (null if not tied to a member)

idSTRING

Member ID

Example: ""

keySTRING

Member key

Example: ""

nameSTRING

Member name

Example: ""

emailSTRING

Member email

Example: ""

nricSTRING

Member NRIC

Example: ""

passportSTRING

Member passport number

Example: ""

referralCodeSTRING

Member referral code

Example: ""

birthDateSTRING

Member birth date

Example: ""

genderSTRING

Member gender

Example: ""

stateSTRING

Member state

Example: ""

addressOBJECT

Member address

addressLine1STRING

Address line 1

Example: ""

addressLine2STRING

Address line 2

Example: ""

postcodeSTRING

Postcode

Example: ""

citySTRING

City

Example: ""

stateSTRING

State

Example: ""

countrySTRING

Country

Example: ""

memberTierOBJECT

Member tier (null if none)

totalLoyaltyPointINTEGER

Total loyalty points

Example: 0

hasPinCodeBOOLEAN

Whether member has pin code

Example: false

loyaltyPointBalanceINTEGER

Loyalty point balance

Example: 0

spendingPointINTEGER

Spending points

Example: 0

creditBalanceINTEGER

Credit balance

Example: 0

statusSTRING

Member status

Example: "ACTIVE"

createdAtDATETIME

Member created date time

Example: ""

updatedAtDATETIME

Member last updated date time

Example: ""

terminalIdSTRING

Example: ""

currencyTypeSTRING

Example: "MYR"

transactionAtDATETIME

Example: "2022-01-27T04:02:46Z"

statusSTRING

Example: "SUCCESS"

createdAtDATETIME

Creation date time of merchant

Example: "2022-01-27T04:02:46Z"

updatedAtDATETIME

Last update date time of merchant

Example: "2022-01-27T04:02:46Z"