WeChat Pay

Learn how to accept WeChat Pay payments.

As China’s largest internet company, Tencent offers a number of web and mobile products across social networking, communications, media, games, finance, and more. WeChat, owned by Tencent, is China’s leading mobile app with over 1 billion monthly active users.

WeChat is a leading lifestyle ‘super app’ used for messaging between people, as well as connecting people, services, and businesses in China and around the world through a number of e-commerce and social features inside the app. WeChat Pay, the payment wallet inside the WeChat app, has over 800 million users.

Payment typeWallet
Processing currenciesEUR, USD, GBP

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
<- Response (direct, synchronous) 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:

merchantid40 charactersMerchant identification number assigned during account creation
orderidmax. 30 charactersThe field orderid is optional and exclusively for the merchants' convenience
amountdigits 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
currency3 characters. ISO 4217The currency field contains the alpha-3 currency code for the transaction. Links to ISO
payment_method5payabl. Payment methods IDs
signature40 charactersSignature Calculation2
custom2wechatpayThe name of payment method
accountname3-100 charactersCustomer account name
emailmax. 50 charactersCustomer email. An RFC 822 compliant email address
firstnamemax. 50 charactersFirst name of the customer
lastnamemax. 50 charactersLast name of the customer
url_returnmax. 255 characters starting with http or httpsURL for customer redirection

You can see a full list of parameters in Pre-Authorization .

Request example:

[email protected]&firstname=John&lastname=Doe&zip=853012&street=Baoshan Road&house=227&city=Shanghai&accountname=John Doe&


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 correct URL in the response.

Response example:


Response fields reference:

transactionidpayabl. internal transaction id. Please use this transaction id when referring to the transaction in communications with the payabl. team
transidThe same as transactionid
statusTransaction error code
errormessageBrief explanation of transaction decline reason (empty on success)
errmsgThe same as errormessage
amountTransaction amount
priceThe same as amount
currencyTransaction currency
orderidOptional transaction identifier given by the merchant
ppro_idPayment system's transaction id
fail_reasonPayment system's explanation of fail reason
redirect_secretSignature for redirection to the payment system's iframe (no actions needed)
redirect_urlURL for customer redirection to finalize the payment (URL encoded)
payment_guaranteePayment system technical field
user_idPayment 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 connected through PPRO 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, notification signature (HASH) for PPRO is calculated in the same way as signature for requests.

Notification example:


Notification fields reference:

TAGpayment method identifier
PAYMENTGUARANTEEPayment system technical field
REQUESTSTATUSRequest status (technical field)
STATUSTransaction status (SUCCEEDED for success)
ERRMSGBrief explanation of transaction decline reason (empty on success)
TXIDpayabl. order ID - optional transaction identifier given by the merchant
HASHSignature 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 notifciation_url to be used by default to payabl. technical team. By doing so, you won't need to send it in every request.


WeChat Pay 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.