Checkout Payment helps you develop acquiring capability on your websites or in your apps. It allows you to receive online payments made via various clients including desktop websites, mobile websites, and mobile applications. You only need to cost a one-time integration effort to add multiple payment methods such as wallet payment methods, bank transfer payment methods, and card payment methods to your pages. And users can pay securely and easily by using their preferred payment methods, thus delivering an incredible payment experience.
The general integration procedure that applies to all Alipay products consists of the following phases. For more details about configurations for each phase, see Integration guide.
Figure 1. Integration procedure
The following table lists all the APIs used for Checkout Payment and their corresponding endpoints. You can click the API link to view the details of each API.
Obtain available payment methods: consult
Initiate a payment request: pay
Create a payment session: createPaymentSession
Request to capture an authorized payment: capture
Inquire about a payment status: inquiryPayment
Cancel a payment: cancel
Refund a payment: refund
Inquire about a refund status: inquiryRefund
Declare goods: declare
Inquire about a declaration status: inquiryDeclarationRequests
Table 1. APIs used for Checkout Payment
The notifications used for Checkout Payment are listed as follows. Alipay sends asynchronous notifications using these interfaces:
- Notification of the payment result: notifyPayment
- Notifications of the refund result: notifyRefund
- Notifications of the capture result: notifyCapture
- Notifications about the chargeback: notifyDispute
In addition to API integration through custom coding, you can also integrate client and server SDKs provided by Alipay. You can use the following client SDKs to integrate card payment methods and authorization payments:
Note: You can download the SDK package in Alipay Developer Center.
The server SDK provides a standardized way to help you build software applications faster. SDKs for Java, Python, and PHP are provided with varying scopes:
- Java SDK: Supports all the same functionalities as the API solution.
- Python, PHP, and .Net SDKs: Supports only part of the functionalities that the API solution provides. The following table shows the functionalities that Python, PHP, and .Net SDKs currently support:
Table 2. Supported SDK integration for each functionality