Alipay+Alipay+

notifyRegistrationStatus

POST /aps/api/v1/merchants/notifyRegistrationStatus

The notifyRegistrationStatus API is used by Alipay+ to notify the Acquiring Partner (ACQP) of the merchant registration result. Each time Alipay+ receives a notification from the Mobile Payment Partner (MPP), Alipay+ will notify the ACQP of the registration status. 

Note: In the following sections, Mobile Payment Partner(MPP) is also known as Payment Service Provider. For example, the pspId parameter specifies 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: 

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

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

Request parameters

referenceMerchantId String  REQUIRED

The unique ID that is assigned by the ACQP to identify a merchant. 

More information about this field:

  • Maximum length: 64 characters

referenceStoreId String  

The unique ID that is assigned by the ACQP to identify a store, which is affiliated with the merchant.

Note: Specified byAlipay+ if the merchant supports in-store payments. 

More information about this field:

  • Maximum length: 32 characters

registrationResult RegistrationResult object REQUIRED

The collective registration result of all the MPPs to be registered to for each of the unique pair of referenceMerchantId and referenceStoreId

Show child parameters

pspRegistrationResultList Array<PSPRegistrationResult> object 

The list of individual registration results of all the MPPs to be registered to.

Note: Specified by Alipay+ if at least one MPP has updated its registration status.

More information about this field:

  • Maximum size: Unlimited
Show child parameters

registrationRequestId String  

The unique ID that is assigned by the ACQP to identify a registration request.

Note: Specified by Alipay+ if the merchant supports in-store payments and referenceStoreId is not specified. 

More information about this field:

  • Maximum length: 64 characters

Response parameters

result Result object REQUIRED

The result of the business processing, including the result status, result code, and the result message.  

Show child parameters
API Explorer

Request

Request Body

Response

Response Body

Result/Error codes

CodeValueMessageFurther action
SUCCESSSSuccess

N/A

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.