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 cross-border transactions (CrossBorder) to foreign merchants, which are directly billed in one of the supported currencies.
With Alipay+ Cashier Payment, the merchant redirects the user to the page of a Mobile Payment Partner (normally, a digital wallet) to confirm the payment. Alipay+ Cashier Payment allows merchants to quickly collect online payments from the user's digital wallet account. In addition, the payment is safe as the user is prompted to complete authentication before confirming a payment.
Benefits
Secure payment
User's authorization is required for every transaction. With built-in security mechanism and rule-based risk management, each transaction is highly secured and executed hassle free.
Highly scalable
Alipay+ helps establish business connections among different Partners, therefore, both Acquirer and Mobile Payment Partner can quickly scale up businesses around the world.
Easy integration
Rapidly build production-ready integrations with APIs. In addition, limited integration costs are needed to add new wallets to expand your business in the future.
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://www.alipayplus.com/)
Process flow chart
Alipay+ Cashier 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 for an Alipay+ Cashier payment
Cancellations and credits are available for Alipay payments as described in the sections below.
Enter the following URL to process an Alipay+ Cashier payment via the Computop Paygate form:
https://www.computop-paygate.com/alipay.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. | |
TransID | ans..64 | M | TransactionID provided by you 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 Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). |
Currency | a3 | M | Currency, three digits DIN / ISO 4217. |
countryCode | ans..2 | C | ISO 3166 country/region code. Required when there is a specfic user region display priority for the returned wallets |
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
OrderDesc | ans..768 | M | Name of the goods purchased. The special characters “#”, “&”, “%” and “+” are not permitted here. |
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. Common notes:
|
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. Common notes:
|
Response | a7 | O | Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter. |
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. Common notes:
|
UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. |
ReqId | ans..32 | O | To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / 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 / action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
CustomerID | ans..64 | O | unique customer number |
Device | ans..8 | C | Options: Desktop, Mobile, APP, MINI_APP. Default is desktop when this parameter is not sent |
osType | ans..6 | C | Options : IOS, ANDROID - Mandatory if the Device parameter is Mobile, APP or MINI-APP |
FxCurrency | a3 | M | Currency for settlement. Three digits DIN / ISO 4217. |
Shipping Address | |||
sdFirstName / sdLastName | ans..128 | O | User's name |
sdcountryCode | ans..2 | O | The two-character ISO 3166 country/region code |
sdState | ans..8 | O | State, country, or province |
sdCity | ans..32 | O | City, district, suburb, town, or village |
sdStreet | ans..254 | O | Address line such as street, PO Box, or company name. |
sdStreet2 | ans..256 | O | Address line 2 (such as apartment, suite, unit, or building) |
sdZip | ans32 | O | ZIP or postal code |
Key | Format | CND | Description |
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. |
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. Please find a samples here: Custom |
Parameters for payments with Alipay+ Cashier 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:
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 | |
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. |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
Status | a..50 | M | OK or AUTHORIZE_REQUEST (URLSuccess) as well as FAILED (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 Paygate Response Codes (A4 Error codes) |
RefNr | ns..30 | O | Merchant's unique reference number |
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. |
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. |
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. Please find a samples here: Custom |
Result parameters for URLNotify, URLSuccess and URLFailure in case of Alipay+ Cashier payment
Reversal
Reversals of a payment with Alipay+ Cashier Payment are possible via a Server-to-Server connection. The Paygate permits reversals that reference an 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.
To carry out a Reversal for Alipay+ Cashier Payment via a Server-to-Server connection please use the following URL:
https://www.computop-paygate.com/reverse.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. | |
PayID | an32 | M | ID assigned by Paygate for the payment to be reversed |
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ns..30 | O | Merchant's unique reference number |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). |
Currency | a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table EN |
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. |
ReqId | ans..32 | O | To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / 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 / action. Please note that the Computop Paygate 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+ Cashier 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 | |
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. |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
Status | a..50 | M | OK (URLSuccess) or FAILED (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 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. |
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 Computop Helpdesk (configured in MAT). |
Response parameters for reversal of Alipay+ Cashier Payment
Credit with Reference
Credits for a payment with Alipay+ payments 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:
https://www.computop-paygate.com/credit.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. | |
PayID | an32 | M | ID assigned by Paygate for the payment to be credited |
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ns..30 | O | Merchant's unique reference number |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). |
Currency | a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table EN |
Reason | ans..256 | O | Reason for the refund |
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. |
ReqId | ans..32 | O | To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / 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 / action. Please note that the Computop Paygate 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 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 | |
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. |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
Status | a..50 | M | OK (URLSuccess) or FAILED (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 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. |
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 Computop Helpdesk (configured in MAT). |
Result parameters for credits of Alipay+ payments
Status request for Alipay+
Status requests for payments with Alipay+ Cashier Payment are possible via a Server-to-Server connection. Paygate permits status requests that reference a payment previously made via Paygate.
To carry out a status request with a reference transaction, please use the following URL:
https://www.computop-paygate.com/inquire.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. | |
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. |
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Parameters for status requests of Alipay+ Cashier 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 | |
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. |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
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. |
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 Computop Helpdesk (configured in MAT). |
Response parameters for status requests of Alipay+ Cashier Payment