Introduction
 |
WeChat Pay, officially referred to as Weixin Pay in China, is a mobile payment and digital wallet service by WeChat based in China that allows users to make mobile payments and online transactions. As of March 2016, WeChat Pay had over 300 million users. WeChat Pay's main competitor in China and the market leader in online payments is Alibaba Group's Alipay. Alibaba company founder Jack Ma considered the red envelope feature to be a "Pearl Harbor moment", as it began to erode Alipay's historic dominance in the online payments industry in China, especially in peer-to-peer money transfer. The success prompted Alibaba to launch its own version of virtual red envelopes in its competing Laiwang service. Other competitors, Baidu Wallet and Sina Weibo, also launched similar features. |
Integrations
POST Request - Pre-/ Authorization
Account Parameters
| request
required
|
Fixed Value: preauthorisation/authorization
|
| mid
required
|
your merchant ID, 5-digit numeric
|
| aid
required
|
your subaccount ID, 5-digit numeric
|
| portalId
required
|
your Portal ID, 7-digit numeric
|
| key
required
|
your key value, alpha-numeric
|
common Parameters
| clearingtype
required
|
Fixed Value: wtl
|
| mode
required
|
Fixed Value: test/live
Can be either test environment (test) or live environment (live) |
| reference
optional
|
Format CHAR(2..255)
A unique ID that will be displayed in your shop backend and for the customer |
| amount
required
|
Format NUMERIC(1..10)
Permitted values max. +/- 19 999 999 99
Specifies the total gross amount of a payment transaction. Value is given in smallest currency unit, e.g. Cent of Euro. The amount must be less than or equal to the amount of the corresponding booking. |
| currency
required
|
Format LIST
Permitted values ISO 4217 (currencies) 3-letter-codes
Samples
EUR USD GBP |
| param optional
|
Format CHAR(1..255)
Individual parameter (per payment process) |
| narrative_text optional
|
Format CHAR(1..81)
Dynamic text element on account statements (3 lines with 27 characters each) and credit card statements. |
| customer_is_present
optional
|
Format LIST
Permitted Values yes /no
Indicates whether customer is “present” and can enter their data in the shop (=yes). Or customer is not present and can not enter any data (=no). |
PERSONAL DATA Parameters
| customerid optional
|
Format CHAR(1..20)
Permitted Symbols [0-9, a-z, A-Z, .,-,_,/] Merchant's customer ID, defined by you / merchant to refer to the customer record. "customerid" can be used to identify a customer record.
If "customerid" is used then stored customer data are loaded automatically. |
||||||
| userid optional
|
Format NUMERIC(6..12)
PAYONE User ID, defined by PAYONE |
||||||
| businessrelation optional
|
Format LIST
Value specifies business relation between merchant and customer |
||||||
| salutation optional
|
Format CHAR(1..10)
The customer's salutation |
||||||
| title optional
|
Format CHAR(1..20)
Samples
Dr Prof. Dr.-Ing. Title of the customer |
||||||
| firstname optional
|
Format CHAR(1..50)
First name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname" |
||||||
| lastname
required
|
Format CHAR(2..50)
Last name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname" |
||||||
| company optional
|
Format CHAR(2..50)
Comany name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname" |
||||||
| street optional
|
Format CHAR(1..50)
Street number and name (required: at least one character) |
||||||
| addressaddition optional
|
Format CHAR(1..50)
Samples
7th floor c/o Maier Specifies an additional address line for the invoice address of the customer. |
||||||
| zip optional
|
Format CHAR(2..50)
Permitted Symbols [0-9][A-Z][a-z][_.-/ ]
Postcode |
||||||
| city optional
|
Format CHAR(2..50)
City of customer |
||||||
| country
required
|
Fixed Value DE
|
||||||
| state required
|
Format LIST
Permitted values ISO 3166-2 States (regions) 2-letter-codes
Specifies state / region of country for the customer. |
||||||
| email optional
|
Format CHAR(5..254)
Mandatory if "add_paydata[shopping_cart_type]=DIGITAL" Permitted Symbols RFC 5322 Special Remark email validation: Max. length for email is 254 characters. Validation is set up in the following way: Username = Max. 63 characters Domain Name = Max. 63 characters "@" and "." is counted as a character as well; in case of a total of three suffixes, this would allow a total of 254 characters. email-address of customer |
||||||
| telephonenumber optional
|
Format CHAR(1..30)
Phone number of customer |
||||||
| birthday optional
|
Format DATE(8), YYYYMMDD
Samples
20190101 19991231 Date of birth of customer |
||||||
| language optional
|
Format LIST
Permitted values ISO 639-1 (Language)2-letter-codes
Language indicator (ISO 639) to specify the language that should be presented to the customer (e.g. for error messages, frontend display). If the language is not transferred, the browser language will be used. For a non-supported language English will be used. |
||||||
| vatid optional
|
Format CHAR(1..50)
VAT identification number. Used for b2b transactions to indicate VAT number of customer. |
||||||
| gender optional
|
Format LIST
Permitted values f / m / d
Gender of customer (female / male / diverse* ) * currently not in use |
||||||
| personalid optional
|
Format CHAR(1..32)
Permitted Symbols [0-9][A-Z][a-z][+-./()]
Person specific numbers or characters, e.g. number of passport / ID card |
||||||
| ip optional
|
Format CHAR(1..39)
Customer's IP-V4-address (123.123.123.123) or IP-V6-address |
Delivery data Parameters
| shipping_firstname required
|
Format CHAR(1..50)
First name of delivery address |
||||||
| shipping_lastname required
|
Format CHAR(1..50)
Surname of delivery address |
||||||
| shipping_company optional
|
Format CHAR(2..50)
Company name of delivery address |
||||||
| shipping_street optional
|
Format CHAR(2..50)
Street number and name of delivery address |
||||||
| shipping_zip required
|
Format CHAR(2..50)
Postcode of delivery address |
||||||
|
shipping_
optional
|
Format CHAR(1..50)
Specifies an additional address line for the delivery address of the customer, e.g. "7th floor", "c/o Maier". |
||||||
| shipping_country optional
|
Format LIST
Permitted values ISO 3166 2-letter-codes
Samples
DE GB US Specifies country of address for the customer. Some countries require additional information in parameter "state" |
||||||
| shipping_state required (in CN)
|
Format LIST
Permitted values ISO 3166-2 States (regions) 2-letter-codes
|
Wallet PARAMETERS
| wallettype required
|
Fixed Value WCP
|
| successurl
required
|
Format CHAR(2..255)
Scheme <scheme>://<host>/<path> <scheme>://<host>/<path>?<query> scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}
URL for "payment successful" |
| errorurl
required
|
Format CHAR(2..255)
Scheme <scheme>://<host>/<path> <scheme>://<host>/<path>?<query> scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}
URL for "faulty payment" |
| backurl
required
|
Format CHAR(2..255)
Scheme <scheme>://<host>/<path> <scheme>://<host>/<path>?<query> scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}
URL for "Back" or "Cancel" |
Article Parameters
| it[n] optional
|
Format LIST
|
||||||||||
| id[n] optional
|
Format CHAR(1..32)
Array elements [n] starting with [1]; serially numbered; max [400]
Permitted Symbols [0-9][a-z][A-Z], .,-,_,/
International Article Number (EAN bzw. GTIN) Product number, SKU, etc. of this item |
||||||||||
| pr[n] optional
|
Format NUMERIC(10) max. 19 999 999 99
Array elements [n] starting with [1]; serially numbered; max [400]
Unit gross price of the item in smallest unit! e.g. cent |
||||||||||
| no[n] optional
|
Format NUMERIC(6)
Array elements [n] starting with [1]; serially numbered; max [400]
Quantity of this item |
||||||||||
| de[n] optional
|
Format CHAR(1..255)
Array elements [n] starting with [1]; serially numbered; max [400] Description of this item. Will be printed on documents to customer. |
||||||||||
| va[n] optional
|
Format NUMERIC(4)
VAT rate (% or bp) Array elements [n] starting with [1]; serially numbered; max [400] |
Response Parameters
|
Permitted Values
APPROVED
ERROR
|
Response Parameter (approved)
| txid |
Format NUMERIC(9..12)
The txid specifies the payment process within the PAYONE platform |
|
Format NUMERIC(6..12)
PAYONE User ID, defined by PAYONE |
Response Parameter (Error)
|
Format NUMERIC(1..6)
In case of error the PAYONE Platform returns an error code for your internal usage. |
|
|
Format CHAR(1..1024)
In case of error the PAYONE Platform returns an error message for your internal usage. |
|
|
Format CHAR(1..1024)
The customermessage is returned to your system in order to be displayed to the customer. (Language selection is based on the end customer's language, parameter "language") |
Host: api.pay1.de Content-Type: application/x-www-form-urlencoded
Payload
https://api.pay1.de/post-gateway/
aid=52078
amount=100
api_version=3.10
backurl=https://www.yourdomain.com/backurl
clearingtype=wlt
country=DE
currency=EUR
encoding=UTF-8
errorurl=https://www.yourdomain.com/error
hash=7ebd46ee831b385a919dfd266f2771411a81878a07583782b30edb3e2d99da071ada7ca79f9ed1b5c8a63f4002273709
key=17031f73e2c6f9755788bddfff04169b
lastname=Test
mid=14648
mode=test
portalid=2037267
reference=3795667038580
request=preauthorization
successurl=https://www.yourdomain.com/success
wallettype=WCP
RESPONSE
status=REDIRECT
redirecturl=https://r3.girogate.de/ti/dumbdummy?tx=2186661658&rs=60fJNpX4ci39JUDCqb0L7nv8e6e3ezZW&cs=04f3de9b4c5b9727aa42a3eeb3bf071fad6936f97386eaf5d79a4a0dbe9fa10a
txid=983037275
userid=6534498859
POST Request - Capture
Account Parameters
| request
required
|
Fixed Value: preauthorisation/authorization
|
| mid
required
|
your merchant ID, 5-digit numeric
|
| aid
required
|
your subaccount ID, 5-digit numeric
|
| portalId
required
|
your Portal ID, 7-digit numeric
|
| key
required
|
your key value, alpha-numeric
|
common Parameters
| txid
required
|
Format NUMERIC(9..12)
The txid specifies the payment process within the PAYONE platform |
| sequencenumber optional
|
Format NUMERIC(1..3)
Permitted values 0..127
Sequence number for this transaction within the payment process (1..n), e.g. PreAuthorization: 0, 1. Capture: 1, 2. Capture: 2 Required for multi partial capture (starting with the 2nd capture) |
| amount
required
|
Format NUMERIC(1..10)
Permitted values max. +/- 19 999 999 99
Specifies the total gross amount of a payment transaction. Value is given in smallest currency unit, e.g. Cent of Euro; Pence of Pound sterling; Öre of Swedish krona. The amount must be less than or equal to the amount of the corresponding booking. |
| currency
required
|
Fixed Value EUR
|
| narrative_text
optional
|
Format CHAR(1..81)
Dynamic text element on account statements (3 lines with 27 characters each) and credit card statements. |
Response Parameters
|
Permitted Values
APPROVED
PENDING
ERROR
|
Response Parameter (approved)
|
Format LIST
Provides information about whether a settlement of balances has been carried out. |
Response parameters (pending)
|
Format NUMERIC(9..12)
The txid specifies the payment process within the PAYONE platform |
|
|
Format NUMERIC(6..12)
PAYONE User ID, defined by PAYONE |
Response parameters (error)
|
Format NUMERIC(1..6)
In case of error the PAYONE Platform returns an error code for your internal usage. |
|
|
Format CHAR(1..1024)
In case of error the PAYONE Platform returns an error message for your internal usage. |
Host: api.pay1.de
Content-Type: application/x-www-form-urlencoded
Payload
mid=23456 portalid=12345123 key=abcdefghijklmn123456789 api_version=3.10 mode=test request=capture encoding=UTF-8 txid=345678901 amount=300 currency=EUR
RESPONSE
status=APPROVED txid=345678901 settleaccount=no
POST Request - Debit
Account Parameters
| request
required
|
Fixed Value: preauthorisation/authorization
|
| mid
required
|
your merchant ID, 5-digit numeric
|
| aid
required
|
your subaccount ID, 5-digit numeric
|
| portalId
required
|
your Portal ID, 7-digit numeric
|
| key
required
|
your key value, alpha-numeric
|
Common Parameters
| txid
required
|
Format NUMERIC(9..12)
The txid specifies the payment process within the PAYONE platform |
||||||
| sequencenumber
required
|
Format NUMERIC(1..3)
Permitted values 0..127 Sequence number for this transaction within the payment process (1..n), e.g. PreAuthorization: 0, 1. Capture: 1, 2. Capture: 2 Required for multi partial capture (starting with the 2nd capture) |
||||||
| amount
required
|
Format NUMERIC(1..10)
Permitted values max. +/- 19 999 999 99
Specifies the total gross amount of a payment transaction. Value is given in smallest currency unit, e.g. Cent of Euro; Pence of Pound sterling; Öre of Swedish krona. The amount must be less than or equal to the amount of the corresponding booking. |
||||||
| currency
required
|
Fixed Value EUR
|
||||||
| narrative_text
optional
|
Format CHAR(1..81)
Dynamic text element on account statements (3 lines with 27 characters each) and credit card statements. |
||||||
| clearingtype
optional
|
Fixed Value wlt
|
||||||
| use_customerdata
optional
|
Format LIST
Use account details from debtor's master data |
||||||
| transaction_param
optional
|
Format CHAR(1..50)
Permitted Symbols [0-9][A-Z][a-z][.-_/]
Optional parameter for merchant information (per payment request) |
Response Parameters
| status |
Permitted Values
APPROVED
ERROR
|
Response Parameter (approved)
| txid |
Format NUMERIC(9..12)
The txid specifies the payment process within the PAYONE platform |
||||||
| settleaccount |
Format LIST
Provides information about whether a settlement of balances has been carried out. |
Response Parameter (error)
| errorcode |
Format NUMERIC(1..6)
In case of error the PAYONE Platform returns an error code for your internal usage. |
| errormessage |
Format CHAR(1..1024)
In case of error the PAYONE Platform returns an error message for your internal usage. |
| customermessage |
Format CHAR(1..1024)
The customermessage is returned to your system in order to be displayed to the customer. (Language selection is based on the end customer's language, parameter "language") |
Host: api.pay1.de
Content-Type: application/x-www-form-urlencoded
Payload
mid=23456
portalid=12345123
key=abcdefghijklmn123456789
api_version=3.10
mode=test
request=capture
encoding=UTF-8
txid=345678901
sequencenumber=1
amount=1000
currency=EUR
RESPONSE
status=APPROVED txid=345678901 settleaccount=no
Specials
Reversal is not supported
Sequence Diagrams
Sale
Order & Delivery
Returns
