Alipay+ DocsAlipay+ Docs

Migration guide from AMS to Alipay+

This guide is designed to help you facilitate the Cashier Payment migration from AMS (Alipay Merchant Service) to Alipay+. It lists the differences/enhancements and provides related information for you to learn more and take quick action.

Overview

Versus AMS Cashier Payment, the user experience of Alipay+ Cashier Payment is enhanced and more features are provided.

User experience

By using Alipay+ Cashier Payment, consumers' checkout experience is mostly the same as the one provided by AMS Cashier Payment except that a new mode called merchant QR code page mode is supported when the user places an order on a merchant PC website. In this mode, after the user chooses the payment method, a QR code is directly displayed for the user to scan to pay. The QR code is rendered by the merchant with the code value that is returned from Alipay+. The merchant must follow the Alipay+ UX design guideline to display the QR code.

Note: the merchant QR code page mode can only be used when the wallet supports code-scanning payment. For more information about the Alipay+ Cashier Payment user experience, see Overview.

New features

Versus AMS Cashier Payment, Alipay+ Cashier Payment provides more features as below:

Merchant Registration

Alipay+ provides the following interfaces for the Acquiring Partner (ACQP) to register merchant information:

  • registration: used to register merchant information or update an existing registration.
  • inquiryRegistrationStatus: used to query the registration status.
  • notifyRegistrationStatus: used to send the merchant registration result to the ACQP.

With these interfaces, the ACQP can save the operation effort of manual offline application. The interfaces are compatible with the AlipayCN wallets.

For more information, see Merchant registration.

consultPayment Method

Alipay+ adds a consultPayment interface for the ACQP (on behalf of the merchant) to retrieve the information of the available payment methods based on the conditions such as user region, payment scenario, currency, and so on. The information includes the logo and name of the wallets that are supported by Alipay+.

The ACQP then returns the payment method list to the merchant, and the merchant displays the list on the checkout page for the consumer to choose.

With this interface, the ACQP can save the effort of manual offline operation when the merchant cashier needs to be configured for the wallet change.

For more information about how to integrate and use the consultPayment interface, see Render the payment method page and consultPayment.

Integration

The following figure illustrates the Alipay+ Cashier Payment workflow, including accept payments and post payments processes.

image.png

Figure 1. Alipay+ Cashier Payment Workflow

Accept payment

Versus AMS cashier payment, to enable the user to complete the payment, the ACQP needs to first integrate the consultPayment interface to render the payment method page before integrating the pay interface.

For more information about how to integrate and use the consultPayment interface, see Render the payment method page and consultPayment.

In addition, you need to integrate the registration-related interfaces to support merchant registration. For more information, see Merchant registration.

Post payment

Different from AMS Cashier Payment, when the order expires, the ACQP needs to initiate the cancelPayment API request to cancel the transaction.

API references

Versus AMS Cashier Payment, the Alipay+ Cashier Payments APIs are different in the following terms:

New APIs added

The following APIs are newly added:

Interface name

is_required

Endpoint

consultPayment

Required

/aps/api/v1/payments/consultPayment

registration

Required

/aps/api/v1/merchants/registration

inquiryRegistrationStatus

Required

/aps/api/v1/merchants/inquiryRegistrationStatus

notifyRegistrationStatus

Optional

/aps/api/v1/merchants/notifyRegistrationStatus

Existing APIs updated

The following APIs are updated in terms of their request and response parameters:

Interface name

is_required

Endpoint

pay

Required

/aps/api/v1/payments/pay

inquiryPayment

Required

/aps/api/v1/payments/inquiryPayment

notifyPayment

Required

/aps/api/v1/payments/notifyPayment

cancelPayment

Required

/aps/api/v1/payments/cancelPayment

refund

Required

/aps/api/v1/payments/refund

Check the following excel file to find the detailed changes for each API and the actions that you are recommended to take.

Note:

  • To help you quickly identify the differences, different colors are used to highlight the differences between Alipay+ and AMS APIs:
    • Light green: indicates that the necessity of the parameter changes.
    • Light orange: indicates a new parameter that is only for Alipay+.
    • Light yellow: indicates that the parameter is only for AMS.
    • Red: indicates that the parameter in Alipay+ plays the same role as the parameter in AMS though the name/data structure is different.

Reconciliation

As the business model is upgraded for Alipay+, the reconciliation function is different from AMS in the following terms:

  • The settlement cycle and the settlement report generation time are changed to T+2 from T+4.
  • Settlement files are generated per the settlement currency, and Alipay+ also settles the amount to the ACQP per the settlement currency.
  • Settlement files are thoroughly upgraded in terms of the file name, file format, and file directory. Currently, the reports contain three clearing reports, and one settlement report.

For more information about these financial reports, see the Reconciliation chapter.

Development

Alipay+ provides a new Developer Center called Alipay+ Developer Center to help you facilitate application development and integration. You need to create a set of applications, get new client IDs, and set new public keys in the new developer center.

As Alipay+ set higher requirements for integration quality, the amount and coverage of test cases increases.

For more information about the Alipay+ Developer Center, see Alipay+ Developer Center User Guide.