- This integration guide is dedicated for the Unified Payment edition of Cashier Payment. To check the integration guide for Cashier Payment tile and bundle mode, go to Older Edition.
- This integration guide introduces SDK and CDN-based methods for consulting Alipay+ payment method information. For how to consult Alipay+ payment method information by using the consultPayment API, see consultPayment integration.
This topic introduces the functions that Alipay+ Cashier Payment provides and guides you through how to use the Alipay+ APIs and SDKs to build an integration for these functions.
Before you begin
Before you learn more about how to integrate with Alipay+ Cashier Payment, ensure that you are familiar with the following things:
- The user experience that Alipay+ Cashier Payment can provide to the consumers. For more information, see Product introduction.
- General steps that you need to take to go through the whole integration process. For more information, see Get started with Alipay+ integration.
Build an integration
Use the APIs and SDKs that are provided by Alipay+ to integrate the following Cashier Payment functions as required:
Accept a payment
To accept payments from users, you need to take the following steps:
- Render the payment method page with the information that is consulted from Alipay+.
The information mainly includes the logo and promotion information. You can consult the information by using the Alipay+ SDK or calling the Alipay+ CDN server according to your application scenario.
- Initiate a payment request by calling the pay API, and open the Alipay+ checkout page for the user to pay.
Depending on whether your merchant platform is an app, different integration options are provided:
- If the merchant platform is an app, it is recommended to use the Alipay+ SDK to facilitate your integration.
- If the merchant platform does not have an app or does not want to integrate an SDK, you can develop programming code with the payment URL.
- Handle the payment result that is obtained from Alipay+.
For more information about how to integrate related APIs or SDKs to accept a payment, see Accept a payment.
Obtain payment results
To obtain payment results from Alipay+, you need to integrate the inquirePayment and notifyPayment APIs. For more information about how to integrate the APIs, see Inquire about payment results and Receive payment notification.
Cancel and refund
To support the users in refunding and canceling payments, you need to integrate the refund and cancelPayment APIs. For more information about how to integrate the APIs, see Cancel a payment and Refund.
Apart from the payment-oriented functions that are mentioned above, Alipay+ provides more services and APIs for you to manage your business.
Alipay+ provides multiple types of transaction reports to help you to perform the clearing and settlement of transactions. To streamline your business workflows, you need to develop your reconciliation function module according to the production mechanism and specification of the transaction reports. For more information, see Reconcile.
Register a merchant
In certain countries or regions, for legal or compliance reasons, you need to register the merchant information before processing a payment. For more information about how to integrate related APIs for merchant registration, see Registration.
Handle a dispute
To enable Acquiring Partners (ACQPs) to resolve disputes after transactions occur, Alipay+ provides services and APIs for responding to disputes which are initiated by Mobile Payment Partners (MPPs). For more information about how to handle a dispute, see Disputes.
Declare to customs
For payments that are processed by the AlipayCN wallet, customs declarations are required. In light of this, Alipay+ provides APIs for customs declaration. For more information about how to use these APIs, see Customs.
Go through the section below to obtain more information that empowers your integration:
- To ensure your integration with Alipay+ can work properly, you also need to ensure your merchant meets the requirements in terms of Alipay+ brand and integration. For more information about the requirements, see Requirements for merchants.
- When using APIs to integrate, you need to take the following things into consideration:
- Make a POST request to the corresponding address with the identity information, signature, and business parameters in the HTTP request. For more information about the structure of a request and response, see API overview.
- To ensure the message transmission security, the ACQP must perform message signing and signature validation properly. When calling an Alipay+ API, the ACQP must sign the API request and validate the response signature accordingly; when receiving an API call from Alipay+, the ACQP must validate the request signature and sign the API response accordingly. For more information, see Sign a request and validate the signature.
- For the full list of APIs and SDKs that are provided for Cashier Payment, see APIs and SDKs.