Alipay+ DocsAlipay+ Docs

Release Notes

Version 1.2.1

Release date: 2023/02/28

New features

  • Released the getPaymentCode API for MPPs to obtain payment codes from Alipay+ in the User-presented Mode Payment scenario. For more information, see the getPaymentCode API specification and User-presented Mode Payment integration guide.

Enhanced features

  • Modified the maximum length of the order.merchant.referenceMerchantId and parameters in the pay and userInitiatedPay APIs from 64 characters to 32 characters.
  • Updated the code rule to identify EMV codes in the Cashier Payment and Merchant-presented Mode Payment scenarios. For more information, see the following documents:

Document improvements

  • Corrected the endpoint of the inquiryCodeRules API from /aps/api/v1/payments/inquiryCodeRules to /aps/api/v1/codes/inquiryCodeRules. For more information, see the inquiryCodeRules API specification.
  • Added a note in the Reconcile documentation to emphasize that Alipay+ reports prevail when discrepancies exist due to payment status inconsistencies between the MPP system and the Alipay+ system. For more information, see Process overview of the Perform reconciliation topic.
  • Added troubleshooting instructions about signature validation to the message transmission section of the FAQ documentation.
  • Removed the enumeration value MINI_APP from the terminalType parameter in the prepare API specification because currently authorization cannot be initiated via mini apps.

Version 1.2.0

Release date: 2022/12/30

New features

  • Provide accelerated domain names to enable faster access to Alipay+ APIs. For more information, see Environment.

Enhanced features

    • For Merchant-presented Mode Payment: Added the design requirements and suggestions for the Payment confirmation page, Payment result page, and Transaction Detail page.
    • For User-presented Mode Payment:
      • Added the design requirements and suggestions for the Alipay+ payment code page, Payment result page, and Transaction Detail page.
      • Added optional design standards in terms of country/region list display, QR code and barcode design, screen brightness, and dropdown list design of the Alipay+ QR code entrance.
    • Removed the User Experience Guidelines because the content is merged into product introductions.
  • A new set of design requirements and suggestions for the Transaction Detail Page is added for Cashier Payment and Auto Debit. For more information, see the Page detail requirements of the product introductions for Cashier Payment and Auto Debit.
  • Changed the order.merchant.merchantDisplayName parameter in the pay and userInitiatedPay APIs from Optional to Required.
  • Removed the value OTHER from the osType parameter in the prepare API.
  • Updated the Alipay+ MPP Android SDK as follows:
  • Updated the Alipay+ MPP iOS SDK as follows:

Document improvements

  • Added the Get Started document to guide the MPPs through the integration and acceptance guide. For more information, see Get started with Alipay+ integration.
  • Updated the integration guides of the following payment products:
      • Updated the workflow diagram for making a payment and integration steps.
      • Updated the code identification step to make it clearer and more accurate. Specially:
        • Refined the process flow diagram and its description.
        • Removed the Allowlist solution and Blocklist solution sections, which are deprecated for the Cashier Payment product.
        • Reorganized and improved the How to identify Alipay+ codes chapter.
      • Updated the processing logic of integrating the userInitiatedPay API.
      • In the Bind the user account topic, clarified the integration methods that are available for different terminal types of the MPP client.
      • Updated the workflow diagrams for account binding and unbinding steps.
      • Reorganized the table of contents to make it clearer and easy to find.
      • Removed the topics about providing user information in certain conditions. If you need these topics, contact your Solution Architect.
      • Updated the workflow diagram to better describe the payment workflow.
      • Divided the original Identify the code section into two substeps: Filter the code and Identify the code, to better describe the process.
  • Removed the specification documentation of the inquiryUserInfo and inquiryCustomerId APIs from the Alipay+ Document Center. If you need to implement these APIs to provide user information, contact your Solution Architect.
  • Added an Integration and acceptance chapter to the FAQ.
  • Updated the Reconcile documentation as follows:
    • Added an introduction about Banker's rounding. For more information, see Banker's rounding.
    • Improved the description of the settlementAmountValue parameter and the feeSettlementAmountValue parameter to clarify how they are calculated.

Version 1.1.2

Release date: 2022/10/28

New features

  • Released the documentation that provides guidance for MPPs on how to display Alipay+ brand-related elements on digital user interfaces before, during, and after the payment is processed by Alipay+ Core. For more information, see Brand Display Guidelines for Alipay+ Core MPP Integration.

Document improvements

  • Updated the definition of the following terms: Acquiring Service Provider (ACQP), Mobile Payment Provider (MPP), and Common Business Day. For more information, see Glossary.

Version 1.1.1

Release date: 2022/09/30

New features

  • Added a new domain name ( for Alipay+ APIs. Now there are two domain names for you to select. For more information, see API reference.

Document improvements

  • Updated the product introduction for Auto Debit and Cashier Payment. Now the product introduction includes a new section, Page detail requirements, which replaces the UX design guidelines provided in the User Experience Guidelines. For more information, see Product Introduction for Auto Debit and Cashier Payment.
  • Updated the integration document of the payment products:
    • Improved the Reconcile section in that:
      • Optimized the Overview topic to include information about some basic concepts about reconciliation.
      • Added a topic Perform reconciliation to introduce a step-to-step guide on how to do reconciliations.
      • Updated the samples and the description of the parameters in each financial report.

For more information, see Reconcile.

    • Replaced the Post payment section with two new sections, Return payment results and Cancel or refund a payment for the integration document of Auto Debit, Cashier Payment, User-presented Mode Payment, and Merchant-presented Mode Payment. The new sections explain the related topics in an optimized method.

Version 1.1.0

Release date: 2022/08/31

New features

  • Upgraded the Alipay+ MPP Client SDK. The new SDK features broader applicability, higher security, and faster response, and is well-documented and open-sourced to MPPs who have signed NDAs with Alipay+. For more information, see Alipay+ MPP Client SDK.
    • Accordingly, the following documents are updated:
    • Meanwhile, Alipay+ continues to maintain the older SDK edition. MPPs that have integrated the older SDK edition are not impacted. For more information, see Alipay+ client SDK integration guide.

Enhanced features

The redirection-back from an MPP app to the merchant WAP page for Cashier Payment is now properly supported, so relevant modifications are made. For details, see Guide on redirections between the merchant and the Mobile Payment Partner and Cashier Payment.

Document improvements

  • Added the FAQ documentation for MPPs, containing frequently asked questions about Alipay+ risk management and partner services. For more information, see FAQ.
  • Removed the inquiryRiskScore API from the API Reference documentation and Auto Debit integration guide.
  • Removed the SDK download addresses from the SDK Reference documentation. You can contact your solution architect to obtain SDK packages.
  • Removed the following parameters from the API reference. Note that this change is backward compatible.
    • From the request parameters of the pay API:
      • order.goods.goodsBrand
    • From the response parameters of the pay API:
      • paymentAmount
      • payToAmount
      • order.goods.goodsBrand
      • merchant
      • paymentCurrency
      • Value STORE_CODE of the codeType parameter

Version 1.0.0

Release date: 2022.07.29


Since 2022/07/29, the Alipay+ Document Center has been restructured to provide you with a better user information experience in the following terms:

  • Centralized content reading: You can select the role and the product that you want to explore to enter a dedicated content domain.
  • Better navigation experience: Horizontal tab navigation plus vertical navigation allows you to find the information more easily and quickly; the aggregated overview page for each tab guides you through the important content that Alipay+ provides to you; quick entry provided for you to arrive at the API and SDK reference in one step.
  • Public technical content information: Since this version, most of the documentation on the Alipay+ Documentation Center has been disclosed to all users except for the following three books:
    • Rules
    • Operation guides
    • Alipay+ Partner Workspace User Guide
  • Standardized version control: Alipay+ supports you in switching the version as you require.
  • Optimized content structure: The content structure of the integration guides is restructured to allow you to find the product introduction, and the content about reconciliation more conveniently. In addition, the product introduction and the integration guides for the Online Payment are also refined to improve the content quality.
  • Useful support information: Find the support information at the footer if you need any help with technical issues or business operations.

Other document improvements

  • Removed the registration and notifyRegistrationStatus APIs from the API Reference (MPP) documentation. If you need to implement the merchant registration capability, contact your Solution Architect.

History for previous updates

Note: Starting from 2022/07/29, the Alipay+ documentation is restructured to support version control. The following list describes important updates to our documentation before this date.

July 15 2022

New features

Released new features to support MPPs in adopting two modes for merchant registration: Reporting Mode and Approval Mode. This leads to the following document updates:

    • Added the REGISTRATION_In_PROCESS result code and the description about when to use it in the More information section.
    • Updated the result message for the SUCCESS result code.

Enhanced features

Changed the merchantInfo.registrationDetail.registrationNo parameter in the registration API from Required to Optional to satisfy the needs of individual merchant registration.

June 30 2022

New features

Released the non-client-SDK integration solution for the Cashier Payment, Auto Debit, and Merchant-presented Mode Payment products. For more information, see the following documents:

Enhanced features

Updated the logic of calculating the following amounts: paymentAmount, payToAmount, and surchargeAmount. For more information, see pay.

Document improvements

  • Updated the API reference documentation, to make it more accurate and clear. This includes:
    • Added more detailed descriptions. For example, for optional request parameters, added conditions when these parameters are specified by Alipay+; for optional response parameters, added conditions when these parameters are required to be returned by the MPP.
    • Refined the Result processing logic section for APIs that are invoked by the MPP.
    • Added the How to return the result section for APIs that are invoked by Alipay+.
    • Adjusted the sequence of some parameters based on their relevance.
    • Fixed several errors in the sample codes.
    • Fixed some grammatical errors to improve readability.

For more information, see API Reference (MPP).

  • Updated the Result codes table as follows:
    • Added the NO_INTERFACE_DEF result code for all APIs.
    • Added the ORDER_IS_CLOSED result code for the userInitiatedPay API.
    • Added the REPEAT_REQ_INCONSISTENT result code for the refund and prepare APIs.
    • Deleted the INVALID_API result code for all APIs.
    • Deleted the REPEAT_REQ_INCONSISTENT result code for the registration API.
    • Deleted the INVALID_CONTRACT result code for the responseRetrieval API.
  • Updated the Payment result codes table for the notifyPayment and inquiryPayment APIs as follows:
    • Added the following payment result codes:
  • Deleted the following 21 response parameters in the registration API while maintaining backward compatibility:
    • merchantInfo.registrationDetail.attachments.attachmentType
    • merchantInfo.registrationDetail.attachments.file
    • merchantInfo.registrationDetail.attachments.attachmentName
    • merchantInfo.registrationDetail.attachments.content
    • merchantInfo.registrationDetail.attachments.contentType
    • merchantInfo.registrationDetail.contactInfo.contactNo
    • merchantInfo.registrationDetail.contactInfo.contactType
    • merchantInfo.registrationDetail.registrationEffectiveDate
    • merchantInfo.registrationDetail.registrationExpireDate
    • merchantInfo.merchantAddress.state
    • merchantInfo.merchantAddress.address1
    • merchantInfo.merchantAddress.address2
    • merchantInfo.merchantAddress.zipCode
    • merchantInfo.logo.logoName
    • merchantInfo.logo.logoUrl
    • storeInfo.storeContacts.fullName
    • storeInfo.storeContacts.identificationId
    • storeInfo.storeContacts.contactNo
    • storeInfo.feeTier
  • Released the documentation for Alipay+ Center that contains an introduction and integration solutions for MPPs. For more information, see Alipay+ Center.
  • Updated the brand display guidelines. This includes the following documents:
  • Changed a condition of cancelling the payment in all the integration documents for MPPs. For more information, see Cancel the transaction section in each integration guide for MPPs.

May 27 2022

Enhanced features

Added an entry to download the Alipay+ logo asset in Alipay+ foundational brand guidelines and UX design guidelines for Mobile Payment Partners.

Document improvements

  • Deleted the scopes parameter from the idempotency fields table as it can not be used to control the idempotency for the prepare API.

April 29 2022

Document improvements

  • Changed the accuracy of the Request-Time and Response-Time header fields from milliseconds to seconds.
  • Added the retry mechanism of the inquiryPayment, cancelPayment, and refund APIs in the integration guides.
  • Changed the refund time window from 365 days to 366 days.
  • Updated the values of the scopes parameter in the prepare API.

March 31 2022

New features

Open sourced the Alipay+ Server SDK to MPPs who have signed NDAs with Alipay+.

Added a glossary of terms that are used in Alipay+ for your convenience. For more information, see Glossary.

Fixed bugs

Fixed the spelling of the following parameters in the Transaction Detail Report and Fee Report:

  • Updated orignalTransactionRequestId to originalTransactionRequestId.
  • Updated feeSettleAmountValue to feeSettlementAmountValue.