Paygate interface
| Multiexcerpt include | ||||||
|---|---|---|---|---|---|---|
|
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 |
| 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..256 | M | Name of the transaction which is displayed in the transactions list |
| OrderDesc2 | ans..256 | O | Transaction notice |
UserData | 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 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.