APIs and SDKs
This topic lists all the APIs that are used for Merchant-presented Mode Payment.
APIs
The following table lists the APIs that are used in the integration process.
Name | Endpoint | Direction |
/v1/payments/inquiryPayment | Alipay+->MPP | |
/v1/payments/refund | ||
/v1/payments/cancelPayment | ||
/v1/authorizations/applyToken | ||
/v1/payments/userInitiatedPay | MPP->Alipay+ | |
/v1/payments/notifyPayment | ||
(optional) inquiryCodeRules | /v1/payments/inquiryCodeRules |
Note: The inquiryCodeRules API is only used if the MPP uses Alipay+ code rules locally for code identification. For more information, see Use the Alipay+ code rules locally.
Client SDK APIs
The following table lists the Alipay+ client SDK APIs that are used in the integration process.
Name | Description | Direction |
Android: setConfiguration iOS: setConfiguration | Used to set the initialization parameters. | MPP app -> Alipay+client SDK |
Android: launch iOS: launch | Used to start the payment process for the entry code. | |
Android: getAuthCode iOS: getAuthCode | Used to obtain the authorization code. | Alipay+ client SDK -> MPP app |
Android: decode iOS: decode | Used to send the decoding request to the MPP. |
Note: To process payment requests from Acquiring Service Providers that operate in mainland China, the MPP also needs to integrate the getAuthCode SDK API and applyToken API.
Server SDK APIs
The following table lists the Alipay+ server SDK APIs that are used in the integration process.
Name | Description | Direction |
Used to identify whether the code can be processed by Alipay+. | MPP server -> Alipay+ server SDK | |
Used to initialize the Alipay+ server SDK. |