Maintenance Work Notice!

We will carry out maintenance work on this documentation on Tuesday, 15.06.2021 between 3 pm and 4 pm CEST. Thank you for your understanding.

Page tree

Search

Skip to end of metadata
Go to start of metadata

About WeChat

General information about WeChat


Logo

Info

WeChat is a free, cross-platform and instant messaging application developed by Tencent. It was first released in January 2011 and was one of the largest standalone messaging apps by monthly active users. As of May 2016, WeChat has over a billion created accounts, 700 million active users; with more than 70 million outside of China (as of December 2015). In 2016, WeChat reached 864 million active users.

TypePayments by eWallet EN


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

On this page

Process flow charts

QR Code


Process flow WeChat QR Code

W2A


Process flow WeChat W2A

APP


Process flow WeChat APP

JSAPI


Process flow WeChat JSAPI

Barcode


Process flow WeChat Barcode

QRCode (Server mode)


 

Process flow WeChat Server mode


Paygate interface

Definitions

Data formats

Format

Description

a

alphabetical

as

alphabetical with special characters

n

numeric

an

alphanumeric

ans

alphanumeric with special characters

ns

numeric with special characters

bool

boolean expression (true or false)

3

fixed length with 3 digits/characters

..3

variable length with maximum 3 digits/characters

enum

enumeration of allowed values

dttm

ISODateTime (YYYY-MM-DDThh:mm:ss)


Abbreviations

Abbreviation

Description

Comment

CND

condition


M

mandatory

If a parameter is mandatory, then it must be present

O

optional

If a parameter is optional, then it can be present, but it is not required

C

conditional

If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional


Notice: Please note that the names of parameters can be returned in upper or lower case.


Call of Paygate interface for WeChat

Please use the following URL to process a WeChat payment via the Paygate form:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

Notice: For INAPP requests (Channel=APP) the interface is called via a server-to-server connection.

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.

TransID

an..32

M

TransactionID which should be unique for each payment

RefNr

an..32

O

Unique reference number

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.

For domestic merchants only CNY is permissible. For cross-border merchants only GBP, HKD, USD, JPY, CAD, AUD, EUR, NZD, KRW, THB, SGD, RUB is permissible.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

Channel

a..32

M

WeChat payment method:

QRCode: QR code payment. Display to the customer on PC web page.
W2A: Merchant has its own mobile H5 page and supports third-party browsers.
APP: Merchant has its own mobile H5 page
JSAPI:

OrderDesc

an..128

M

Description of purchased goods, unit prices etc. The special characters “#”, “&”, “%” and “+” are not permitted here.

OrderDesc2

an..2048

O

Detailed item list. Each item is separated by a semicolon (;).

Example: BookID:10,BookPrice:120;PenID:10,Material:Steel

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.

IPAddr

ns..16

O

Fraud prevention: IP address

TimeOut

n..14

O

Time limit for a transaction. Unit: minutes. At least 5 minutes.

GoodsCategory

an..32

O

Intended purpose on discount coupon.

ProductNr

an..32

O

Equivalent of Product ID used to identify the product

Limit

bool

O

If true, the payment won't accept credit cards, otherwise accept credit cards

ShopSystem

a..8

C

Mandatory in case of W2A. Applied platform, options values: IOS/Android/WAP.

ShopName

an..120

C

Mandatory in case of W2A. App’s name for IOS/Android; Website’s name for WAP.

ShopURL

an..128

C

Mandatory in case of W2A. Bundle id in case of IOS; package name in case of Android; Wap url for WAP.

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=456

Parameters for payments with WeChat


The following table describes the result parameters that Paygate transmits to your URLNotify, URLSuccess or URLFailure. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:

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

an..32

M

Merchant’s transaction number

RefNr

an..32

O

Unique reference number

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

Status

a..50

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

Error code according to Paygate Response Codes (A4 Error codes)

UserData

ans..1024

C

Not with Channel=INAPP: If specified at request, Paygate forwards the parameter with the payment result to the shop.

PrepayID

ans..64

C

Only with Channel=INAPP: required for calling Paygate Payment SDK

CodeExt

an..32

O

Wechat error code

ErrorText

ans..128

O

Detailed Wechat error message

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=456

Results parameters for URLNotify, URLSuccess and URLFailure



Barcode payment

Please use the following URL to process a WeChat Barcode payment via server-to-server connection:


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.

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ns..30

O

Unique reference number

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

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

OrderDesc

an..128

M

Description of purchased goods, unit prices etc. The special characters “#”, “&”, “%” and “+” are not permitted here.

OrderDesc2

an..2048

O

Goods details

Response

a7

O

Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.

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.

TimeOut

n..14

O

Time limit for a transaction. Unit: minutes. At least 1 minutes.

GoodsCategory

an..32

O

Intended purpose on discount coupon

Limit

bool

O

If true, the payment won't accept credit cards, otherwise accept credit cards

BuyerIDcode

n128

M

Customer’s payment code with fixed length

Parameters for Barcode payments with WeChat


The following table describes the Paygate response parameters:

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

RefNr

ns..30

O

Unique reference number

Status

a..50

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

Error code according to Paygate Response Codes (A4 Error codes)

UserData

ans..1024

C

If specified at request, Paygate forwards the parameter with the payment result to the shop

CodeExt

an..32

O

Wechat error code

ErrorText

ans..128

O

Detailed Wechat error message

Response parameters for Wechat Barcode payment



QRCode (Server mode)

Please use the following URL to process a WeChat payment with QRCode in server mode:


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.

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ns..30

O

Unique reference number

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

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

OrderDesc

an..128

M

Description of purchased goods, unit prices etc. The special characters “#”, “&”, “%” and “+” are not permitted here.

OrderDesc2

an..2048

O

Detailed item list. Each item is separated by a semicolon (;).

Example: BookID:10,BookPrice:120;PenID:10,Material:Steel

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

O

Complete URL which Paygate calls up in order to notify the shop about the payment result. It also could be configured in backend. 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.

IPAddr

ns..16

O

Fraud prevention: IP address of client.

TimeOut

n..14

O

Time limit for a transaction. Unit: minutes. At least 5 minutes.

GoodsCategory

an..32

O

Intended purpose on discount coupon.

ProductNr

an..32

O

Equivalent of Product ID used to identify the product.

Limit

bool

O

If true, the payment won't accept credit cards, otherwise accept credit cards.

Parameters for QRCode payments with WeChat in server mode

 

The following table gives the parameters with which Paygate responds:

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

RefNr

ns..30

O

Unique reference number

Channel

a..32

M

QRCode

Status

a..50

M

AUTHORIZE_REQUEST 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

Error code according to Paygate Response Codes (A4 Error codes)

UserData

ans..1024

C

If specified at request, Paygate forwards the parameter with the payment result to the shop

QRCodeUrl

ans..64

C

QRCode Url. Exists only with no error.

CodeExt

an..32

O

Wechat error code

ErrorText

ans..128

O

Detailed Wechat error message

Response parameters for QRCode payments with WeChat in server mode



Reversal

Reversals are possible via a Server-to-Server connection. In order to cancel a payment via a server-to-server communication, please use to 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 reversal 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 reverted

TransID

ans..64

M

Merchant ID for the identification of the payment process to be reversed

RefNr

ns..30

O

Unique reference number

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

UserData

ans..256

O

If specified at request, Paygate forwards the parameter with the payment result to the shop

ReqIDans..32OTo 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.

Parameters for reversals of WeChat payments


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

MC

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 transaction number, which must be unique

Status

a..50

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

Error code according to Paygate Response Codes (A4 Error codes)

Response parameters for reversals



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

TransID

an..32

M

ID assigned by Merchant for the payment process to be credited

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.

For domestic merchants only CNY is permissible. For cross-border merchants only GBP, HKD, USD, JPY, CAD, AUD, EUR, NZD, KRW, THB, SGD, RUB is permissible.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

RefNr

an..32

M

Unique reference number

ReqIDans..32OTo 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.

Parameters for credits of WeChat payments


The following table describes the Paygate response parameters:

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

an..32

M

Merchant’s transaction number

Status

a..50

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

Error code according to Paygate Response Codes (A4 Error codes)

RefNr

an..32

M

Unique reference number

CodeExt

an..32

O

Wechat error code

ErrorText

ans..128

O

Detailed Wechat error message

Result parameters for credits of WeChat payments