About WeChat Pay
General information about WeChat Pay
| Page properties | ||||||||
|---|---|---|---|---|---|---|---|---|
|
WeChat Pay is a payment solution completely integrated inside the social and messaging application WeChat. WeChat payment functionality appears in the "Wallet" section of the application.
WeChat supports Payment and Money Transfer
Users can perform a variety of transactions using WeChat Pay, including and not limited to:
- Transferring money to friends (especially as "red envelopes" shared during Chinese festivals)
- Performing transactions on e-commerce websites
- Topping up their mobile
Process flow chart
| Multiexcerpt | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
|
WeChat Pay process flow
On this page
| Table of Contents | ||
|---|---|---|
|
| Multiexcerpt include | ||||||
|---|---|---|---|---|---|---|
|
interface
| Multiexcerpt include | ||||||
|---|---|---|---|---|---|---|
|
Payment with WeChat Pay via form interface
To make a payment with WeChat Pay, go to please use the following URL:
Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter
Format
CND
Description
MerchantID
ans..30
M
MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.
|
Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Request_Intro PageWithExcerpt Reuse API
| Table Filter | |||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
|
TransID
ans..64
M
|
Amount
n..10
M
Amount in the smallest currency unit (e.g. EUR Cent)
Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).
Currency
a3
M
Currency, three digits DIN / ISO 4217. Only EUR, USD allowed.
MAC
an64
M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm
URLSuccess
ans..256
M
Complete URL which calls up Paygate if payment has been successful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.
URLFailure
ans..256
M
Complete URL which calls up Paygate if payment has been unsuccessful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.
Response
a7
O
Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.
URLNotify
ans..256
M
Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead.
UserData
ans..1024
O
If specified at request, Paygate forwards the parameter with the payment result to the shop
ReqID
ans..32
O
To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.
OrderDesc
ans..768
M
Description of goods and prices. Intended purpose on the statement of account
SellingPoint
ans..50
O
Selling point
Service
ans..50
O
Products or service sold
Channel
ans..64
O
|
|
|
ans..50
O
A value to be set by the merchant to return some information unencrypted, e.g. the MID
Custom
ans..1024
O
|
The merchant can submit several values separated by | which are returned unencrypted and separated by &.
Custom=session=123|id=456 will change in the answer to Session=123&id=456Parameters for payments with WeChat Pay
The following table describes the result parameters that the Paygate transmits to your URLSuccess, URLFailure or URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Response_IntroURL PageWithExcerpt Reuse API
| Table Filter | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Parameter
Format
CND
Description
MID
ans..30
M
MerchantID, assigned by Computop
PayID
an32
M
ID assigned by Paygate for the payment, e.g. for referencing in batch files.
XID
an32
M
ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate
TransID
ans..64
M
|
Status
a..30
M
OK in the case of URLSuccess and AUTHORIZE_REQUEST or FAILED in the case of URLFailure
Description
ans..1024
M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Code
n8
M
Error code according to Paygate Response Codes (A4 Error codes)
MAC
an64
M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm
UserData
ans..1024
O
If specified at request, Paygate forwards the parameter with the payment result to the shop
PaymentPurpose
ans..26
M
Purpose of payment
PaymentGuarantee
a..12
C
NONE = no payment guarantee,
VALIDATED= customer account valid, but no payment guarantee,
FULL= payment guarantee
Notice: This parameter is only returned if the Status=OK.
ErrorText
ans..256
C
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Detailed PPRO error message.
Notice: Is returned only if Status=FAILED. Use is possible only in agreement with Computop support.
| ||||||||
Plain
ans..50
O
A value to be set by the merchant to return some information unencrypted, e.g. the MID
Custom
ans..1024
O
|
The merchant can submit several values separated by | which are returned unencrypted and separated by &.
Custom=session=123|id=456 will change in the answer to Session=123&id=456Return parameters for URLSuccess, URLFailure and URLNotify with WeChat Pay
Credit with reference
Credits (refunds) are possible via a Server-to-Server connection. For a Credit with reference to a capture the amount of the Credit is limited to the amount of the previous capture.
To carry out a credit with a reference transaction, please use the following URL:
Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter
Format
CND
Description
MerchantID
ans..30
M
MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.
PayID
an32
M
ID assigned by Paygate for the payment to be credited
|
Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Request_Intro PageWithExcerpt Reuse API
| Table Filter | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
TransID
ans..64
M
|
Amount
n..10
M
Amount in the smallest currency unit (e.g. EUR Cent)
Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).
Currency
a..3
M
Currency code, three digits DIN / ISO 4217
MAC
an64
M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm
|
Parameters for credit payments with WeChat Pay via socket connection
The following table describes the Paygate response parameters:
Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Response_Intro PageWithExcerpt Reuse API
| Table Filter | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Parameter
Format
CND
Description
MID
ans..30
M
MerchantID, assigned by Computop
PayID
an32
M
ID assigned by Paygate for the payment, e.g. for referencing in batch files
XID
an32
M
ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate
TransID
ans..64
M
Merchant’s transaction number
Status
a..30
M
OK or FAILED
Description
ans..1024
M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Code
n8
M
|
Response parameters for credit payments with WeChat Pay via socket connection