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


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 QR Code (Server mode)


interface


Call of interface for WeChat

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

wechat.aspx


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

Key

Format

CND

Description

Beschreibung

Currency

A3

M

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. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217. Für inländische Händler ist zur CNY zulässig. Für Cross-Border-Händler ist nur GBP, HKD, USD, JPY, CAD, AUD, EUR, NZD, KRW, THB, SGD, RUB zulässig. Hier eine Übersicht: A1 Währungstabelle

Key

Format

CND

Description

Beschreibung

Channela..32M

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:

Die WeChat-Zahlungsmethode:

QRCode: QR-Code-Zahlung. Dem Kunden auf der PC-Webseite anzeigen.
W2A: Händler hat eigene mobile H5-Seite und unterstütze andere Browser.
APP: Händler hat eigene mobile H5-Seite
JSAPI:

OrderDesc

an..128

M

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

Beschreibung der gekauften Waren, Einzelpreise etc. Die Sonderzeichen “#”,”&”, ”%” und “+” sind hier nicht erlaubt.

OrderDesc2an..2048O

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

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

Ausführliche Artikelliste. Jeder Artikel durch Semikolon (;) getrennt.

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

Key

Format

CND

Description

Beschreibung

IPAddr

ns..16

O

Fraud prevention: IP address

Betrugsprävention: IP-Adresse

TimeOut

n..14

O

Time limit for a transaction. Unit: minutes. At least 5 minutes.Zeitlimit für die Transaktion. Einheit: Minuten. Mindestens 5 Minuten.
GoodsCategory

an..32

O

Intended purpose on discount couponBeabsichtigter Zweck auf Rabatt-Coupon
ProductNr

an..32

O

Equivalent of Product ID used to identify the productÄquivalent zur Produkt ID zur Identifikation des Produkts
Limit

bool

O

If true, the payment won't accept credit cards, otherwise accept credit cardsWenn true, werden keine Kreditkarten akzeptiert, anderernfalls werden Kreditkarten akzeptiert
ShopSystem

a..8

C

Mandatory in case of W2A. Applied platform, options values: IOS/Android/WAP.Pflicht bei W2A. Genutzte Plattform, mögliche Werte: IOS/Android/WAP.
ShopName

an..120

C

Mandatory in case of W2A. App’s name for IOS/Android; Website’s name for WAP.Pflicht bei W2A. Name der App für IOS/Android; Name der Webseite für 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.Pflicht bei W2A. BundleID bei IOS; Paket-Name bei Android, Wap-URL bei WAP.

Parameters for payments with WeChat


Key

Format

CND

Description

Beschreibung

UserData

ans..1024

C

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

Nicht bei Channel=INAPP: Wenn beim Aufruf angegeben, übergibt das die Parameter mit dem Zahlungsergebnis an den Shop

PrepayID

ans..64

C

Only with Channel=INAPP: required for calling Payment SDK

Nur bei Channel=INAPP: erforderlich zum Aufruf vom Payment SDK

CodeExt

an..32

O

Wechat error code

Fehlercode von Wechat
ErrorText

ans..128

O

Detailed Wechat error message

Ausführliche Fehlermeldung von Wechat

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:

WechatQuickpay.aspx


Key

Format

CND

Description

Beschreibung

OrderDesc

an..128

M

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

Beschreibung der gekauften Waren, Einzelpreise etc. Die Sonderzeichen “#”,”&”, ”%” und “+” sind hier nicht erlaubt.

OrderDesc2an..2048OGoods detailsWarendetails

Key

Format

CND

Description

Beschreibung
TimeOut

n..14

O

Time limit for a transaction. Unit: minutes. At least 1 minute.Zeitlimit für die Transaktion. Einheit: Minuten. Mindestens 1 Minute.
GoodsCategory

an..32

O

Intended purpose on discount couponBeabsichtigter Zweck auf Rabatt-Coupon
Limit

bool

O

If true, the payment won't accept credit cards, otherwise accept credit cardsWenn true, werden keine Kreditkarten akzeptiert, anderernfalls werden Kreditkarten akzeptiert
BuyerIDcoden128MCustomer’s payment code with fixed lengthZahlungscode des Kunden mit feste Länge

Parameters for Barcode payments with WeChat


Key

Format

CND

Description

Beschreibung
CodeExt

an..32

O

Wechat error code

Fehlercode von Wechat
ErrorText

ans..128

O

Detailed Wechat error message

Ausführliche Fehlermeldung von Wechat

Response parameters for Wechat Barcode payment



QRCode (Server mode)

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

WechatQRCode.aspx


Key

Format

CND

Description

Beschreibung

OrderDesc

an..128

M

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

Beschreibung der gekauften Waren, Einzelpreise etc. Die Sonderzeichen “#”,”&”, ”%” und “+” sind hier nicht erlaubt.

OrderDesc2an..2048O

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

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

Ausführliche Artikelliste. Jeder Artikel ist durch ein Semikolon (;) getrennt.

Beispiel: BuchID:10,BuchPreise:120;StiftID:10,Material:Stahl

Key

Format

CND

Description

Beschreibung
IPAddrns..16OFraud prevention: IP address of clientBetrugsprävention: IP-Adresse des Kunden
TimeOut

n..14

O

Time limit for a transaction. Unit: minutes. At least 5 minutes.Zeitlimit für die Transaktion. Einheit: Minuten. Mindestens 5 Minuten.
GoodsCategory

an..32

O

Intended purpose on discount couponBeabsichtigter Zweck auf Rabatt-Coupon
ProductNran..32OEquivalent of Product ID used to identify the productÄquivalent der Product ID zur Identifizierung des Produkts
Limit

bool

O

If true, the payment won't accept credit cards, otherwise accept credit cardsWenn true, werden keine Kreditkarten akzeptiert, anderernfalls werden Kreditkarten akzeptiert

Parameters for QRCode payments with WeChat in server mode

 

Key

Format

CND

Description

Beschreibung
Channela..32MQRCodeQRCode
Statusa..50MAUTHORIZE_REQUEST or FAILEDAUTHORIZE_REQUEST oder FAILED

Key

Format

CND

Description

Beschreibung
QRCodeUrlans..64CQRCode Url. Exists only with no error.QRCode Url. Gibt es nur, wenn kein Fehler auftritt.
CodeExt

an..32

O

Wechat error code

Fehlercode von Wechat
ErrorText

ans..128

O

Detailed Wechat error message

Ausführliche Fehlermeldung von Wechat

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:

reverse.aspx


Parameters for reversals of WeChat payments


Response parameters for reversals



Credit with reference

credit.aspx


Key

Format

CND

Description

Beschreibung

Currency

A3

M

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. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217. Für inländische Händler ist zur CNY zulässig. Für Cross-Border-Händler ist nur GBP, HKD, USD, JPY, CAD, AUD, EUR, NZD, KRW, THB, SGD, RUB zulässig. Hier eine Übersicht: A1 Währungstabelle

Parameters for credits of WeChat payments


Key

Format

CND

Description

Beschreibung
CodeExt

an..32

O

Wechat error code

Fehlercode von Wechat
ErrorText

ans..128

O

Detailed Wechat error message

Ausführliche Fehlermeldung von Wechat

Result parameters for credits of WeChat payments