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 Computop Paygate. 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 Computop Paygate, 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 Computop Paygate. 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.

TypePayments 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


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 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 Computop Paygate form:

 

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:

KeyFormatCNDDescription

MerchantID

ans..30

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Amountn..10M

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

Key

Format

CND

Description

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. Please find an overview here: A1 Currency table EN

KeyFormatCNDDescription

MAC

an64

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

Key

Format

CND

Description

OrderDesc

ans..768

M

Name of the goods purchased. The special characters “#”, “&”, “%” and “+” are not permitted here.

OrderDesc2ans..400M

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
<+> separates multiple goods data records

Example: iPhone X;1+iPhone 8;2

The special characters “#”, “&” and “%” are not permitted here.

ShopURLan..128MURL of web shop, for example https://testmerchant.com

KeyFormatCNDDescription
URLSuccess

ans..256

M

Complete URL which calls up Paygate 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 Paygate and shop, please use the parameter UserData.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

KeyFormatCNDDescription
URLFailure

ans..256

M

Complete URL which calls up Paygate 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 Paygate and shop, please use the parameter UserData.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

KeyFormatCNDDescription
Response

a7

O

Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.

KeyFormatCNDDescription
URLNotify

ans..256

M

Complete URL which Paygate 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.

(info) Common notes:

  • Before follow-up actions (capture / credit / reversal) are carried out on an existing transaction, the first Notify must have been answered by the shop.
  • Fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

KeyFormatCNDDescription
UserData

ans..1024

O

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

KeyFormatCNDDescription
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

Key

Format

CND

Description

Timeoutans..3O

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 Computop Helpdesk.

CustomerIDans..16Ounique customer number
AccBankans..7OC

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

-     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

Devicea6OWhen submitting “Mobile” the mobile version of Alipay is called instead of the desktop version
FxCurrencya3OC

Currency for settlement. Three digits DIN / ISO 4217.

Only allowed for Crossborder merchants, obligatory if Currency=CNY CNY is not allowed here.

KeyFormatCNDDescription
Plain

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. 

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. 

KeyFormatCND

Description

Custom
ans..1024


O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose.

Parameters for payments with Alipay Website payment


The following table gives the result parameters which Computop Paygate transmits to URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted 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. mid, RefNr) should not be checked case-sentive

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

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

KeyFormatCNDDescription
XID

an32

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
Status

a..50

M

OK or AUTHORIZE_REQUEST (URLSuccess) as well as FAILED (URLFailure)

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription

MAC

an64

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

KeyFormatCNDDescription
UserData

ans..1024

O

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

KeyFormatCNDDescription
Plain

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. 

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. 

KeyFormatCND

Description

Custom
ans..1024


O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose.

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:

 

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:

KeyFormatCNDDescription

MerchantID

ans..30

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Amountn..10M

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

Key

Format

CND

Description

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. Please find an overview here: A1 Currency table EN

KeyFormatCNDDescription

MAC

an64

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

Key

Format

CND

Description

OrderDesc

ans..256

M

Name of the transaction which is displayed in the transactions list

OrderDesc2ans..256OTransaction notice

KeyFormatCNDDescription
UserData

ans..1024

O

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

Key

Format

CND

Description

BuyerIDCodeans..32MCode generated by the Alipay-App. It is designed for the identification of a user.
Parameters for payments with Alipay Spot 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. mid, RefNr) should not be checked case-sentive

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

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

KeyFormatCNDDescription
XID

an32

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

Key

Format

CND

Description

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

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
UserData

ans..1024

O

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

Key

Format

CND

Description

ErrorText

ans..48

O

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

TIDans..64OTransactionID 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:

 

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:

KeyFormatCNDDescription

MerchantID

ans..30

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Amountn..10M

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

Key

Format

CND

Description

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. Please find an overview here: A1 Currency table EN

KeyFormatCNDDescription

MAC

an64

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

Key

Format

CND

Description

OrderDesc

ans..256

M

Name of the transaction which is displayed in the transactions list

OrderDesc2ans..256OTransaction notice

KeyFormatCNDDescription
UserData

ans..1024

O

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

KeyFormatCNDDescription
URLNotify

ans..256

M

Complete URL which Paygate 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.

(info) Common notes:

  • Before follow-up actions (capture / credit / reversal) are carried out on an existing transaction, the first Notify must have been answered by the shop.
  • Fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Parameters for payments with Alipay QR Code Payment


The following table describes the result parameters, which the Paygate 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:

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

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

KeyFormatCNDDescription
XID

an32

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

Key

Format

CND

Description

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

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
UserData

ans..1024

O

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

Key

Format

CND

Description

ErrorText

ans..48

O

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

QRCodeURLans..128OIf 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 Paygate 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:

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

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

KeyFormatCNDDescription
XID

an32

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

Key

Format

CND

Description

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

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
UserData

ans..1024

O

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

KeyFormatCNDDescription

MAC

an64

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

Key

Format

CND

Description

ErrorText

ans..48

O

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

TIDans..64OTransactionID generated by Alipay system

Parameters of asynchronous response from Alipay QR Code Payment – payment execution


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:

 

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:

KeyFormatCNDDescription

MerchantID

ans..30

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Amountn..10M

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

Key

Format

CND

Description

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. Please find an overview here: A1 Currency table EN

KeyFormatCNDDescription

MAC

an64

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

Key

Format

CND

Description

OrderDesc

ans..256

M

Name of the transaction which is displayed in the transactions list

OrderDesc2ans..400M

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
<+> separates multiple goods data records

Example: iPhone X;1+iPhone 8;2

The special characters “#”, “&” and “%” are not permitted here.

ShopURLan..128MURL of web shop, for example https://testmerchant.com

KeyFormatCNDDescription
UserData

ans..1024

O

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

KeyFormatCNDDescription
URLNotify

ans..256

M

Complete URL which Paygate 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.

(info) Common notes:

  • Before follow-up actions (capture / credit / reversal) are carried out on an existing transaction, the first Notify must have been answered by the shop.
  • Fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Key

Format

CND

Description

FxCurrency

a3

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 Paygate 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:

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

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

KeyFormatCNDDescription
XID

an32

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

Key

Format

CND

Description

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

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
UserData

ans..1024

O

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

Key

Format

CND

Description

RequestStringans..128OIf 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 Paygate 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:

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

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

KeyFormatCNDDescription
XID

an32

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

Key

Format

CND

Description

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

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
UserData

ans..1024

O

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

Key

Format

CND

Description

ErrorText

ans..48

O

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

TIDans..64OTransactionID 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 Paygate permits reversals that reference a capture or authorisation previously made via Paygate. 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:

 

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:

KeyFormatCNDDescription

MerchantID

ans..30

M

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

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for the payment to be reversed

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Amountn..10M

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

KeyFormatCNDDescription
Currency

a3

M

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

KeyFormatCNDDescription

MAC

an64

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

KeyFormatCNDDescription
UserData

ans..1024

O

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

KeyFormatCNDDescription
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

Parameters for reversal of Alipay Spot Payment or QR Code 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. mid, RefNr) should not be checked case-sentive

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

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

KeyFormatCNDDescription
XID

an32

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription
UserData

ans..1024

O

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

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

Key

Format

CND

Description

ErrorTextans..48O

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

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. Paygate permits credits that reference on a capture previously made via Paygate. 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:

 

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:

KeyFormatCNDDescription

MerchantID

ans..30

M

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

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for the payment to be credited

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Amountn..10M

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

KeyFormatCNDDescription
Currency

a3

M

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

KeyFormatCNDDescription

MAC

an64

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

KeyFormatCNDDescription
UserData

ans..1024

O

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

KeyFormatCNDDescription
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

Parameters for credits of Alipay payments


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. mid, RefNr) should not be checked case-sentive

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

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

KeyFormatCNDDescription
XID

an32

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription
UserData

ans..1024

O

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

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

Key

Format

CND

Description

ErrorTextans..48O

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

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. Paygate permits status requests that reference a payment previously made via Paygate. 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:

 

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:

KeyFormatCNDDescription

MerchantID

ans..30

M

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

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Amountn..10M

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

KeyFormatCNDDescription
Currency

a3

M

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

KeyFormatCNDDescription

MAC

an64

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

KeyFormatCNDDescription
UserData

ans..1024

O

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

Parameters for status requests of Alipay Spot 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. mid, RefNr) should not be checked case-sentive

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

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

KeyFormatCNDDescription
XID

an32

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

Key

Format

CND

Description

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

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription
UserData

ans..1024

O

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

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

Key

Format

CND

Description

ErrorTextans..48O

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

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 / 2.x

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 function:

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:

Key

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)

KeyFormatCNDDescription
Amountn..10M

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

KeyFormatCNDDescription
Currency

a3

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for this transaction

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

Key

Format

CND

Description

Action

a..20

M

The parameter Action defines the type of transaction:

Credit

Reverse (cancellation)

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for this transaction

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
Code

an8

M

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

Description of result parameters within the record for Batch files