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)

CND

condition

M

mandatory

O

optional

C

conditional

https://www.computop-paygate.com/wechat.aspx

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

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

https://www.computop-paygate.com/WechatQuickpay.aspx

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

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

https://www.computop-paygate.com/WechatQRCode.aspx

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.

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

https://www.computop-paygate.com/reverse.aspx

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

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)

https://www.computop-paygate.com/credit.aspx

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

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