API list

This topic lists all the interfaces that are used in Auto Debit.

APIs for integration with client SDK

This section introduces the interfaces that are used in integration with the Alipay+ client SDK.

The following table lists the APIs that are used in the integration process.

Interface name	Endpoint	Direction
pay	/aps/api/v1/payments/pay	Alipay+ -> Mobile Payment Partner
inquiryPayment	/aps/api/v1/payments/inquiryPayment
refund	/aps/api/v1/payments/refund
cancelPayment	/aps/api/v1/payments/cancelPayment
applyToken	/aps/api/v1/authorizations/applyToken
cancelToken	/aps/api/v1/authorizations/cancelToken
prepare	/aps/api/v1/authorizations/prepare
inquiryUserInfo	/aps/api/v1/authorizations/inquiryUserInfo
inquiryCustomerId	/aps/api/v1/users/inquiryCustomerId
sendOTP	/aps/api/v1/users/sendOTP
verifyOTP	/aps/api/v1/users/verifyOTP
inquiryRiskScore	/aps/api/risks/inquiryRiskScore
notifyPayment	/aps/api/v1/payments/notifyPayment	Mobile Payment Partner -> Alipay+
consultUnbinding	/aps/api/v1/authorizations/consultUnbinding
authNotify	/aps/api/v1/authorizations/authNotify

The following table lists the Alipay+ client SDK interfaces that are used in the integration process.

Interface	Description	Direction
init/initWithContext	Initialize SDK	Mobile Payment Partner app -> Alipay+ client SDK
clear	Clear user payment code in local cache and auth state
signContract	Call SDK to sign contract
getAuthCode	Obtain authorization code	Alipay+ client SDK -> Mobile Payment Partner app
showAuthPage	Show Mobile Payment Partner authorization page	Alipay+ client SDK -> Mobile Payment Partner app

Note:

showAuthPage is only mandatory when Alipay+ assembles the authUrl.

This section introduces the interfaces that are used in integration without the Alipay+ client SDK.

The following table lists the APIs that are used in the integration process.

Interface name	Endpoint	Direction
pay	/aps/api/v1/payments/pay	Alipay+ -> Mobile Payment Partner
inquiryPayment	/aps/api/v1/payments/inquiryPayment
refund	/aps/api/v1/payments/refund
cancelPayment	/aps/api/v1/payments/cancelPayment
applyToken	/aps/api/v1/authorizations/applyToken
cancelToken	/aps/api/v1/authorizations/cancelToken
prepare	/aps/api/v1/authorizations/prepare
inquiryUserInfo	/aps/api/v1/authorizations/inquiryUserInfo
inquiryCustomerId	/aps/api/v1/users/inquiryCustomerId
sendOTP	/aps/api/v1/users/sendOTP
verifyOTP	/aps/api/v1/users/verifyOTP
inquiryRiskScore	/aps/api/risks/inquiryRiskScore
notifyPayment	/aps/api/v1/payments/notifyPayment	Mobile Payment Partner -> Alipay+
consultUnbinding	/aps/api/v1/authorizations/consultUnbinding
authNotify	/aps/api/v1/authorizations/authNotify