Membership
Operation related to customer's account with 3rd party
Get OTP
Get OTP from 3rd party system with phoneNumber (Membership sign-up)
Resource method
POST
Parameters
| Field name | Types | Required/Optional | Description |
|---|---|---|---|
| userId | string(36) | R | User’s id from either LINE or Facebook |
| postalCode | string(10) | O | User’s postal code |
| phoneNumber | string(10) | R | User’s phone number |
Example request parameter
{
"userId": "U1325a29a021d91231239123",
"postalCode": "12345",
"phoneNumber": "0987654321"
}
Example response object
New customer registering for membership
{
"isExistingMember": false,
"refCode": "VA12345"
}
Existing customer linking their account with 3rd party
{
"isExistingMember": true,
"refCode": ""
}
Register OTP
Register OTP code with 3rd party system
Resource method
POST
Parameters
| Field name | Types | Required/Optional | Description |
|---|---|---|---|
| userId | string(36) | R | User’s id from either LINE or Facebook |
| postalCode | string(10) | O | User’s postal code |
| refCode | string(10) | R | Reference code from previous API call |
| otp | string(10) | R | OTP code from VILLA API to user’s phone number |
Example request parameter
{
"userId": "U1325a29a021d91231239123",
"postalCode": "12345",
"refCode": "VA12345",
"otp": "123456"
}
Example expected response object
200 - OK status code