Alipay

Alipay is the most widely used third-party online payment service provider in China. This makes Alipay one of the key payment methods that you should offer if you want to expand your business to reach Chinese customers both at home and abroad. Customers can use Alipay to pay through your website or mobile app.

Alipay wallet holders can pay on the web or on mobile using their login credentials or their Alipay app. Funds are drawn from the customer’s bank, card, or prepaid Alipay account and because payments are authenticated with the customer’s login credentials, dispute rates are very low.


Payment type	Wallet
Markets	China
Processing currencies	AUD, CAD, EUR, GBP, HKD, SGD, USD
Refunds	Yes

General flow

POST Request -> to /payment_preauthorize
<- Response (direct, synchronous) with status=0&errormessage=pending and redirect_url
Customer is redirected to redirect_url to complete payment
<- HTML response with status=0 (or decline) to return_url
<- Callback (asynchronous) with errorcode=0 to notification_url

Step 1. Make a transaction request

From your server, make a POST /payment_preauthorize request.

POST https://sandbox.payabl.com/pay/backoffice/payment_preauthorize

Include in request:

Parameter	Format	Description
`merchantid`	40 characters	Merchant identification number assigned during account creation
`orderid`	max. 40 characters	The field orderid is optional and exclusively for the merchants' convenience
`amount`	digits only, either no decimals or two decimal places (e.g. 8 or 8.50)	Transaction’s total amount that will be deducted from the customer
`currency`	3 characters. ISO 4217	The currency field contains the alpha-3 currency code for the transaction. Links to ISO
`payment_method`	`5`	payabl. Payment methods IDs
`signature`	40 characters	Signature Calculation
`bankcountry`	2 characters. ISO 3166-1	Customer country. Supported countries: CN
`custom2`	`alipay`	The name of payment method
`accountname`	3-100 characters	Customer account name
`email`	max. 50 characters	Customer email. An RFC 822 compliant email address
`firstname`	max. 50 characters	First name of the customer
`lastname`	max. 50 characters	Last name of the customer
`mobileview`	`yes`	Optional parameter
`url_success`	max. 255 characters starting with http or https	URL for customer redirection to success page
`url_failed`	max. 255 characters starting with http or https	URL for customer redirection to failed page

Request example:

merchantid=gateway_test&orderid=Payabl-Test&amount=299&currency=HKD&payment_method=5&language=en&customerip=2.22.75.244&
[email protected]&firstname=John&lastname=Doe&zip=853012&street=Baoshan Road&house=227&city=Shanghai&accountname=John Doe&
bankcountry=CN&custom2=alipay&url_return=https://yourshop.example/thank_you&notification_url=https://yourshop.example/notification&
signature=a5a13e0254f19354df2d9fe715a9a81be1b92400

🚧
Public Sandbox information
Do not use your personal email address, Order ID with sensitive information, real customer details and credit card data in the public Sandbox. For email field you may use [email protected].

📘
Redirection to url_return does not confirm that the transaction is successful. Always check the transaction via notification_url or use the diagnose interface to get the final status of the transaction.

Step 2. Handle the redirect

To complete the payment, you need to redirect the customer to the URL provided in the response.

Response example:

transactionid=105145945&transid=105145945&status=0&errormessage=pending&errmsg=pending&amount=299&price=299&
currency=HKD&orderid=Payabl-Test&ppro_id=2068500327&fail_reason=&redirect_secret=Ut1M79mAzsjgmfyONDHSN1yugdKkjqdW&
redirect_url=https%3A%2F%2Fr2.girogate.de%2Falipay%2FS1160%2FI%3Ftx%3D2068500327%26rs%3DU1LSktKONeTjLcegAME2YQg0roNFdtsK%26cs%3D
84542c8199fd1e3568ef0ff10762d85bec82a4a854148680244bceab9358d09c&payment_guarantee=&user_id=704535

Response fields reference:

Parameter	Description
`transactionid`	payabl. internal transaction id. Please use this transaction id when referring to the transaction in communications with the payabl. team
`transid`	The same as `transactionid`
`status`	Transaction error code
`errormessage`	Brief explanation of transaction decline reason (empty on success)
`errmsg`	The same as `errormessage`
`amount`	Transaction amount
`price`	The same as `amount`
`currency`	Transaction currency
`orderid`	Optional transaction identifier given by the merchant
`ppro_id`	Payment system's transaction id
`fail_reason`	Payment system's explanation of fail reason
`redirect_secret`	Signature for redirection to the payment system's iframe (no actions needed)
`redirect_url`	URL for customer redirection to finalize the payment (URL encoded)
`payment_guarantee`	Payment system technical field
`user_id`	Payment system user identifier

Step 3. Receive the final status

Once the customer completes the payment, we will send a notification with the transaction's final status to the notification_url specified by you.

🚧
Payment methods that are accessible under ID 5 have a callback structure different from other payment methods. Please note that payabl. transaction ID is not passed in them, so you will need to identify the transaction in question by the Order ID (which is passed in the TXID field).
Also, the notification signature for these payment methods is calculated differently from other payment methods. Please see the calculation steps below:

Sort all notification parameters values by parameter name in alphabetical order.

Append your secret to the end of the concatenated string.

Calculate a SHA-1 hex value of the string.

Notification example:

TAG=alipay&TXID=Payabl-Test&PAYMENTGUARANTEE=NONE&REQUESTSTATUS=SUCCEEDED&HASH=6cd85153b44a3c91ca220a46553c525fcfefc0a2&
STATUS=SUCCEEDED&ERRMSG=

Notification fields reference:

Parameter	Description
`TAG`	Payment method identifier
`PAYMENTGUARANTEE`	Payment system technical field
`REQUESTSTATUS`	Request status (technical field)
`STATUS`	Transaction status (`SUCCEEDED` for success)
`ERRMSG`	Brief explanation of transaction decline reason (empty on success)
`TXID`	payabl. order ID - optional transaction identifier given by the merchant
`HASH`	Signature to verify the authenticity of the notification. You can find more information here

📘
url_return and notification_url should be passed by you in the Pre-authorization request.
Alternatively, you can communicate a notification_url to be used by default to payabl. technical team. By doing so, you won't need to send it in every request.

Refunds

Alipay supports refunds which can be initiated only on a successful captured transaction.
The request will send a credit note to the authorization system after the customer has already been charged. The refund amount will be credited to the customer and the merchant’s account will be charged.

The refund can be done in two ways:

Through API integration
Through payabl. dashboard

If you have API integration, you can check more in our documentation Refund.

Our Technical Support team is there to help you:
Email: [email protected]
Available Monday – Friday between 09:00 and 17:00 CET/CEST

General flow

Step 1. Make a transaction request

🚧Public Sandbox information

📘

Step 2. Handle the redirect

Step 3. Receive the final status

🚧

📘

Refunds

🚧
Public Sandbox information