Retrieve Customer

You can retrieve details of a customer by sending a POST request to Yuansfer Retrieve Customer API.

Retrieve

POST https://mapi.yuansfer.com/v1/customers/retrieve

Request Body

Name	Type	Description
timestamp	string	Current UTC time, correct format should be "yyyy-mm-ddTHH:MM:SSZ"
merchantNo	string	Merchant ID
storeNo	string	Store ID
verifySign	string	The parameter signature
customerCode	string	Either customerCode or customerNo is required to retrieve the detail User-Defined ID when register
customerNo	string	Either customerCode or customerNo is required to retrieve the detail Auto-Generated ID when register

200

{
    "result":
    {
        "firstName": "Frank",
        "lastName": "Liu",
        "link": "https://mapi.yuansfer.yunkeguan.com/v1/customers/user-account/2010305228244865166344",
        "customerCode": "20210409194802",
        "accountToken": "2010305228244865166344",
        "customerNo": "2000305228244865163960",
        "email": "[e-mail]",
        "timestamp": "2021-04-09T20:28:12Z"
    },
    "ret_msg": "success",
    "ret_code": "000100"
}

Response

Parameter	Type	Description
customer	object	The customer object.
ret_msg	string	The response return message.
ret_code	string	The response return code. For more details, see here.

Customer Object

Parameter	Type	Description
zip	string	The user's zipcode
firstName	string	The user's first name
lastName	string	The user's last name
customerCode	string	The user-defined user's ID in Yuansfer's system
createdTime	string	The time when user registered account
customerNo	string	The auto-generated user's ID in Yuansfer's system
email	string	The user's email address
country	string	The user's country
updatedTime	string	The most recent datetime when making changes to the user account
city	string	The user's city
dateOfBirth	string	The user's date of birth
phone	string	The user's phone number
countryCode	string	The user's country code
street	string	The user's street address
street2	string	The user's street address Second line
state	string	The user's state
lang	string	Language customer speak