Spend Loyalty Balances

Spend a member's loyalty credit balance at checkout. The customer's loyalty QR code is scanned to capture the authCode.

When to Use

▾

Use this endpoint when:

• Member pays partially or fully with loyalty credit
• Settling a Quick Pay transaction with the LOYALTY_CREDIT method

How to Use

▾

Endpoint

POST/v3/loyalty/balances

POST authCode, storeId, and order details. Returns the loyalty-credit transaction record.

---

Request Parameters

▾

authCodeSTRING

Auth code of QR code/barcode being scanned. Length: 18

Example: "loyalty_qr_authcode"

storeIdSTRING

orderOBJECT

idSTRINGrequired

Order ID (from Merchant), max: 24

Example: "134850717797247290"

titleSTRINGrequired

Example: "In store payment"

detailSTRINGrequired

Example: ""

additionalDataSTRING

Example: ""

amountINTEGERrequired

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

Example: 100

Response Parameters

▾

itemOBJECT

Example: (Refer to explanation below)

codeSTRING

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

Example: "SUCCESS"

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: ""

amountINTEGERrequired

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

Example: 100

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"