Alipay+ DocsAlipay+ Docs

inquiryUserInfoAlipay+ → MPP

POST /undefined

Alipay+ uses the inquiryUserInfo API to query the Mobile Payment Partner (MPP) user information with the related access token.

Note: In the following sections, the MPP is also known as PSP. For example, pspId refers to the ID that identifies an MPP. 

Structure 

A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see:

Note:

1. Set the data type of each parameter (except array) as String. This means that you must use double quotation marks (" ") to enclose the parameter value. Examples:

  • If the data type of a parameter is Integer and its value is 20, set it as "20".
  • If the data type of a parameter is Boolean and its value is true, set it as "true".  

2. For optional parameters that are not required in your case, you can take one of the following actions:

  • Exclude the parameters from the request body. 
  • Set the parameter values as null (without the double quotation marks). 

Do NOT leave the optional parameters empty by setting their values as ""; otherwise, an error might occur.  

Request parameters

pspId String  REQUIRED

The unique ID that is assigned by Alipay+ to identify an MPP. 

More information about this field

  • Maximum length: 64 characters

acquirerId String  REQUIRED

The unique ID that is assigned by Alipay+ to identify an Acquiring Partner (ACQP). 

More information about this field

  • Maximum length: 64 characters

accessToken String  REQUIRED

The token that is used to access the MPP user's resources. 

More information about this field

  • Maximum length: 128 characters

Response parameters

result Result object REQUIRED

The result of the user information inquiry. For more information about how to return the result, see How to return the result.

Show child parameters

userInfo User object 

The MPP user information. The MPP returns the user information in the userInfo parameter based on the specified scopes of the access token (as defined by the scopes parameter of the prepare API). 

See the following list for details:

  • If the value of scopes is BASE_USER_INFO, userId is returned.
  • If the value of scopes is USER_LOGIN_ID, userLoginId is returned.
  • If the value of scopes is HASH_LOGIN_ID, hashUserLoginId is returned.
  • If multiple values of scopes are specified for the same access token, all the corresponding parameters are returned.

Return this parameter if the value of the result.resultCode parameter is SUCCESS. 

Show child parameters
API Explorer

Request

Request Body

Response

Response Body

More information

How to return the result

According to the request processing result, the MPP needs to return the corresponding result (specified by the result parameter):

  • If the user information inquiry succeeds, set the value of result.resultStatus to S and the value of result.resultCode to SUCCESS.
  • If the user information inquiry fails, set the value of result.resultStatus to F and the value of result.resultCode accordingly.
  • If the user information inquiry result is unknown, set the value of result.resultStatus to U and the value of result.resultCode accordingly.

For more information about how to define your result codes, see the Result codes section below. 

Result/Error codes

CodeValueMessage
SUCCESSSSuccess
ACCESS_DENIEDFAccess is denied.
INVALID_CLIENTFThe client is invalid.
INVALID_SIGNATUREFThe signature is invalid.
INVALID_TOKENFThe access token is invalid.
KEY_NOT_FOUNDFThe key is not found.
MEDIA_TYPE_NOT_ACCEPTABLEFThe server does not implement the media type that is acceptable to the client.
METHOD_NOT_SUPPORTEDFThe server does not implement the requested HTTPS method.
NO_INTERFACE_DEFFAPI is not defined.
PARAM_ILLEGALFIllegal parameters. For example, non-numeric input, invalid date.
PROCESS_FAILFA general business failure occurred. Do not retry.
REQUEST_TRAFFIC_EXCEED_LIMITUThe request traffic exceeds the limit.
UNKNOWN_EXCEPTIONUAn API call failed, which is caused by unknown reasons.