Customer

Member APIs reference

Summary

Get the user's basic profile information: their SkyJoyID, information, and balance

Methods

---

Customer Info

GET https://api.skyjoy.vn/api-user/partner/v1/user-profile/{skyjoyId}

Path Parameters

Name	Type	Description
skyjoyId*	string

Headers

Name	Type	Description
Authorization*	string	Bearer <YOUR_ACCESS_TOKEN>
Content-Type*	string	application/json

200: OK OK

{
    "statusCode": 200,
    "message": "SUCCESS",
    "data": {
        "skyjoyId": "SJ3609438573",
        "dateOfBirth": "01-01-1990",
        "dateOfJoin": "17-01-2023",
        "email": "[e-mail]",
        "firstName": "NGUYEN VAN",
        "lastName": "A",
        "fullName": "NGUYEN VAN A",
        "eKycStatus": "COMPLETE",
        "status": "ACTIVE",
        "phone": "[phone]"
    }
}

Curl

curl -X GET \
 --header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
 --header 'Content-Type: application/json' \
 'https://api.skyjoy.vn/api-user/partner/v1/user-profile/{skyjoyId}'

---

Customer Profile

GET https://api.skyjoy.vn/api-user/partner/v1/user-profile-ext/{skyjoyId}

Path Parameters

Name	Type	Description
skyjoyId*	string

Headers

Name	Type	Description
Authorization*	string	Bearer <YOUR_ACCESS_TOKEN>
Content-Type*	string	application/json

200: OK OK

{
    "statusCode": 200,
    "message": "SUCCESS",
    "data": {
        "enrollingSponsor": "SkyJoy",
        "passportNumber": "P0XXXXXXX1",
        "nationalId": "N0XXXXXXXX1",
        "tierClass": "Diamond",
        "skyjoyId": "SJ3609438573"
    }
}

Curl

curl -X GET \
 --header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
 --header 'Content-Type: application/json' \
 'https://api.skyjoy.vn/api-user/partner/v1/user-profile-ext/{skyjoyId}'

---

User Onboarding

POST https://api.skyjoy.vn/api-user/partner/v1/user/onboard

Headers

Name	Type	Description
Authorization*	string	Bearer <YOUR_ACCESS_TOKEN>
Content-Type*	string	application/json

Request Body

Name	Type	Description
phone*	string	Phone number
fullName*	string	Full name
firstName	string	First name
lastName	string	Last name
gender*	string	Gender choose from [male, female, other]
birthday*	string	Birthday in ISO8601 format (YYYY-MM-DD)
email	string	Email address
isKYC*	boolean	Is KYC or not
idNumber*	string	ID number that is used for eKYC Required if passportNumber is null
passportNumber*	string	Passport number that is used for eKYC Required if idNumber is null
placeOfIssue*	string	Place of issue in eKYC document
placeOfBirth*	string	Place of birth in eKYC document
issueDate*	string	Identity Card or Passport issue date in ISO8601 format (YYYY-MM-DD)
expireDate*	string	Identity Card or Passport expire date in ISO8601 format (YYYY-MM-DD)
nationality*	string	Country code in ISO 3166-1 alpha-3 format
address*	string	Address in eKYC document
externalId*	string	Unique partner member ID

200: OK OK

{
    "statusCode": 200,
    "message": "SUCCESS",
    "data": {
        "phone": "[phone]",
        "fullName": "Nguyen Van A",
        "firstName": "Van A",
        "lastName": "Nguyen",
        "memberCode": "SJ0123456789",
        "createdAt": "2024-02-21T08:29:21.686Z"
    }
}

400: Bad Request Bad Request

{
    "statusCode": 400,
    "message": "Bad Request",
    "errors": {
        "code": "0001",
        "message": "Bad Request",
        "errorCode": "BAD_REQUEST"
    },
    "data": {
        "resultUrl": "https://partner-app.skyjoy.vn?errorCode=0066"
    }
}

Curl

curl -X POST \
 --header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
 --header 'Content-Type: application/json' \
 -d '{"phone":"[phone]","fullName":"Nguyen Van A","firstName":"Van A","lastName":"Nguyen","gender":"Nguyen","memberCode":"SJ84387255954","birthday":"1970-01-01","email":"[e-mail]","isKYC":"true","idNumber":"0123456789","passportNumber":"0123456789","placeOfIssue":"CQLTTVHCXH","placeOfBirth":"Sai Gon","issueDate":"2023-08-09","expireDate":"2033-08-09","nationality":"VNM","address":"Q8, HCM, Viet Nam","externalId":"41987712"}' \
 'https://api.skyjoy.vn/api-user/partner/v1/user/onboard'

---

Customer Balance

GET https://api.skyjoy.vn/api-point/partner/v1/user-balance/{skyjoyId}

Path Parameters

Name	Type	Description
skyjoyId*	string

Headers

Name	Type	Description
Authorization*	string	Bearer <YOUR_ACCESS_TOKEN>
Content-Type*	string	application/json

200: OK OK

{
    "statusCode": 200,
    "message": "SUCCESS",
    "data": {
        "skyjoyId": "SJ5408563422",
        "totalPoint": 964
    }
}

Curl

curl -X GET \
 --header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
 --header 'Content-Type: application/json' \
 'https://api.skyjoy.vn/api-point/partner/v1/user-balance/{skyjoyId}'

---

Link Account

POST https://api.skyjoy.vn/api-user/partner/v1/user/link-member

Headers

Name	Type	Description
Authorization*	string	Bearer <YOUR_ACCESS_TOKEN>
Content-Type*	string	application/json

Request Body

Name	Type	Description
skyjoyId*	string	SkyJoy member ID
partnerMemberId*	string	Partner unique member ID

200: OK OK

{
    "statusCode": 200,
    "message": "SUCCESS",
    "data":  {
        "phone": "[phone]",
        "skyjoyId": "SJ0123456789"
    }
}

400: Bad Request

{
    "statusCode": 400,
    "message": "Bad Request",
    "errors": {
        "code": "MEMBER_IS_LINKED",
        "message": "This account has been linked.",
        "name": "MemberIsLinkedException"
    }
}

Curl

curl -X POST \
 --header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
 --header 'Content-Type: application/json' \
 -d '{ "skyjoyId": "SJ2055871926", "partnerMemberId": "VK084282" }' \
 'https://api.skyjoy.vn/api-user/partner/v1/user/link-member'

---

Unlink Account

POST https://api.skyjoy.vn/api-user/partner/v1/user/unlink-member

Headers

Name	Type	Description
Authorization*	string	Bearer <YOUR_ACCESS_TOKEN>
Content-Type*	string	application/json

Request Body

Name	Type	Description
skyjoyId*	string	SkyJoy member ID
partnerMemberId*	string	Partner unique member ID

200: OK OK

{
    "statusCode": 200,
    "message": "SUCCESS",
    "data": true
}

400: Bad Request

{
    "statusCode": 400,
    "message": "Bad Request",
    "errors": {
        "code": "MEMBER_IS_NOT_LINKED_YET",
        "message": "This account is not linked yet.",
        "name": "MemberIsNotLinkedException"
    }
    
}

Curl

curl -X POST \
 --header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
 --header 'Content-Type: application/json' \
 -d '{ "skyjoyId": "SJ2055871926", "partnerMemberId": "VK084282" }' \
 'https://api.skyjoy.vn/api-user/partner/v1/user/unlink-member'