Register Loyalty Member
Register a new loyalty member under the merchant. Returns the new member's profile record.
When to Use
▾
Use this endpoint when:
- Onboarding a new customer to your loyalty program
- Registering a member during checkout flow
How to Use
▾
/v3/loyalty/memberPOST member details (name, country code, phone, email, NRIC, etc.) to create the record. The response includes the new member's key.
Request Parameters
▾
Member name
Example: "Oska"
Country code of member contact number
Example: "60"
Phone number of member
Example: "1878241234"
Email address of member
Example: "[email protected]"
IC Number
Example: "950711011234"
Member Birth Date
Example: "1995-07-11T00:00:00Z"
Gender
Example: "MALE"
Loyalty Point
Example: 0
Refer to explanation below
Example: (Refer to explanation below)
Response Parameters
▾
Profile object
Profile ID
Example: ""
Profile Key (Internal Usage)
Example: "EhIKBk1lbWJlchDOuOKz24XWkg4SGQoNTWVtYmVyUHJvZmlsZRDl-MTxiPOPjzY"
Profile name
Example: "Oska"
Profile email
Example: "[email protected]"
IC Number
Example: "950711011234"
User Birth Date (YYYY:MM:DD)
Example: "1995-07-11"
Gender
Example: "MALE"
Refer to explanation below
Address 1
Example: ""
Address 2
Example: ""
Postcode
Example: ""
City
Example: ""
State
Example: ""
Country
Example: ""
Member Tier Point
Example: null
Total Loyalty Point
Example: 0
User Pin
Example: false
Total Point Balance left
Example: 0
Point Spend
Example: 0
Credit Balance
Example: 0
Profile Status
Example: "ACTIVE"
Creation date time
Example: "2018-10-19T03:39:47Z"
Last update date time
Example: "2020-06-29T10:14:33Z"
Successfully call this endpoint. If fail, will return error code object (Refer Appendix 1: Error Codes)
Example: "SUCCESS"