Alipay+ DocsAlipay+ Docs

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

inquiryPayment

/v1/payments/inquiryPayment

Alipay+->MPP

refund

/v1/payments/refund

cancelPayment

/v1/payments/cancelPayment

applyToken

/v1/authorizations/applyToken

userInitiatedPay

/v1/payments/userInitiatedPay

MPP->Alipay+

notifyPayment

/v1/payments/notifyPayment

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: getCurrentRegion

iOS: getCurrentRegion

Used to get the user's current location.

Android: isAlipayPlusSupportedRegion

iOS: isAlipayPlusSupportedRegion

Used to check whether the user is in Alipay+ supported region.

Android: getAcceptanceMarkLogos

iOS: getAcceptanceMarkLogos

Used to obtain the logos of acceptance marks that are supported by Alipay+ in the specific region.

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

ailpayconnect.code.CodeIdentificationService.identifyCode

Used to identify whether the code can be processed by Alipay+.

MPP server -> Alipay+ server SDK

ailpayconnect.code.CodeIdentificationService.init

Used to initialize the Alipay+ server SDK.