Alipay, China's leading third-party online payment solutionAlipay, China's leading third-party online payment solution

Overview

中文版

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 digital 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

  • 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 Antom 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

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

Server APIsServer Notifications/Reports

Obtain authorization

consult

notifyAuthorization

Revoke authorization

revoke

notifyAuthorization

Apply for a payment token

applyToken

Initiate a payment

pay (Auto Debit)

inquiryPayment

notifyPayment

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

Supported payment methods

Regarding to payment methods supported by Auto Debit, refer to Availability for more information.