Alipay+ DocsAlipay+ Docs

getPaymentCodeMPP Alipay+

POST /aps/api/v1/codes/getPaymentCode

In the User-presented Mode Payment scenario, this API is used by the Mobile Payment Provider (MPP) to obtain payment codes from Alipay+. If the request succeeds, the MPP receives payment codes and can then display payment codes on the MPP app.

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

region String  

The region that is selected by the user as where the payment occurs. The value of this parameter must be a 2-character country/region code that follows the ISO 3166 standard.

More information about this field

  • Maximum length: 2 characters

customerId String  REQUIRED

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

More information about this field

  • Maximum length: 64 characters

codeQuantity Integer  

The number of payment codes to be returned. The default value of this parameter is 1. The MPP can specify this parameter to obtain multiple payment codes at a time. With multiple payment codes, the MPP can display a new payment code in case a previous one is expired, as the validity period of a payment code is only 1 minute.  

More information about this field

  • Maximum length: 2 characters
  • Value range: 1-10

env Env object REQUIRED

The environment information about the device that is used by the user to request the payment code.

Show child parameters

Response parameters

result Result object REQUIRED

The result of the business processing, including the result code, result status, and result message. For more information about how to handle the result, see How to handle the result.

Show child parameters

paymentCodeInfoList Array<PaymentCodeInfo> object 

A list of payment codes. The quantity of the payment codes is determined by the codeQuantity parameter in the request.

This parameter is returned by Alipay+if the value of the result.resultStatus parameter is S, which means that the request is successful. The default validity period of a code is one minute and has a 30 seconds overlap with other codes.

Show child parameters
API Explorer
Sample CodesRun in Sandbox

Request

URL
Request Body

Response

Response Body

More information

How to handle the result

You might receive different results from Alipay+. Follow the instructions below to handle the result.

result.resultStatus

result.resultCode

Request status

Actions

S

SUCCESS

Successful

Display the payment code.

F

Multiple possible values exist, such as

ACCESS_DENIED,

INVALID_CLIENT, etc.

Failed

Take actions according to the result code (specified on the result.resultCode parameter). For more information, see the Result codes section below.

U

Multiple possible values exist, such as REQUEST_TRAFFIC_EXCEED_LIMIT,

UNKNOWN_EXCEPTION, etc.

Unknown.

Retry the same request.

No result received

Unknown

Retry the same request.

Result/Error codes

CodeValueMessageFurther action
SUCCESSSSuccess

Display the payment code.

ACCESS_DENIEDFAccess is denied.

It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue.

INVALID_CLIENTFThe client is invalid.

It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue.

INVALID_SIGNATUREFThe signature is invalid.

Check whether the public key, signed message, and signature algorithm are as expected.

KEY_NOT_FOUNDFThe key is not found.

It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue.

MEDIA_TYPE_NOT_ACCEPTABLEFThe server does not implement the media type that is acceptable to the client.

Use a media type that is accepted by Alipay+.

METHOD_NOT_SUPPORTEDFThe server does not implement the requested HTTPS method.

Ensure the HTTP method is POST.

NO_INTERFACE_DEFFAPI is not defined.

Check whether the request URL is correct. Ensure that the endpoint of the called API is correct.

PARAM_ILLEGALFIllegal parameters. For example, non-numeric input, invalid date.

Check whether the request parameters, including the header parameters and body parameters, are correct and valid. For more information about the parameters of each API, see the Structure section of the specific API reference topic.

PROCESS_FAILFA general business failure occurred. Do not retry.

It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue.

REQUEST_TRAFFIC_EXCEED_LIMITUThe request traffic exceeds the limit.

Reduce the frequency of API calls.

UNKNOWN_EXCEPTIONUAn API call failed, which is caused by unknown reasons.

Try to recall the API.