Alipay, China's leading third-party online payment solutionAlipay, China's leading third-party online payment solution

      notifyRegistrationStatus

      Alipay uses the notifyRegistrationStatus API to send the merchant registration result to the merchant. 

      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 StringOptional

      The secondary merchant ID that is assigned by the acquirer.

      More information about this field:

      • Maximum length: 64 characters
      registrationRequestId StringOptional

      The unique ID used to identify a registration request. 

      More information about this field:

      • This field is an API idempotency field. Merchant uses the registrationRequestId field for idempotency control. For registration requests that are initiated with the same value of registrationRequestId and reach a final status (S or F), the same result is to be returned for the request.
      • Maximum length: 64 characters
      referenceStoreId StringOptional

      The store ID assigned by the acquirer to identify a store, which is associated with the merchant.

      More information about this field:

      • Maximum length: 32 characters
      registrationResult RegistrationResultOptional

      The wallet registration result information

      registrationStatus StringRequired

      The status of secondary merchant registration result. Valid values are:

      • COMPLETED: All wallets have returned registration result.
      • PENDING: Await for registration result. PSPRegistrationResultList shows the registration status of wallets that have returned result so far.
      • CANCELLED: The new merchant registration information overwrites the last registration request which is in ​PENDING​ status. Only displayed in the PSPRegistrationResultList filed.
      • APPROVED: The registration is approved by the wallet. Only displayed in the PSPRegistrationResultList filed.
      • REJECTED: The registration request is rejected by wallet or ipay.  
      rejectReasons StringOptional

      The reason for rejection. Valid values are:

      • FEE_TIER_ILLEGAL: FeeTier of the store is invalid.
      • INFOSEC_CONTENT_ERROR_CODE: Secondary merchant name or store name contain sensitive information, modify and submit again.
      • LEGAL_ENTITY_TYPE_ILLEGAL: Type of legal entity is invalid.
      • LEGAL_ENTITY_TYPE_IS_BLANK: Type of legal entity is required.
      • LEGAL_PERSON_ID_IS_BLANK: ID of legal person is required.
      • LEGAL_PERSON_NAME_IS_BLANK: Name of legal person is required.
      • LEGAL_PERSON_REGION_ILLEGAL: Nationality of legal person is invalid.
      • LEGAL_PERSON_REGION_IS_BLANK: Nationality of legal person is required.
      • MERCHANT_COUNT_EXCEEDS_LIMIT: Only one acquirer can be registered at a time. Multiple acquirers need to be registered several times.
      • MERCHANT_EXIST_MULTI_REGION: Multiple data centers exist for the merchant.
      • MERCHANT_ID_IS_BLANK: Merchant ID is required.
      • MERCHANT_LEGAL_NAME_IS_BLANK: Legal name of merchant is required.
      • MERCHANT_MCC_ILLEGAL: Merchant MCC is invalid.
      • MERCHANT_MCC_IS_BLANK: Merchant MCC is required.
      • MERCHANT_NOT_EXIST: The acquirer does not exist.
      • MERCHANT_ROLE_IS_NOT_ACQUIRE: The merchant is not an acquirer.
      • REGISTER_ADDRESS_IS_BLANK: Store Address is required.
      • REGISTRATION_ADDRESS_IS_BLANK: Registration address is required.
      • REGISTRATION_NO_IS_BLANK: Registration number is required.
      • REGISTRATION_REGION_ILLEGAL: Registration country/region is invalid.
      • REGISTRATION_REGION_IS_BLANK: Registration country/region is required.
      • REGISTRATION_TYPE_IS_BLANK: Registration type is required.
      • RISK_AML_REJECT: The audit failed. Contact merchant service support to leave a feedback and register again
      • RISK_LACK_WEBSITE_1_2: The website URL is required. Provide the valid website URL and register again or contact merchant service support to leave a feedback.
      • RISK_REJECT_BUSINESS_1_1: Registered country/region, registration number, legal name of entity or type of business entity is inconsistent. Provide correct information and register again or contact merchant service support to leave a feedback.
      • RISK_REJECT_BUSINESS_1_2: Registered country/region, registration number, legal name of entity or type of business entity is inconsistent. Provide correct information and register again or contact merchant service support to leave a feedback.
      • RISK_REJECT_BUSINESS_2_1: Registered country/region, registration number, legal name of entity or type of business entity is inconsistent. Provide correct information and register again or contact merchant service support to leave a feedback.
      • RISK_REJECT_BUSINESS_2_2: Registered country/region, registration number, legal name of entity or type of business entity is inconsistent. Provide correct information and register again or contact merchant service support to leave a feedback.
      • RISK_REJECT_HIGHRISK_1_1: The storefront photo is invalid. Provide a clear storefront photo and register again or contact merchant service support to leave a feedback.
      • RISK_REJECT_HIGHRISK_1_2: The website URL is required. Provide the valid website URL and register again or contact merchant service support to leave a feedback.
      • RISK_REJECT_HIGHRISK_2_1: The store interior photo is invalid. Provide a clear store interior photo and register again or contact merchant service support to leave a feedback.
      • RISK_REJECT_HIGHRISK_2_2: The website URL is invalid. Contact merchant service support to leave a feedback and register again.
      • RISK_REJECT_HIGHRISK_3_1: The storefront photo is invalid. Contact merchant service support to leave a feedback and register again.
      • RISK_REJECT_HIGHRISK_4_1: The store interior photo is invalid. Contact merchant service support to leave a feedback and register again.
      • RISK_WEBSITE_ILLEGAL_1_2: The website URL is invalid. Contact merchant service support to leave a feedback and register again.
      • RISK_WEBSITE_INCOMPLETE_1_2: The website URL is incomplete. Provide the complete website URL and register again or contact merchant service support to leave a feedback.
      • RISK_WEBSITE_NEED_LOGIN_1_2: The username and password are required to login. Remove the password restriction or provide password to merchant service support for audit assistance.
      • RISK_WEBSITE_NOPAY_1_2: No payment activity under the business. Provide detailed business information to merchant service support.
      • SECOND_MERCHANT_ID_IS_BLANK: Secondary merchant ID is required.
      • SECOND_MERCHANT_LEGAL_NAME_IS_BLANK: legal name of secondary merchant is required.
      • SHAREHOLDER_ID_IS_BLANK: The company owner or shareholder ID is required.
      • SHAREHOLDER_NAME_IS_BLANK: Full legal name of the company owner or shareholder is required.
      • SHAREHOLDER_REGION_ILLEGAL: Nationality of the company owner or shareholder is invalid.
      • SHAREHOLDER_REGION_IS_BLANK: Nationality of the company owner or shareholder is required.
      • STORE_ADDRESS_IS_BLANK: Store address is required.
      • STORE_CONTACT_ILLEGAL: The number of store contact info is invalid.
      • STORE_CONTACT_SIZE_ILLEGAL: The store contact info is invalid.
      • STORE_ID_IS_BLANK: Store ID is required.
      • STORE_MCC_ILLEGAL: MCC of the store is invalid.
      • STORE_MCC_IS_BLANK: MCC of the store is required.
      • STORE_NAME_IS_BLANK: Store name is required.
      • STORE_REGION_IS_BLANK: Country/region of the store is required.
      • STORE_REGION_IS_ILLEGAL: Country/region of the store is invalid.
      • WEBSITE_ILLEGAL: Website URL format is invalid.
      • WEBSITE_IS_BLANK: URL is required.
      • WEBSITE_TYPE_ILLEGAL: Website URL type is invalid. 
      pspRegistrationResultList Array<PSPRegistrationResult>Optional

      The registration result from Alipay+ MPP (Alipay+ Mobile Payment Partner).

      registrationResult RegistrationResultOptional

      The wallet registration result information

      registrationStatus StringRequired

      The status of secondary merchant registration result. Valid values are:

      • COMPLETED: All wallets have returned registration result.
      • PENDING: Await for registration result. PSPRegistrationResultList shows the registration status of wallets that have returned result so far.
      • CANCELLED: The new merchant registration information overwrites the last registration request which is in ​PENDING​ status. Only displayed in the PSPRegistrationResultList filed.
      • APPROVED: The registration is approved by the wallet. Only displayed in the PSPRegistrationResultList filed.
      • REJECTED: The registration request is rejected by wallet or ipay.  
      rejectReasons StringOptional

      The reason for rejection. Valid values are:

      • FEE_TIER_ILLEGAL: FeeTier of the store is invalid.
      • INFOSEC_CONTENT_ERROR_CODE: Secondary merchant name or store name contain sensitive information, modify and submit again.
      • LEGAL_ENTITY_TYPE_ILLEGAL: Type of legal entity is invalid.
      • LEGAL_ENTITY_TYPE_IS_BLANK: Type of legal entity is required.
      • LEGAL_PERSON_ID_IS_BLANK: ID of legal person is required.
      • LEGAL_PERSON_NAME_IS_BLANK: Name of legal person is required.
      • LEGAL_PERSON_REGION_ILLEGAL: Nationality of legal person is invalid.
      • LEGAL_PERSON_REGION_IS_BLANK: Nationality of legal person is required.
      • MERCHANT_COUNT_EXCEEDS_LIMIT: Only one acquirer can be registered at a time. Multiple acquirers need to be registered several times.
      • MERCHANT_EXIST_MULTI_REGION: Multiple data centers exist for the merchant.
      • MERCHANT_ID_IS_BLANK: Merchant ID is required.
      • MERCHANT_LEGAL_NAME_IS_BLANK: Legal name of merchant is required.
      • MERCHANT_MCC_ILLEGAL: Merchant MCC is invalid.
      • MERCHANT_MCC_IS_BLANK: Merchant MCC is required.
      • MERCHANT_NOT_EXIST: The acquirer does not exist.
      • MERCHANT_ROLE_IS_NOT_ACQUIRE: The merchant is not an acquirer.
      • REGISTER_ADDRESS_IS_BLANK: Store Address is required.
      • REGISTRATION_ADDRESS_IS_BLANK: Registration address is required.
      • REGISTRATION_NO_IS_BLANK: Registration number is required.
      • REGISTRATION_REGION_ILLEGAL: Registration country/region is invalid.
      • REGISTRATION_REGION_IS_BLANK: Registration country/region is required.
      • REGISTRATION_TYPE_IS_BLANK: Registration type is required.
      • RISK_AML_REJECT: The audit failed. Contact merchant service support to leave a feedback and register again
      • RISK_LACK_WEBSITE_1_2: The website URL is required. Provide the valid website URL and register again or contact merchant service support to leave a feedback.
      • RISK_REJECT_BUSINESS_1_1: Registered country/region, registration number, legal name of entity or type of business entity is inconsistent. Provide correct information and register again or contact merchant service support to leave a feedback.
      • RISK_REJECT_BUSINESS_1_2: Registered country/region, registration number, legal name of entity or type of business entity is inconsistent. Provide correct information and register again or contact merchant service support to leave a feedback.
      • RISK_REJECT_BUSINESS_2_1: Registered country/region, registration number, legal name of entity or type of business entity is inconsistent. Provide correct information and register again or contact merchant service support to leave a feedback.
      • RISK_REJECT_BUSINESS_2_2: Registered country/region, registration number, legal name of entity or type of business entity is inconsistent. Provide correct information and register again or contact merchant service support to leave a feedback.
      • RISK_REJECT_HIGHRISK_1_1: The storefront photo is invalid. Provide a clear storefront photo and register again or contact merchant service support to leave a feedback.
      • RISK_REJECT_HIGHRISK_1_2: The website URL is required. Provide the valid website URL and register again or contact merchant service support to leave a feedback.
      • RISK_REJECT_HIGHRISK_2_1: The store interior photo is invalid. Provide a clear store interior photo and register again or contact merchant service support to leave a feedback.
      • RISK_REJECT_HIGHRISK_2_2: The website URL is invalid. Contact merchant service support to leave a feedback and register again.
      • RISK_REJECT_HIGHRISK_3_1: The storefront photo is invalid. Contact merchant service support to leave a feedback and register again.
      • RISK_REJECT_HIGHRISK_4_1: The store interior photo is invalid. Contact merchant service support to leave a feedback and register again.
      • RISK_WEBSITE_ILLEGAL_1_2: The website URL is invalid. Contact merchant service support to leave a feedback and register again.
      • RISK_WEBSITE_INCOMPLETE_1_2: The website URL is incomplete. Provide the complete website URL and register again or contact merchant service support to leave a feedback.
      • RISK_WEBSITE_NEED_LOGIN_1_2: The username and password are required to login. Remove the password restriction or provide password to merchant service support for audit assistance.
      • RISK_WEBSITE_NOPAY_1_2: No payment activity under the business. Provide detailed business information to merchant service support.
      • SECOND_MERCHANT_ID_IS_BLANK: Secondary merchant ID is required.
      • SECOND_MERCHANT_LEGAL_NAME_IS_BLANK: legal name of secondary merchant is required.
      • SHAREHOLDER_ID_IS_BLANK: The company owner or shareholder ID is required.
      • SHAREHOLDER_NAME_IS_BLANK: Full legal name of the company owner or shareholder is required.
      • SHAREHOLDER_REGION_ILLEGAL: Nationality of the company owner or shareholder is invalid.
      • SHAREHOLDER_REGION_IS_BLANK: Nationality of the company owner or shareholder is required.
      • STORE_ADDRESS_IS_BLANK: Store address is required.
      • STORE_CONTACT_ILLEGAL: The number of store contact info is invalid.
      • STORE_CONTACT_SIZE_ILLEGAL: The store contact info is invalid.
      • STORE_ID_IS_BLANK: Store ID is required.
      • STORE_MCC_ILLEGAL: MCC of the store is invalid.
      • STORE_MCC_IS_BLANK: MCC of the store is required.
      • STORE_NAME_IS_BLANK: Store name is required.
      • STORE_REGION_IS_BLANK: Country/region of the store is required.
      • STORE_REGION_IS_ILLEGAL: Country/region of the store is invalid.
      • WEBSITE_ILLEGAL: Website URL format is invalid.
      • WEBSITE_IS_BLANK: URL is required.
      • WEBSITE_TYPE_ILLEGAL: Website URL type is invalid. 
      pspName StringRequired

      The name of Alipay+ MPP. Valid values are:

      • AlipayCN: Alipay CN wallet
      • AlipayHK: Alipay HK wallet
      • bKash: bKash wallet
      • Dana: Dana wallet
      • Easypaisa: EasyPaisa wallet
      • Gcash: Gcash wallet
      • KaKaoPay: KakaoPay wallet
      • TouchNGo: Touch'n Go wallet
      • TrueMoney: TrueMoney wallet 

      Response parameters

      result ResultRequired

      The request result contains information such as status and error codes.

      resultCode StringRequired

      Result code

      More information about this field:

      • Maximum length: 64 characters
      resultStatus StringOptional

      Result status. Valid values are:

      • S: Successful 
      • F: Failed 
      • U: Unknown

      More information about this field:

      • Maximum length: 2 characters
      resultMessage StringOptional

      Result message that describes resultCode in detail.

      More information about this field:

      • Maximum length: 256 characters

      Error codes

      Error codes are usually classified into the following categories:

      • Common error codes: common for all online and in-store payment APIs.
      • API-specific error codes: listed in the following table.  

      Result/Error codes

      CodeValueMessageFurther action
      SUCCESSSSuccess

      The registration is successful, no further action is needed.

      Request/Response Code
      Request Body (Alipay to merchant)
      Request parameters
      Response Body (merchant to Alipay)
      Body content