alipay.intl.user.query.getUserInfo

2020-10-19 12:54

1The API is used by the merchant to get user info from the authSite.

Request

Service address

Environment	URL
Production	https://open.alipaymo.com/api/alipay/intl/user/query/getUserInfo.htm

1 Request Partameter

1.1 Header

No	Name	Description	Type	Length	Required	Sample
1	version	API version	string	8	ME	2.0.0
2	function	API interface	string	128	ME	alipay.intl.function
3	clientId	Client ID	string	32	ME	211020000000000000044
4	reqTime	Request time	datetime	/	M	2001-07-04T12:08:56+05:30
5	reqMsgId	Request message ID	string	64	ME	1234567asdfasdf1123fda
6	reserve	Reserved for future implementation	string	256	O	{}
7	accessToken	access token	string	64	M	281003132DLOSEqtdlwpxHP2X7xmu649

1.2 Body

No	Name	Description	Type	Length	Required	Sample
1	merchantId	merchant Id	String	64	M	2182400000001037

2 Response Parameter

2.1 Header

No	Name	Description	Type	Length	Required	Sample
1	version	API version	string	8	ME	2.0.0
2	function	API interface	string	128	ME	alipay.intl.function
3	clientId	Client ID	string	32	ME	211020000000000000044
4	reqTime	Request time	datetime	/	M	2001-07-04T12:08:56+05:30
5	reqMsgId	Request message ID	string	64	ME	1234567asdfasdf1123fda
6	reserve	Reserved for future implementation	string	256	O	{}
7	accessToken	access token	string	64	M	281003132DLOSEqtdlwpxHP2X7xmu649

2.2 Body

Name

Description

Type

Length

Required

Sample

resultInfo

the result informatio

Result

{

"resultStatus": "A",

"resultCode": "ACCEPT",

"resultCodeId": "00010100",

"resultMsg": "ACCEPT"

}

mobileNo

mobile info

MobileNoInfo

3 Addtional Information

3.1 Result

No	Name	Description	Type	Length	Required	Sample	Remarks
1	resultStatus	Result status	string	2	M	U	The status of the request can be: S: success，F: failure，U: unknown Can be added if these 3 statuses are insufficient for business requirements
2	resultCodeId	Result code Id	string	8	M	00000000
3	resultCode	resultCode	String	64	M	SUCCESS	When resultStatus is S, this field must be SUCCESS. When resultStatus F or U, the field can be a global return code can also return code to the business. If the return code is business related, refer the service interface element for more information.
4	resultMsg	Result message	string	256	O	Unexpected system error	When the result is S, this field may be empty. When the result is F or U, description of error must be provided.

3.2 MobileNoInfo

No	Name	Description	Type	Length	Required	Sample	Remarks
1	phoneNo	phone number	string	28	M	13564582896
2	countryCode	country code	string	8	M	86

4 Request Sample

copy
{
    "request": {
        "body": {
            "merchantId": "2182400000001037"
        },
        "head": {
            "function": "alipay.intl.user.query.getUserInfo",
            "version": "2.0.0",
            "accessToken": "281003132DLOSEqtdlwpxHP2X7xmu649",
            "reqMsgId": "20200401-tongyao-000000005",
            "reqTime": "2020-02-19T15:55:58-08:00",
            "clientId": "5C5XSR3USG0CQJ05",
            "reserve": "none"
        }
    },
    "signature": "testing_signature"
}

5 Response Sample

copy
{
    "response": {
        "head": {
            "clientId": "5C5XSR3USG0CQJ05",
            "function": "alipay.intl.user.query.getUserInfo",
            "accessToken": "281003132DLOSEqtdlwpxHP2X7xmu649",
            "reqMsgId": "20200401-tongyao-000000005",
            "respTime": "2020-04-03T06:31:35+00:00",
            "version": "2.0.0"
        },
        "body": 
                 "mobileNo": {
                "countryCode": "86",
                "phoneNo": "13564582896"
            },
            "resultInfo": {
                "resultCode": "SUCCESS",
                "resultCodeId": "00000000",
                "resultMsg": "success.",
                "resultStatus": "S"
            }
        }
    },
    "signature": "TopoTOtIqj6kgM4vT9gWvKIt9GfynnDanKdcUZTzMzOD0sX9Y/xft5rrsVvaIHfzMTvxMCvoLXhCggEazNXFpDqnPiZdwfwkK+deFNctlBTI5/PuVj/W88dV3ba3QQyDrbcCkpJ09tbs6iW0Yt1iexbCOgQjQ+UokAqiJyZDLPRsE7t657kJ4qyYRqi6qNLXpR4cbqboAe4Xfoc7UgpY379gh999FL7LPMjhWeayoKfYCtdG2ikeDhOiAI9LbUGxZwL/zK5oCUn0ftFypDQl+WC6GTN5KHMQ/MbLvIoKTFhf+ghQd18jK/mm7otzEvINBKEtBbb03ex+qSYU9bqHNg=="
}

6 Result Info

6.1 Functional Logic Result Code

NO	ResultCodeId	ResultCode	ResultStatus	Remarks
1	12002005	USER_NOT_EXIST	F	User does not exist
2	12002006	USER_STATUS_ABNORMAL	F	User status is not normal.
3	00000019	PROCESS_FAIL	F	General business failure.

6.2 Basic Result Code

No	ResultCodeId	ResultCode	ResultStatus	Remarks
1	00000000	SUCCESS	S	Success
2	00000019	PROCESS_FAIL	F	General business failure. No retry.
3	00000901	UNKNOWN_EXCEPTION	U	API failed due to unknown reason.
4	00000004	PARAM_ILLEGAL	F	Illegal parameters. For example, non-numeric input, invalid date.
5	00000007	INVALID_SIGNATURE	F	Signature is invalid.
6	00000008	KEY_NO_FOUND	F	Key is not found.
7	00000013	NO_INTERFACE_DEF	F	API is not defined
8	00000014	API_IS_INVALID	F	API is invalid (or not active)
9	00000016	OAUTH_FAILED	F	oAuth authentication failed
10	00000021	ACCESS_DENIED	F	Access denied
11	12014152	CLIENT_FORBIDDEN_ACCESS_API	F	Client is not authorized to use this API
12	12014155	UNKNOWN_CLIENT	F	Unknown client
13	12014156	INVALID_CLIENT_STATUS	F	Invalid client status
14	00000024	REQUEST_TRAFFIC_EXCEED_LIMIT	F	Request traffic exceed limit.