Overview
Introduction
WeChat is a payment method which allows to process payments in different currencies by using e-wallets in China. This method supports purchases and refunds.
This article provides information about working with the WeChat method: general insights are presented in the Overview section, while information about the actions required to process payments and perform other actions is presented in the sections that follow.
General information
Payment method type | digital wallet payments |
---|---|
Payment instruments | digital wallets |
Countries and regions | CN |
Payment currencies | CNY, EUR, HKD, JPY, SGD, THB, USD * |
Currency conversion | On ecommpay side |
One-time purchases | + |
Credential-on-file purchases | – |
Full refunds | + |
Partial refunds | + |
Payouts | – |
Chargebacks | – |
Notes |
|
Onboarding and access fee | refer to your ecommpay key account manager, additional information available in the ecommpay shop |
Interaction diagram
Payment processing by using the WeChat method involves the merchant's web service, one of ecommpay interfaces, the ecommpay payment platform, and technical facilities of the WeChat service.
Operations support
Various platform interfaces can be used to process payments and perform operations using the WeChat method. Purchases can be processed by using Payment Page, Gate and Dashboard (using payment links), refunds—by using Gate and Dashboard.
Processing scenarios
To perform a purchase by using the WeChat method, you need to redirect the customer to the WeChat service, while to make a refund, you need to receive a request from the customer and notify the customer about the result of the refund via the web service.
Purchases by using Payment Page
General information
To process a purchase through Payment Page by using the WeChat method, the merchant's web service is required to send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of purchase processing are provided below.
- A customer initiates a purchase in the web service.
- The web service sends the request for opening Payment Page to the specified ecommpay URL.
- The request for opening Payment Page is sent to the payment platform.
- The payment platform receives the request and validates the required parameters and signature.
- Payment Page is generated based on the project and request parameters.
- Payment Page is displayed to the customer.
- The customer selects the WeChat method.
- The payment platform receives the request for processing the payment by using the WeChat method.
- The payment platform processes the request and sends it to the WeChat service.
- The request is processed on the WeChat service side.
- The data for redirecting the customer to the WeChat service is sent from the WeChat service to the payment platform.
- The data for redirecting the customer is sent from the payment platform to Payment Page.
- The customer is redirected to the WeChat service.
- The customer completes all required payment steps.
- The purchase is processed in the WeChat service.
- The result information is displayed to the customer in the WeChat service.
- The customer is redirected to Payment Page.
- The WeChat service sends a notification about the result to the payment platform.
- The payment platform sends the payment result callback to the web service.
- The payment platform sends the result information to Payment Page.
- The result information is displayed to the customer on Payment Page.
Information about the formats of requests and callbacks used for processing payments by using the WeChat method via Payment Page is presented further in this section; general information about working with the Payment Page API is presented in Interaction concepts.
Request format
There are several things you need to consider when sending purchase requests by using the WeChat method:
- The following parameters required for any payment must be specified:
project_id
—project identifier obtained from ecommpay during integrationpayment_id
—payment identifier unique within the projectpayment_currency
—payment currency code in the ISO-4217 alpha-3 formatpayment_amount
—payment amount in the smallest currency unitcustomer_id
—customer identifier unique within the project
- The following parameters required for any payment must be specified:
project_id
,payment_id
,payment_currency
,payment_amount
,customer_id
. - In some cases, it is required to specify the
language_code
parameter—language code to open Payment Page. For more information, see Interface language support. - If you need to have the payment form displayed with the WeChat method selected, set the
force_payment_method
parameter towechat
. - Additionally, any other parameters available for working with Payment Page can be used (details).
- After all target parameters are specified, generate a signature (details).
Thus, a correct request for opening the payment form using the WeChat method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer identifier, language code and signature.
{ "project_id": 120, "payment_id": "580", "payment_amount": 1000, "payment_currency": "EUR", "customer_id": "customer1", "language_code": "zh", "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg==" }
{ "project_id": 120, "payment_id": "580", "payment_amount": 1000, "payment_currency": "EUR", "customer_id": "customer1", "language_code": "zh", "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg==" }
Callback format
The WeChat method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.
The following is the example of a callback with information about a 100,00 EUR
purchase made in the 238
project.
{ "project_id": 238, "payment": { "id": "TEST_154866061847343331", "type": "purchase", "status": "success", "date": "2019-01-28T08:07:22+0000", "method": "wechat", "sum": { "amount": 100, "currency": "EUR" }, "description": "TEST_1548660618473453" }, "operation": { "id": 9227000002916, "type": "sale", "status": "success", "date": "2019-01-28T08:07:22+0000", "created_date": "2019-01-28T08:06:40+0000", "request_id": "67af98801524dfa9c5cddb1a09129", "sum_initial": { "amount": 100, "currency": "EUR" }, "sum_converted": { "amount": 100, "currency": "EUR" }, "provider": { "id": 1173, "payment_id": "423163569", "date": "2019-01-28T08:07:22+0000", "auth_code": "" }, "code": "0", "message": "Success" }, "signature": "yuuYzrj3kD1cGJrJMo8oJqiyD7GgoTS+mvRA==" }
The following is the example of a callback with information about a declined purchase.
{ "project_id": 238, "payment": { "id": "TEST_154996862174000", "type": "purchase", "status": "decline", "date": "2019-02-12T10:56:22+0000", "method": "wechat", "sum": { "amount": 10000, "currency": "USD" }, "description": "TEST_154996862174000" }, "customer": { "id": "1" }, "operation": { "id": 9172000003183, "type": "sale", "status": "decline", "date": "2019-02-12T10:56:22+0000", "created_date": "2019-02-12T10:56:18+0000", "request_id": "11d4aabf869cb74c0681927ad7", "sum_initial": { "amount": 10000, "currency": "USD" }, "sum_converted": { "amount": 10000, "currency": "USD" }, "provider": { "id": 1169, "payment_id": "", "auth_code": "" }, "code": "20105", "message": "Insufficient funds on customer account" }, "signature": "ghmnbvc1oVdS/mE0AlVJRrqn7HiBOEIObz2tN5SLw==" } }
Useful links
The following articles can be useful when implementing purchases via Payment Page:
- Interaction concepts—about the interaction with the payment platform by using Payment Page.
- Signature generation and verification—about the procedure of generating and verifying signatures in requests and callbacks.
- Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
- One-time one-step purchase—about processing of one-time one-step purchases by using Payment Page.
- Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.
Purchases by using Gate
General information
To process a purchase through Gate by using the WeChat method, the merchant's web service is required to do the following:
- Send a request with all the required parameters and signature to the ecommpay URL.
- Receive an intermediate callback from the payment platform and redirect the customer to the WeChat service.
- Receive the final callback from the payment platform.
The full sequence and special aspects of purchase processing are provided below.
- A customer initiates a purchase by using the WeChat method in the web service.
- The web service sends the request for processing the purchase by using Gate to the specified ecommpay URL.
- The payment platform receives the request.
- The payment platform validates the required parameters and signature in the request.
- The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
- The payment platform performs further processing of the request (with parameter consistency check) and sends it to the WeChat service.
- The request is processed on the WeChat service side.
- The WeChat service sends the redirection data to the payment platform.
- The payment platform sends the callback with the redirection data to the web service.
- The customer is redirected to the WeChat service.
- The customer completes all required payment steps.
- The purchase is processed in the WeChat service.
- The result is displayed to the customer.
- The customer is redirected to the web service.
- The WeChat service sends the payment result notification to the payment platform.
- The payment platform sends the payment result callback to the web service.
- The customer receives the payment result information from the web service.
Information about the formats of requests and callbacks used for processing payments by using the WeChat method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.
Request format
There are several things you need to consider when sending purchase requests by using the WeChat method:
- To initiate each purchase, send a separate POST request to the
/v2/payment/wallet/wechat/sale
endpoint. This endpoint belongs to the group /v2/payment/wallet/{payment_method}/sale. - Each request must include the following objects and parameters:
- Object
general
—general purchase information:project_id
—project identifier obtained from ecommpay during integrationpayment_id
—payment identifier unique within the projectsignature
—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)
- Object
payment
—payment information:amount
—payment amount in the smallest currency unitcurrency
—payment currency code in the ISO-4217 alpha-3 formatdescription
—payment description
- Object
customer
—customer information:id
—customer identifier unique within the projectip_address
—customer IP address relevant for the initiated payment
- Object
- Additionally, depending on the payment processing provider, it is recommended to specify the following objects and parameters:
- Object
customer
—customer information:email
—customer email addressphone
—customer phone number, must be specified using a country code and without punctuation or special characters, for example19121234567
, you can read more about the format in the FAQ section
If any of these parameters are missing, the payment platform may send the list of missing parameters in a callback requesting additional information submission (details are available in Submission of additional payment information).
- Object
- Additionally, any other parameters included in the specification can be used.
Thus, a correct purchase request by using the WeChat method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information, as well as signature.
{ "general": { "project_id": 200, "payment_id": "TEST_1559134591371-pz-2", "signature": "leNRGu/zTi7tB7T1HPmvelSMQmmWyDUcq3rJKqtw==" }, "customer": { "ip_address": "192.0.2.0", "id": "customer123", "email": "customer@example.com", "phone": "19121234567" }, "payment": { "amount": 1000, "currency": "EUR", "description": "test payment" } }
{ "general": { "project_id": 200, "payment_id": "TEST_1559134591371-pz-2", "signature": "leNRGu/zTi7tB7T1HPmvelSMQmmWyDUcq3rJKqtw==" }, "customer": { "ip_address": "192.0.2.0", "id": "customer123", "email": "customer@example.com", "phone": "19121234567" }, "payment": { "amount": 1000, "currency": "EUR", "description": "test payment" } }
Formats of the customer redirection data
To redirect a customer from the web service to the WeChat site, you must receive a callback from the payment platform containing the display_data
array. This array can contain one or more objects with the following parameters:
type
—object typetitle
—object titledata
—data corresponding to the object type
The display_data
array is formed taking into account the following conditions:
- The object containing data for displaying the QR code is always present in the array. The value of the
data
parameter depends on the value of thetype
parameter which can have one of the following values:qr_url
—QR code is passed as a link the image. In this case thedata
parameter contains a URL.qr_img
—QR code is passed as an image. In this case thedata
parameter contains a string encoded using the Base64 scheme.qr_data
—QR code is passed as a string. In this case thedata
parameter contains a string which should be used to generate a QR code on the web service side.
- In addition to the object containing the data for displaying the QR-code the
display_data
array can contain one or several objects with additional information. Thetype
parameter of such objects is assigned theadd_info
value, while thedata
parameter can contain various information. - If the array contains one or more objects with additional information, then the array includes an object with the information on the lifespan of the QR code (starting when the code is created on the WeChat side). The
title
parameter of such an object is assigned theQR Code Timeout
value, while the lifespan is specified in seconds in thedata
parameter.
The following is the callback fragment containing the string to be used to generate a QR code as well as the lifespan of the code.
"display_data": [ { "type": "qr_data", "title": "QR code", "data": "weixin://wxpay/bizpayurl?pr=dMrSpJG" }, { "type": "add_info", "title": "QR Code Timeout", "data": "600" } ]
Callback format
The WeChat method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.
The following is the example of a callback with information about a 1.00 EUR
purchase made in the 238
project.
{ "project_id": 238, "payment": { "id": "TEST_154866061847343331", "type": "purchase", "status": "success", "date": "2019-01-28T08:07:22+0000", "method": "wechat", "sum": { "amount": 100, "currency": "EUR" }, "description": "TEST_1548660618473453" }, "operation": { "id": 9227000002916, "type": "sale", "status": "success", "date": "2019-01-28T08:07:22+0000", "created_date": "2019-01-28T08:06:40+0000", "request_id": "67af98801524dfa9c5cddb1a09129", "sum_initial": { "amount": 100, "currency": "EUR" }, "sum_converted": { "amount": 100, "currency": "EUR" }, "provider": { "id": 1173, "payment_id": "423163569", "date": "2019-01-28T08:07:22+0000", "auth_code": "" }, "code": "0", "message": "Success" }, "signature": "yuuYzrj3kD1cGJrJMo8oJqiyD7GgoTS+mvRA==" }
The following is the example of a callback with information about a declined purchase.
{ "project_id": 238, "payment": { "id": "TEST_154996862174000", "type": "purchase", "status": "decline", "date": "2019-02-12T10:56:22+0000", "method": "wechat", "sum": { "amount": 10000, "currency": "USD" }, "description": "TEST_154996862174000" }, "customer": { "id": "1" }, "operation": { "id": 9172000003183, "type": "sale", "status": "decline", "date": "2019-02-12T10:56:22+0000", "created_date": "2019-02-12T10:56:18+0000", "request_id": "11d4aabf869cb74c0681927ad7", "sum_initial": { "amount": 10000, "currency": "USD" }, "sum_converted": { "amount": 10000, "currency": "USD" }, "provider": { "id": 1169, "payment_id": "", "auth_code": "" }, "code": "20105", "message": "Insufficient funds on customer account" }, "signature": "ghmnbvc1oVdS/mE0AlVJRrqn7HiBOEIObz2tN5SLw==" } }
Useful links
The following articles can be useful when implementing purchases via Gate:
- Interaction concepts—about the interaction with the payment platform by using Gate.
- Signature generation and verification—about the procedure of generating and verifying signatures in requests and callbacks.
- Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
- One-time one-step purchase—about processing of one-time one-step purchases by using Payment Page.
- Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.
Refunds by using Gate
General information
To perform a refund through Gate by using the WeChat method, send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. In some cases, for one payment you can perform only one partial refund, then to make additional refunds for this payment you need to contact the technical support of the payment system. For more information refer to your ecommpay key account manager. The full sequence and special aspects of refund performing are provided below.
- A customer initiates a refund.
- The web service sends the request for performing the refund by using Gate to the specified ecommpay URL.
- The payment platform receives the request.
- The payment platform validates the required parameters and signature in the request.
- The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
- The payment platform performs further processing of the request (with parameter consistency check) and sends it to the WeChat service.
- The refund is processed on the side of the WeChat service.
- The WeChat service sends the result notification to the payment platform.
- The payment platform sends the result callback to the web service.
- The customer receives the refund result information from the web service.
Information about the formats of requests and callbacks used for performing refunds by using the WeChat method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.
Request format
There are several things you need to consider when sending refund requests by using the WeChat method:
- To initiate each refund, send a separate POST request to the
/v2/payment/wallet/wechat/refund
endpoint. This endpoint belongs to the group /v2/payment/wallet/{payment_method}/refund. - Each request must include the following objects and parameters:
- Object
general
—general refund information:project_id
—project identifier obtained from ecommpay during integrationpayment_id
—identifier of the payment that needs to be refundedpayment identifiersignature
—request signature generated after all required parameters are specified (details—in the Signature generation and verification)
- Object
payment
—refund information:description
—refund description or commentamount
—refund amount in the smallest currency unit (required for a partial refund)
- Object
customer
—customer information:ip_address
—customer IP address relevant for the initiated refund
- Object
- Additionally, any other parameters included in the specification can be used.
Thus, a correct refund request by using the WeChat method must contain the project and payment identifiers, description of the refund, the customer IP address, signature, and, if necessary, the refund amount.
"general": { "project_id": 239, "payment_id": "refund_02", "signature": "of8k9xerKSK4SwKJ7KLTZYO56lCv+f1M0Sf/7eg==" }, "customer": { "ip_address": "192.0.2.0" }, "payment": { "amount": 10000, "description": "refund_02" }
"general": { "project_id": 239, "payment_id": "refund_02", "signature": "of8k9xerKSK4SwKJ7KLTZYO56lCv+f1M0Sf/7eg==" }, "customer": { "ip_address": "192.0.2.0" }, "payment": { "amount": 10000, "description": "refund_02" }
Callback format
The WeChat method uses the standard format for callbacks to deliver refund results. For more information, see Callbacks.
The following is the example of a callback with information about a 100.00 USD
refund made in the 238
project.
{ "project_id": 238, "payment": { "id": "refund_02", "type": "purchase", "status": "refunded", "date": "2019-02-19T14:25:25+0000", "method": "wechat", "sum": { "amount": 10000, "currency": "USD" }, "description": "test_02" }, "account": { "number": "2626324568" }, "operation": { "id": 14153000003282, "type": "refund", "status": "success", "date": "2019-02-19T14:25:25+0000", "created_date": "2019-02-19T14:25:24+0000", "request_id": "9d11b2ca618ec3ba0f588af8af3c4fc9f5fa58f174", "sum_initial": { "amount": 10000, "currency": "USD" }, "sum_converted": { "amount": 10000, "currency": "USD" }, "provider": { "id": 413, "payment_id": "105887607", "date": "2019-02-19T14:25:24+0000", "auth_code": "" }, "code": "0", "message": "Success" }, "signature": "of8k9xerKSKpFBRKLTZYO56lCv+f1M0Sf/7eg==" }
The following is the example of a callback with information about a declined refund.
{ "project_id": 198, "payment": { "id": "ECT_TEST_15428009030783", "type": "purchase", "status": "success", "date": "2018-11-23T13:46:39+0000", "method": "wechat", "sum": { "amount": 10000, "currency": "EUR" }, "description": "ECT_TEST_1542800903078" }, "customer": { "id": "1" }, "operation": { "id": 13792000002073, "type": "refund", "status": "decline", "date": "2018-11-30T09:25:36+0000", "created_date": "2018-11-30T09:25:33+0000", "request_id": "d848450ce489a81f86522434873a99f534e2c", "sum_initial": { "amount": 10000, "currency": "EUR" }, "sum_converted": { "amount": 10000, "currency": "EUR" }, "provider": { "id": 413, "payment_id": "", "auth_code": "" }, "code": "3283", "message": "Refund amount more than init amount" }, "signature": "AO081Lg6GT/+VIR1DAqn57Ypq8MxSMtpOBca0mhZ9ag==" }
Useful links
The following articles can be useful when implementing refunds via Gate:
- Interaction concepts—about the interaction with the payment platform by using Gate.
- Signature generation and verification—about the procedure of generating and verifying signatures in requests and callbacks.
- Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
- Purchase refunds—about performing of refunds by using Gate.
- Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.
Analysis of payments results
As with other payment methods ecommpay offers, when using the WeChat method, you have several options to analyse the information about payments and operations performed by using the method—alone or in conjunction with other methods.
You can load and analyse all the necessary information in Dashboard, for instance you can use the analytic panels on the Analytics tab to this end.
Also, you can export the information for further analysis by using third party analytical tools. The following options are available:
- Dashboard allows you to download reports in CSV and XLS formats—by using the tools on the Payments tab. You can perform export as a one-time download to your local computer or have payment data regularly exported and delivered to email addresses you specify.
- Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by using the /operations/get queries.
If you have any further questions regarding payment data analysis, contact ecommpay technical support.