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 Unified Barcode payment

General information about Unified Barcode payment

Since Spot Payment of Alipay and Quick Pay of WeChat Pay have been integrated in Paygate, there are 2 interfaces for barcode payment. In order to initiate payment, the merchant needs to ask customer in advance which payment method should be used, Alipay or WeChat Pay.

To simplify this process at merchant’s side and to offer merchants a convenient experience of barcode payment with Paygate, a unified interface can be established for both barcode payments. Based on the "barcode" it could be recognized by Paygate which payment method it’s about and then the process would be routed to the appropriate scheme.

Logo
Info

Since Spot Payment of Alipay and Quick Pay of WeChat Pay have been integrated in Paygate, there are 2 interfaces for barcode payment. In order to initiate payment, the merchant needs to ask customer in advance which payment method should be used, Alipay or WeChat Pay.

TypePayments by eWallet EN

Process flow chart

Unified Barcode payment 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.


Calling the interface

In order to execute a payment with Unifed Barcode payment via server-to-server connection, 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.

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ans..30

O

Unique reference number

Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currencya3MCurrency, three digits DIN / ISO 4217
MACan64MHash Message Authentication Code (HMAC) with SHA-256 algorithm

OrderDesc

ans..256

M

Name of the transaction which is displayed in the transactions list

OrderDesc2ans..256OTransaction notice

UserData

ans..1024

O

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

BuyerIDCodeans..32MCCode generated by the Alipay-App. It is designed for the identification of a user.
TimeOutn..14OC

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

Optional parameter of WeChat Pay: will be regarded when it’s a payment of WeChat Pay.
GoodsCategoryan..32OC

Only for WeChat: Product category. Meaning at WeChat Pay: Intended purpose on discount coupon.

Optional parameter of WeChat Pay: will be regarded when it’s a payment of WeChat Pay.
LimitboolOC

Only for WeChat: If true, credit cards won't be accepted in the payment, otherwise credit cards will be accepted.

Optional parameter of WeChat Pay: will be regarded when it’s a payment of WeChat Pay.

Parameters for payments with Unified Barcode payment


The following table describes the result parameters with which the Paygate responds:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the transaction, 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, FAILED or AUTHORIZE_REQUEST (If no final status from Alipay exists. Customers may need to confirm the payment in the app with their password.)

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

O

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

CodeExt

ans..40

OC

Only for WeChat: WeChat error code. Not included when it’s a payment of Alipay.

ErrorText

ans..256

O

Error text from the downstream system, only when its response is discussed with Computop Support (configured in MAT).

TID

ans..64

OC

Only for Alipay: TransactionID generated by Alipay system. Not included when it’s payment of WeChat Pay.

Result parameters for payments with Unified Barcode payment


Credit / Reversal

Credits with reference and Reversals depend on the selected payment scheme Alipay or WeChat Pay. For processing such follow-up transactions please see the respective manuals for Alipay or WeChat Pay.