Spend Loyalty Balances

POST/v3/loyalty/balances

Get loyalty balance

Request Parameters

authCodeString

Yes

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

storeIdString

orderObject

Order object (order):

idStringrequired

Order ID (from Merchant), max: 24

Example: "134850717797247290"

titleStringrequired

Example: "1601912947341252990"

detailStringrequired

Example: ""

additionalDataString

Example: ""

amountUintrequired

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

Example: refer below example

transactionIdString

Example: ""

methodString

Example: "LOYALTY_CREDIT"

typeString

Example: "QUICK_PAY"

orderObject

Example: refer below 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"

Store object (store):

idString

Store ID

Example: "1601912947341252990"

merchantSettlementIdString

Merchant Settlement ID

Example: "1596124535165747709"

nameString

Store Name

Example: "Mountain Food - Aeon Mall Shah Alam"

imageUrlString

Yes

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"

Order object (order):

idStringrequired

Order ID (from Merchant), max: 24

Example: "134850717797247290"

titleStringrequired

Example: ""

detailStringrequired

Example: ""

amountUintrequired

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

Example: 100