About Alipay
General information about Alipay
China is the second largest market worldwide for online payments with annual sales of over 100 billion US Dollars and it offers the greatest growth potential for eCommerce. Alipay is a leading local Payment Service Provider (PSP) with a popular E-Wallet for online payments. Alipay supports transactions within China as well as cross-border transactions (CrossBorder) to foreign merchants, which are directly billed in one of the supported currencies.
Alipay Spot Payment is a payment variant for Alipay customers who also want to use their Alipay account in store. The checkout system scans a barcode generated by the Alipay App from the customer's mobile phone and then calls an Alipay online interface via Pay-Jet Cockpit. Alipay Spot Payment is available only for cross-border partners.
Alipay QR Code Payment is another variant of In-store Payment. The checkout system produces a QR Code according to the payment data by calling an Alipay API via Pay-Jet Cockpit, and then the customer scans the QR Code with his mobile device to finish the payment. Alipay QR Code Payment is available only for cross-border partners.
Alipay In-App Payment is a variant of Online Payment. The customer makes purchase within merchant’s App. When he checks out, the merchant’s App gets a request string from Pay-Jet Cockpit. Then the customer is redirected to Alipay’s App on his mobile device with this request string and completes the payment. Alipay In-App Payment is available only for cross-border partners.
| Logo |
|
|---|---|
| Info | Customers and merchants can send and receive payments with the E-Wallet from China’s leading online payment system. Alipay has over 800 million registered users and in 2014 it processed over 100 million online payments per day. |
| Type | Payments by eWallet |
Further information you will find also on the webpage of Alipay (https://intl.alipay.com/, https://global.alipay.com/open/doc.htm).
Process flow charts
Alipay Website Payment process flow Alipay Spot Payment process flow Alipay QR Code Payment process flow Alipay In-App Payment process flow
On this page
Cockpit interface
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) Abbreviation Description CND condition M mandatory O optional C conditional Notice: Please note that the names of parameters can be returned in upper or lower case.Definitions
Data formats
Abbreviations
Comment If a parameter is mandatory, then it must be present If a parameter is optional, then it can be present, but it is not required If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional
Calling the interface for an Alipay Website payment
Cancellations and credits are available for Alipay payments as described in the sections below. Only credits are available in batch mode. For point-of-sale transactions please use connection for Alipay Spot Payment or OR Code payment.
Enter the following URL to process an Alipay Website payment via the Pay-Jet Cockpit form:
https://www.payjet-cockpit.de/alipay.aspx |
Notice: For security reasons, Cockpit 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 Pay-Jet. 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 for your accounts |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the Pay-Jet Support, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency, three digits DIN / ISO 4217 For merchants in China (inland) only CNY is permitted; CNY is not permitted for cross-border merchants. |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
OrderDesc | ans..768 | M | Name of the goods purchased. The special characters “#”, “&”, “%” and “+” are not permitted here. |
OrderDesc2 | ans..400 | M | Description of purchased goods and their quantity in the format goods_name1;quantity1+goods_name2;quantity2. <;> separates goods and quantity within one goods data record Example: iPhone X;1+iPhone 8;2 The special characters “#”, “&” and “%” are not permitted here. |
ShopURL | an..128 | M | URL of web shop, for example https://testmerchant.com |
UserData | ans..1024 | O | If specified at request, Cockpit forwards the parameter with the payment result to the shop |
URLSuccess | ans..256 | M | Complete URL which calls up Cockpit 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 Cockpit and shop, please use the parameter UserData. |
URLFailure | ans..256 | M | Complete URL which calls up Cockpit 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 Cockpit and shop, please use the parameter UserData. |
Response | a7 | O | Status response sent by Cockpit to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter. |
URLNotify | ans..256 | O | Complete URL which Cockpit 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. |
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, Cockpit will not carry out the payment, but will just return the status of the original transaction. Please note that the Cockpit must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
Timeout | ans..3 | O | Time limit for a transaction (for domestic merchants only) from 1 minute up to 15 days Details are given in the form of a two-digit integer plus an identifier: m (minute) h (hour) d (day) Because only integer numbers are allowed, instead of 1.5 hours the value 90m must be used. Additionally 1c means until end of present day. Use is possible only in agreement with Pay-Jet Support. |
CustomerID | ans..16 | O | unique customer number |
AccBank | ans..7 | OC | Obligatory for e-banking: The end customer is forwarded direct to the stated bank. Only possible for domestic merchants. - ICBCBTB: Industrial and Commercial Bank of China - ABCBTB: Agricultural Bank of China - CCBBTB: China Construction Bank - SPDBB2B: Shanghai Pudong Development Bank - BOCB2C: Bank of China - ICBCB2C: Industrial and Commercial Bank of China - CMB: China Merchants Bank - CCB: China Construction Bank - ABC: Agricultural Bank of China - SPDB: Shanghai Pudong Development Bank - CIB: Industrial Bank - GDB: Guangdong Development Bank - SDB: Shenzhen Development Bank - CMBC: China Minsheng Banking - COMM: Bank of Communications - CITIC: China Citic Bank - HZCBB2C: Bank of Hangzhou - CEBBANK: China Everbright Bank - SHBANK: Bank of Shanghai - NBBANK: Bank of Ningbo - SPABANK: Ping An Bank - BJBANK: Bank of Beijing - BJRCB: Beijing Rural Commercial Bank - FDB: Fudian Bank - POSTGC: PostalSavings Bank of China - abc1003: Visa - abs1004: Master |
Device | a6 | O | When submitting “Mobile” the mobile version of Alipay is called instead of the desktop version |
FxCurrency | ans.. | OC | Currency for settlement. Three digits DIN / ISO 4217. |
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 |
Parameters for payments with Alipay Website payment
Parameter | Format | CND | Description | |
|---|---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by Pay-Jet | |
PayID | an32 | M | ID assigned by Cockpit 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 Cockpit | |
TransID | ans..64 | M | Merchant’s transaction number | |
Status | a..50 | M | OK for URLSuccess and AUTHORIZE_REQUEST or FAILED for URLFailure | |
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 Cockpit Response Codes (A4 Error codes) | |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm | |
RefNr | ns..30 | O | Unique reference number | |
UserData | ans..1024 | O | If specified at request, Cockpit forwards the parameter with the payment result to the shop | |
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 | |
Result parameters for URLNotify, URLSuccess and URLFailure in case of Alipay Website payment
Calling the interface for a payment with Alipay Spot Payment
In order to execute a payment with Alipay Spot Payment via server-to-server communication, please use the following URL:
https://www.payjet-cockpit.de/alipayspot.aspx |
Notice: For security reasons, Cockpit 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 Pay-Jet. 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 Pay-Jet Support, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency, three digits DIN / ISO 4217 For merchants in China (inland) only CNY is permitted; CNY is not permitted for cross-border merchants. |
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, Cockpit forwards the parameter with the payment result to the shop |
BuyerIDCode | ans..32 | M | Code generated by the Alipay-App. It is designed for the identification of a user. |
Parameters for payments with Alipay Spot Payment
The following table gives the parameters with which Cockpit responds:
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by Pay-Jet |
PayID | an32 | M | ID assigned by Cockpit 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 Cockpit |
TransID | ans..64 | M | Merchant’s transaction 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 Cockpit Response Codes (A4 Error codes) |
UserData | ans..1024 | O | If specified at request, Cockpit forwards the parameter with the payment result to the shop |
RefNr | ns..30 | O | Unique reference number |
ErrorText | ans..48 | O | Error text from the downstream system, only when its response is discussed with Pay-Jet Support (configured in MAT). |
TID | ans..64 | O | TransactionID generated by Alipay system |
Response parameters from Alipay Spot Payment
Calling the interface for a payment with Alipay QR Code Payment
In order to execute a payment with Alipay QR Code Payment via server-to-server communication, please use the following URL:
https://www.payjet-cockpit.de/alipayQRCode.aspx |
Notice: For security reasons, Cockpit 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 Pay-Jet. 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 Pay-Jet Support, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency, three digits DIN / ISO 4217 For merchants in China (inland) only CNY is permitted; CNY is not permitted for cross-border merchants. |
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, Cockpit forwards the parameter with the payment result to the shop |
URLNotify | ans..256 | O | Complete URL which Cockpit 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. It overrides merchant configuration (“NotifyURL” in MAT). |
Parameters for payments with Alipay QR Code Payment
The following table describes the result parameters, which the Cockpit sends back as response in a server-to-server connection, of a pre-ordering of QR Code that will be scanned by the client later. If you have specified the Response=encrypt parameter, the following parameters are forwarded Blowfish encrypted to your system:
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by Pay-Jet |
PayID | an32 | M | ID assigned by Cockpit 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 Cockpit |
TransID | ans..64 | M | Merchant’s transaction 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 Cockpit Response Codes (A4 Error codes) |
UserData | ans..1024 | O | If specified at request, Cockpit forwards the parameter with the payment result to the shop |
RefNr | ns..30 | O | Unique reference number |
ErrorText | ans..48 | O | Error text from the downstream system, only when its response is discussed with Pay-Jet Support (configured in MAT). |
QRCodeURL | ans..128 | O | If request processed successfully, QR Code Url will be returned, which can be converted to QR Code |
Parameters of synchronous response from Alipay QR Code Payment - Pre-ordering of QR Code
The following table describes the result parameters, which the Cockpit transmits to your URLNotify when asynchronous notification from Alipay has arrived, of the payment execution. If you have specified the Response=encrypt parameter, the following parameters are forwarded Blowfish encrypted to your system:
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by Pay-Jet |
PayID | an32 | M | ID assigned by Cockpit 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 Cockpit |
TransID | ans..64 | M | Merchant’s transaction 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 Cockpit Response Codes (A4 Error codes) |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
UserData | ans..1024 | O | If specified at request, Cockpit forwards the parameter with the payment result to the shop |
RefNr | ns..30 | O | Unique reference number |
ErrorText | ans..48 | O | Error text from the downstream system, only when its response is discussed with Pay-Jet Support (configured in MAT). |
TID | ans..64 | O | TransactionID generated by Alipay system |
Calling the interface for a payment with Alipay In-App Payment
In order to execute a payment with Alipay In-App Payment via server-to-server communication, please use the following URL:
https://www.payjet-cockpit.de/alipayApp.aspx |
Notice: For security reasons, Cockpit 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 Pay-Jet. 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 Pay-Jet Support, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency, three digits DIN / ISO 4217 For merchants in China (inland) only CNY is permitted; CNY is not permitted for cross-border merchants. |
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..400 | M | Description of purchased goods and their quantity in the format goods_name1;quantity1+goods_name2;quantity2. <;> separates goods and quantity within one goods data record Example: iPhone X;1+iPhone 8;2 The special characters “#”, “&” and “%” are not permitted here. |
| ShopURL | an..128 | M | URL of web shop, for example https://testmerchant.com |
UserData | ans..1024 | O | If specified at request, Cockpit forwards the parameter with the payment result to the shop |
URLNotify | ans..256 | O | Complete URL which Cockpit 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. It overrides merchant configuration (“NotifyURL” in MAT). |
| FxCurrency | ans.. | OC | Currency for settlement. Three digits DIN / ISO 4217. Only allowed for Crossborder merchants, obligatory if Currency=CNY. CNY is not allowed here. |
Parameters for payments with Alipay In-App Payment
The following table describes the result parameters, which the Cockpit sends back as response in a server-to-server connection, to a request of request string for calling the API of In-App Payment. If you have specified the Response=encrypt parameter, the following parameters are forwarded Blowfish encrypted to your system:
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by Pay-Jet |
PayID | an32 | M | ID assigned by Cockpit 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 Cockpit |
TransID | ans..64 | M | Merchant’s transaction 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 Cockpit Response Codes (A4 Error codes) |
UserData | ans..1024 | O | If specified at request, Cockpit forwards the parameter with the payment result to the shop |
RefNr | ns..30 | O | Unique reference number |
RequestString | ans..128 | O | If request is processed successfully, request string to call Alipay API In-App Payment will be returned |
Parameters of synchronous response from Alipay In App Payment – Assembling of request string to API call
The following table describes the result parameters, which the Cockpit transmits to your URLNotify when asynchronous notification from Alipay has arrived, of the payment execution. If you have specified the Response=encrypt parameter, the following parameters are forwarded Blowfish encrypted to your system:
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by Pay-Jet |
PayID | an32 | M | ID assigned by Cockpit 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 Cockpit |
TransID | ans..64 | M | Merchant’s transaction 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 Cockpit Response Codes (A4 Error codes) |
UserData | ans..1024 | O | If specified at request, Cockpit forwards the parameter with the payment result to the shop |
RefNr | ns..30 | O | Unique reference number |
ErrorText | ans..48 | O | Error text from the downstream system, only when its response is discussed with Pay-Jet Support (configured in MAT). |
TID | ans..64 | O | TransactionID generated by Alipay system |
Parameters of asynchronous response from Alipay In-App Payment – Payment execution
Reversal
Reversals of a payment with Alipay Spot Payment or QR Code payment are possible via a Server-to-Server connection. The Cockpit permits reversals that reference a capture or authorisation previously made via Cockpit. If you reference a payment in a cancellation, the whole payment is cancelled. A cancellation is only possible with Alipay before the daily reconciliation.
Cancellations are not available for Alipay online payments via alipay.aspx or alipayApp.aspx.
To carry out a Reversal for Alipay Spot Payment or QR Code payment via a Server-to-Server connection please use the following URL:
https://www.payjet-cockpit.de/reverse.aspx |
Notice: For security reasons, Cockpit rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.
The following table describes the encrypted reversal parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by Pay-Jet. Additionally this parameter has to be passed in plain language too. |
PayID | an32 | M | ID assigned by Cockpit 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 Pay-Jet Support, 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, Cockpit 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, Cockpit will not carry out the payment, but will just return the status of the original transaction. Please note that the Cockpit must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
Parameters for reversal of Alipay Spot Payment or QR Code payment
The following table describes the Cockpit response parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by Pay-Jet |
PayID | an32 | M | ID assigned by Cockpit 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 Cockpit |
TransID | ans..64 | 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 Cockpit Response Codes (A4 Error codes) |
RefNr | ns..30 | O | Merchant’s unique reference number |
UserData | ans..256 | O | If specified at request, Cockpit forwards the parameter with the payment result to the shop |
ErrorText | ans..48 | O | Error text from the downstream system, only when its response is discussed with Pay-Jet Support (configured in MAT). |
Response parameters for reversal of Alipay Spot Payment or QR Code payment
Credit with reference
Credits for a payment with all Alipay payment scenarios can be made via server-to-server communication. Cockpit permits credits that reference on a capture previously made via Cockpit. The amount of the credit is limited to the amount of the previous payment.
To carry out a credit with a reference transaction, please use the following URL:
https://www.payjet-cockpit.de/ credit.aspx |
Notice: For security reasons, Cockpit rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.
The following table describes the encrypted credit request parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by Pay-Jet. Additionally this parameter has to be passed in plain language too. |
PayID | an32 | M | ID assigned by Cockpit for the payment to be credited |
TransID | ans..64 | M | ID assigned by Merchant for the payment process to be credited |
RefNr | ans..30 | O | Merchant’s unique reference number |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the Pay-Jet Support, 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, Cockpit 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, Cockpit will not carry out the payment, but will just return the status of the original transaction. Please note that the Cockpit must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
Parameters for credits of Alipay payments
The following table describes the Cockpit response parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by Pay-Jet |
PayID | an32 | M | ID assigned by Cockpit 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 Cockpit |
TransID | ans..64 | 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 Cockpit Response Codes (A4 Error codes) |
UserData | ans..256 | O | If specified at request, Cockpit forwards the parameter with the payment result to the shop |
RefNr | ns..30 | O | Merchant’s unique reference number |
ErrorText | ans..48 | O | Error text from the downstream system, only when its response is discussed with Pay-Jet Support (configured in MAT). |
Result parameters for credits of Alipay payments
Status request for Alipay Spot Payment
Status requests are only for payments with Alipay Spot Payment and is possible via a Server-to-Server connection. Cockpit permits status requests that reference a payment previously made via Cockpit. A status request is needed as soon as the value AUTHORIZE_REQUEST has been received in response to the deposit of a payment. In this case the customer needs to confirm the payment by entering their password again with the app.
To carry out a status request with a reference transaction, please use the following URL:
https://www.payjet-cockpit.de/inquireExt.aspx |
Notice: For security reasons, Cockpit 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 Pay-Jet. Additionally this parameter has to be passed in plain language too. |
PayID | an32 | M | ID assigned by Cockpit for the payment to be credited |
TransID | ans..64 | M | TransactionID which should be unique for each payment |
RefNr | ans..30 | O | Reference number (e.g. invoice number) which must be unique for each return shipment |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the Pay-Jet Support, 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, Cockpit forwards the parameter with the payment result to the shop |
Parameters for status requests of Alipay Spot Payment
The following table describes the Cockpit response parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by Pay-Jet |
PayID | an32 | M | ID assigned by Cockpit 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 Cockpit |
TransID | ans..64 | M | Merchant’s transaction number |
Status | a..50 | M | OK, FAILED or AUTHORIZE_REQUEST (If no final status from Alipay exists. The customer may need to confirm the payment in the Alipay-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 Cockpit Response Codes (A4 Error codes) |
UserData | ans..256 | O | If specified at request, Cockpit forwards the parameter with the payment result to the shop |
RefNr | ns..30 | O | Merchant’s unique reference number |
ErrorText | ans..48 | O | Error text from the downstream system, only when its response is discussed with Pay-Jet Support (configured in MAT). |
Response parameters for status requests of Alipay Spot Payment
Batch processing via the interface
Basic information about using Batch files and about their structure can be found in the Batch Manager manual. Within batch processing not alle functions are available which are usually available for the online interface.
This section describes the parameters which must be transferred within the data set (Record) for executing an Alipay payment and information can be found within the response file about the payment status.
Following table gives an overview of all batch versions that are possible for a specific action an their specialities:
Action | Version | Description |
|---|---|---|
Credit | 1.0 / 2.0 | Standard version without return of parameter Code |
| 1.x / 2.x | with RefNr (valid for all versions other than 1.0) |
Reverse | 1.0 / 2.0 | Standard version without return of parameter Code |
| 1.x / 2x. | with RefNr (valid for all versions other than 1.0) |
Description of the possible batch versions
The structure for an Alipay payment within a Batch file to be submitted is as follows:
HEAD,<MerchantID>,<Date>,<Version> Alipay,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> Alipay,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> FOOT,<CountRecords>,<SumAmount> |
Example for Master MID Funktion:
| HEAD,[Master]MerchantID,Date,2.x Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action) FOOT,CountRecords,SumAmount |
The following table describes the individual fields and values used within the data set (record) in the batch file:
Parameter | Format | CND | Description |
|---|---|---|---|
Type | a..11 | M | HEAD for Header, FOOT for Footer, Alipay for Alipay |
Action | a..20 | M | The parameter Action defines the type of transaction: Credit Reverse (cancellation) |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the Pay-Jet Support, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency code, three digits DIN / ISO 4217 |
TransID | ans..64 | M | TransactionID which should be unique for each payment |
RefNr | ns..30 | O | Unique reference number |
PayID | an32 | M | ID for this transaction given by Cockpit |
Description of fields within the record for Batch files
The record area within the response file for Batch transactions looks as follows:
HEAD,<MerchantID>,<Date>,<Version> Alipay,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> Alipay,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> FOOT,<CountRecords>,<SumAmount> |
The following table describes the response parameters which the Batch Manager saves in the Record area for each transaction (standard parameters not explained here, such as <TransID> or <RefNR> and request parameters are returned unchanged and correspond to the call as specified before):
Parameter | Format | CND | Description |
|---|---|---|---|
Action | a..20 | M | The parameter Action defines the type of transaction: Credit Reverse |
PayID | an32 | M | ID for this transaction given by Cockpit |
Status | a..50 | M | OK or FAILED |
Code | n8 | M | Error code according to Cockpit Response Codes (A4 Error codes) |
Description of result parameters within the record for Batch files