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. |
Type |
Process flow chart
Unified Barcode payment process flow
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:
https://www.computop-paygate.com/barcode.aspx
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:
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. | |
ans..64 | M | TransactionID provided by you which should be unique for each payment | |
ans..30 | O | Merchant’s unique reference number | |
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). | |
a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table | |
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
OrderDesc | ans..768 | M | Name of the transaction which is displayed in the transactions list |
OrderDesc2 | ans..768 | O | Transaction notice |
ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. | |
BuyerIDCode | ans..32 | MC | Code generated by the Alipay-App. It is designed for the identification of a user. |
TimeOut | n..14 | OC | 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. |
GoodsCategory | an..32 | OC | 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. |
Limit | bool | OC | 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 Computop Paygate responds to your system
pls. be prepared to receive additional parameters at any time and do not check the order of parameters
the key (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | |
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | |
an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | |
ans..64 | M | TransactionID provided by you which should be unique for each payment | |
ans..30 | O | Merchant’s 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.) |
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! | |
an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | |
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 Helpdesk. |
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.