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

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, Computop 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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyFormatCNDDescriptionBeschreibung
Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

Format

CND

Description

Beschreibung

OrderDesc

ans..768

M

Name of the transaction which is displayed in the transactions list

Name der Transaktion, der in der Transaktionsliste angezeigt wird

OrderDesc2ans..768OTransaction noticeTransaktionshinweis

KeyFormatCNDDescriptionBeschreibung
UserData

ans..1024

O

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

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

Key

Format

CND

Description

Beschreibung

BuyerIDCodeans..32MCCode generated by the Alipay-App. It is designed for the identification of a user.Von der Alipay-App erzeugter Code. Er dient zur Identifikation des Nutzers.
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.

Nur für WeChat: Zeitlimit für eine Transaktion. Einheit: Minuten. Mindestens 1 Minute.
Optionaler Parameter von WeChat Pay: wird berücksichtigt, wenn es eine Zahlung mit WeChat Pay ist.

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.

Nur für WeChat: Product category. Meaning at WeChat Pay: Intended purpose on discount coupon.
Optionaler Parameter vonWeChat Pay: wird berücksichtigt, wenn es eine Zahlung mit WeChat Pay ist.

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.

Nur für WeChat: If true, credit cards won't be accepted in the payment, otherwise credit cards will be accepted.
Optionaler Parameter von WeChat Pay: wird berücksichtigt, wenn es eine Zahlung mit WeChat Pay ist.

Parameters for payments with Unified Barcode payment


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

Key

Format

CND

Description

Beschreibung

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.)

OK, FAILED oder AUTHORIZE_REQUEST (Falls kein finaler Status von Alipay existiert. Kunden müssen die Zahlung eventuell in der App mit ihrem Kennwort bestätigen.)

KeyFormatCNDDescriptionBeschreibung
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!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

KeyFormatCNDDescriptionBeschreibung
UserData

ans..1024

O

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

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

Key

Format

CND

Description

Beschreibung
CodeExtans..40OCOnly for WeChat: WeChat error code. Not included when it’s a payment of Alipay.Nur für WeChat: Fehlercode von WeChat. Bei einer Zahlung mit Alipay nicht enthalten.
ErrorTextans..256O

Error text from the downstream system, only when its response is discussed with Computop Helpdesk.

Fehlertext vom nachgelagerten System, nur wenn mit dem Computop Helpdesk abgesprochen.

TIDans..64OCOnly for Alipay: TransactionID generated by Alipay system. Not included when it’s payment of WeChat Pay.Nur für Alipay: Vom Alipay-System erzeugte TransactionID. Bei einer Zahlung mit WeChat Pay nicht enthalten.

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.