Overview

2023-09-21 09:50

Auto debit enables the online automatic deduction feature on your websites or applications and supports deployment on multiple client types (Web, WAP, App). A one-time authorization enables you to conduct future payments with one click. You only need to integrate once to enjoy multiple payment methods, such as e-wallets and bank transfers. The excellent seamless payment experience reduces customer loss caused by deduction failures. Accepting multiple payment methods also helps you grow and expand your business.

Capabilities

Authorization

Payment

After the payment

Obtain the authorization:

Enable available payment methods: Sign the contract to support desired payment methods.
Obtain the authorization: Obtain the URL that is used to render the authorization page using the consult API, and display the payment method authorization page to the buyer. We recommend that you dynamically render the supported payment methods on the payment method authorization page based on the buyer's region.
Obtain the authorization result: If you have configured the address to receive authorization result notifications, you will receive an authorization success notification from Alipay+ after the buyer's authorization is obtained.
Obtain a payment token: After the buyer agrees to authorize the Auto Debit service for the payment method, you can obtain the payment token through the applyToken API. Furthermore, you can update the payment token through the applyToken API when the payment token is about to expire.

Cancel the authorization:

If the buyer cancels the authorization within your client, you need to invalidate the payment token for the payment method through the revoke API.
If the buyer cancels the authorization within the payment method client, you will receive an authorization cancellation notification.

Integration

APIs and notifications

To integrate the Auto Debit service, see Obtain authorization to obtain a buyers' authorization, and see Pay to initiate a payment after you have obtained the buyer's authorization.
For information about the operations after the payment, see Refund, Cancel, and Notifications.
The following table lists all the APIs, notifications, and reports for Auto Debit, serving the purpose of facilitating the payment and after-the-payment processes:

Capabilities	Development resources
Capabilities	Server APIs	Server Notifications/Reports
Obtain authorization	consult	notifyAuthorization
Revoke authorization	revoke	notifyAuthorization
Apply for a payment token	applyToken
Initiate a payment	pay (Auto Debit) inquiryPayment	inquiryPayment
Cancel a payment	cancel
Refund a payment	refund inquiryRefund	notifyRefund
Declare goods	declare inquiryDeclarationRequests
Settle and reconcile		Transaction details Settlement details Settlement summary

Table 1. APIs and notifications used for Auto Debit

SDKs

In addition to API integration via customized coding, you can also integrate via Alipay+ SDKs. The Alipay+ SDKs provide a standardized way to help merchants build software applications faster. You only need to integrate once at minimal development costs to enable current and future available payment methods.

Server SDK

Currently, SDKs for Java, Python, and PHP are provided with varying scopes:

Java SDK: Supports all the same functions as the API solution.
Python, PHP, and .Net SDKs: Support only part of the functions that the API solution provides. The following table shows the functions that Python, PHP, and .Net SDKs currently support:

Function	Java SDK	Python SDK	PHP SDK	.Net SDK
pay	✅	✅	✅	✅
inquiryPayment	✅	✅	✅	✅
cancel	✅	✅	✅	✅
refund	✅	✅	✅	✅
inquiryRefund	✅
declare	✅
inquiryDeclarationRequests	✅

Table 2. Supported SDK integration for each function

Supported payment methods

Auto Debit supports the following payment methods:

Payment method type	Payment method	Customer region
Alipay+ payment method	Alipay	China
Alipay+ payment method	AlipayHK	Hongkong, China
Alipay+ payment method	Boost	Malaysia
Alipay+ payment method	DANA	Indonesia
Alipay+ payment method	GCash	Philippines
Alipay+ payment method	KakaoPay	South Korea
Alipay+ payment method	NAVER Pay	South Korea
Alipay+ payment method	Rabbit LINE Pay	Thailand
Alipay+ payment method	Touch'n Go	Malaysia
Alipay+ payment method	TrueMoney	Thailand
Alipay+ payment method	Zalopay	Vietnam
Bank Direct Debit	KrungThai Bank	Thailand
Bank Direct Debit	Siam Commercial Bank	Thailand
Wallet	GrabPay	Malaysia, Singapore, Indonesia
Wallet	Maya	Philippines
Wallet	PayPay	Japan

Table 3. Supported payment methods