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 ChinaPay

General information about ChinaPay

ChinaPay is the online payment service of China UnionPay (CUP). The company offers both banking, broker and payment services as well as offline purchases on account and POS terminals. ChinaPay is the third largest online payment services provider in China.


Logo
Info

ChinaPay is the online payment service of China UnionPay (CUP). The company offers both banking, broker and payment services as well as offline purchases on account and POS terminals. ChinaPay is the third largest online payment services provider in China.

TypePayments by eWallet EN


Further information can be found on the webpage of ChinaPay (http://www.chinapay.co.uk/).

Process flow chart

ChinaPay process flow

On this page


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.


Payment with ChinaPay via Paygate form interface

Please enter the following URL to process a ChinaPay 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.

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

Merchant transaction number, which must be unique

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

MAC

an64

M

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

OrderDesc

ans..768

M

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

Format: Quantity of article categories#Actual total quantity of articles#Article1 name^Article1 price^Article1 quantity#Article2 name^Article2 price^Article2 quantity...#Article{m} name^Article{m} price^Article{m} quantity

Format of Article price: 3-digit Currency code + integer with up to 16 digits + one decimal point + 2 decimal places, e.g. CNY100000.00

Actual total quantity of articles must be greater or equal(>=) Quantity of article categories.

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.

Timeout

ans..3

O

Time limit for the transaction

Channel

n..4

O

0001-B2C; 0002-B2B. Default value 0001

AccBank

n..15

C

Obligatory for e-banking: the end customer is forwarded direct to the stated bank. Only available for domestic customers.

PayoutList

ans..24

C

For split payments only. Do not fill in if there is no split.

Separate individual values with “;”.

SplitType: 0001: realtime split; 0002: delayed split
SplitMethod: 0: Split by amount; 1: Split by proportion
MerSplitMsg :MerchantID^Amount or proportion.

For example: “0001;0;xxx^200, xxx^200, xxx^200”

(Notice: ”xxx” is the PSPs merchantID)

CustomParameter

ans..

O

Additional parameters for transactions which are separated by semicolon. You can use 11 fields. The length of BusId should be less than 8, for the values P1 to P10 less than 512.

BusId;P1;P2;P3;P4;P5;P6;P7;P8;P9;P10

For example: 00000001;123;451;124

TimeStamp

n..20

O

Time of merchant system in milliseconds

IPAddr

a..15

O

IP address of the client's browser

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 ChinaPay


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 forwarded 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 for one payment assigned by Paygate

TransID

an..32

M

Merchant’s transaction number

RefNr

an..32

O

Merchant’s unique reference number

Status

a..30

M

OK, PENDING or AUTHORIZE_REQUEST in the cas of URLSuccess and 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

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

Return parameters for URLSuccess, URLFailure and URLNotify with ChinaPay



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, three digits DIN / ISO 4217

MAC

an64

M

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

RefNr

an..32

O

Reference number of merchant (e.g. invoice 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 with ChinaPay


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

Status

a..50

M

OK or FAILED
If a pending status is applied, a message is sent back after a completed credit to the URLNotify transferred with the authorization.

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

O

Reference number of merchant (e.g. invoice number)

Response parameters for credits with ChinaPay