Alipay+ DocsAlipay+ Docs

inquiryCustomerIdAlipay+ → MPP

POST /undefined

Alipay+ uses the inquiryCustomerId API to get the ID that is assigned by the Mobile Payment Provider (MPP) to identify an MPP user (the customer ID).

This API is only applicable to special scenarios. For example, in the User-presented Mode Payment scenario, Alipay+ needs to get the customer ID by using the payment code or the user login ID. 

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

acquirerId String  REQUIRED

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

More information about this field

  • Maximum length: 64 characters

pspId String  REQUIRED

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

More information about this field

  • Maximum length: 64 characters

inquiryType String  REQUIRED

This parameter indicates what is used to get the customerId. Valid values are:

  • BY_PAYMENT_CODE: indicates that the payment code is used. This value is specified for the User-presented Mode Payment scenario.
  • BY_LOGIN_ID: indicates that the plaintext user login ID is used. This value is specified for the Auto Debit scenario. 

plaintextUserLoginId String  

The ID that the user uses to log in to the MPP platform. The ID is assigned by the MPP and is in plain text. If the ID is a mobile number, it must be in E.164 format. For example, +442044555666.

This parameter is specified by Alipay+ if the value of the inquiryType parameter is BY_LOGIN_ID. 

More information about this field

  • Maximum length: 64 characters

paymentCode String  

The value of the payment code that is used in the User-presented Mode Payment scenario.

This parameter is specified by Alipay+ if the value of the inquiryType parameter is BY_PAYMENT_CODE. 

More information about this field

  • Maximum length: 128 characters

Response parameters

result Result object REQUIRED

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

Show child parameters

customerId String  

The unique ID that is assigned by the MPP to identify an MPP user.

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

More information about this field

  • Maximum length: 64 characters
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 ID inquiry succeeds, set the value of result.resultStatus to S and the value of result.resultCode to SUCCESS.
  • If the user ID inquiry fails, set the value of result.resultStatus to F and the value of result.resultCode accordingly.
  • If the user ID 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. 

Sample

1. Alipay+ sends the request to Mobile Payment Partner.

  • In the following example, the plaintext user login ID is used to get the customer ID:
Sample Code

  • In the following example, the payment code is used to get the customer ID:  
Sample Code

2. Mobile Payment Partner returns the result to Alipay+. 

Sample Code

Result/Error codes

CodeValueMessage
SUCCESSSSuccess
ACCESS_DENIEDFAccess is denied.
INVALID_CLIENTFThe client is invalid.
INVALID_CODEFThe code is invalid.
INVALID_CODEFThe code is invalid.
INVALID_SIGNATUREFThe signature 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.
USER_NOT_EXISTFThe user does not exist.
REQUEST_TRAFFIC_EXCEED_LIMITUThe request traffic exceeds the limit.
UNKNOWN_EXCEPTIONUAn API call failed, which is caused by unknown reasons.