| Table of Contents |
|---|
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.
| Page properties | ||||||
|---|---|---|---|---|---|---|
|
Further information you will find also on the webpage of Alipay (https://www.alipayplus.com/)
Process flow chart
| Multiexcerpt | ||
|---|---|---|
| ||
|
Alipay+ Cashier Payment process flow
Paygate interface
| Multiexcerpt include | ||||||
|---|---|---|---|---|---|---|
|
Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Definition PageWithExcerpt Definition EN
Calling the interface for an Alipay+ Cashier payment
Cancellations and credits are available for Alipay payments as described in the sections below.
In order to process an Alipay+ Cashier Payment via a form, please use the following URL:
|
Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Request_Intro PageWithExcerpt Reuse API
| Table Filter | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Definitions
Data formats
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
CND
condition
M
mandatory
O
optional
C
conditional
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
MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.
ans..64
RefNr
ns..30
O
Unique reference number for your accounts
n..10
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.
an64
OrderDesc
ans..768
M
Name of the goods purchased. The special characters “#”, “&”, “%” and “+” are not permitted here.
ans..256
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:
- We recommend to use parameter "response=encrypted" 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.
ans..256
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:
- We recommend to use parameter "response=encrypted" 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.
a7
Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.
ans..256
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:
- We recommend to use parameter "response=encrypted" 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.
ans..1024
If specified at request, Paygate forwards the parameter with the payment result to the shop.
ans..32
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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
ans..50
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.
ans..1024
"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
ans..30
MerchantID, assigned by Computop
an32
ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.
an32
ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate
ans..64
a..50
OK or AUTHORIZE_REQUEST (URLSuccess) as well as FAILED (URLFailure)
ans..1024
n8
Error code according to Paygate Response Codes (A4 Error codes)
RefNr
ns..30
O
Merchant's unique reference number
an64
ans..1024
If specified at request, Paygate forwards the parameter with the payment result to the shop.
ans..50
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.
ans..1024
"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:
ans..30
MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.
an32
ID assigned by Paygate for the payment to be reversed
ans..64
RefNr
ns..30
O
Merchant's unique reference number
n..10
Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).
a3
Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table EN
an64
ans..1024
If specified at request, Paygate forwards the parameter with the payment result to the shop.
ans..32
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
|
Parameters for payments with Alipay+ Cashier Payment
Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Response_IntroURL PageWithExcerpt Reuse API
| Table Filter | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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
permits reversals that reference an authorisation previously made via Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Platform-Kurz PageWithExcerpt Wording
. If you reference a payment in a cancellation, the whole payment is cancelled. A cancellation is only possible with Alipay before the daily reconciliation.Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Platform-Kurz PageWithExcerpt Wording
To carry out a reversal for an Alipay+ Cashier Payment via a Server-to-Server connection, please use the following URL:
|
Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Request_Intro PageWithExcerpt Reuse API
| Table Filter | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Parameters for reversal of Alipay+ Cashier Payment
Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Response_Intro PageWithExcerpt Reuse API
| Table Filter | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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.
permits credits that reference on a capture, previously made via Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Platform-Kurz PageWithExcerpt Wording
. The amount of the credit is limited to the amount of the previous payment. Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Platform-Kurz PageWithExcerpt Wording
To carry out a credit with a reference transaction, please use the following URL:
|
Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Request_Intro PageWithExcerpt Reuse API
| Table Filter | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Parameters for credits of Alipay+ payments
Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Response_Intro PageWithExcerpt Reuse API
| Table Filter | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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.
permits status requests that reference a payment previously made via Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Platform-Kurz PageWithExcerpt Wording
.Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Platform-Kurz PageWithExcerpt Wording
To carry out a status request with a reference transaction, please use the following URL:
|
Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Request_Intro PageWithExcerpt Reuse API
| Table Filter | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Parameters for status requests of Alipay+ Cashier Payment
Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Response_Intro PageWithExcerpt Reuse API
| Table Filter | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
the key (e.g. MerchantId, RefNr) should not be checked case-sentive
ans..30
MerchantID, assigned by Computop
an32
ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.
an32
ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate
ans..64
a..50
OK (URLSuccess) or FAILED (URLFailure)
ans..1024
n8
Error code according to Paygate Response Codes (A4 Error codes)
ans..1024
If specified at request, Paygate forwards the parameter with the payment result to the shop.
RefNr
ns..30
O
Merchant's unique reference number
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:
ans..30
MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.
an32
ID assigned by Paygate for the payment to be credited
ans..64
RefNr
ns..30
O
Merchant's unique reference number
n..10
Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).
a3
Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table EN
an64
ans..1024
If specified at request, Paygate forwards the parameter with the payment result to the shop.
ans..32
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
ans..30
MerchantID, assigned by Computop
an32
ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.
an32
ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate
ans..64
a..50
OK (URLSuccess) or FAILED (URLFailure)
ans..1024
n8
Error code according to Paygate Response Codes (A4 Error codes)
ans..1024
If specified at request, Paygate forwards the parameter with the payment result to the shop.
RefNr
ns..30
O
Merchant's unique reference number
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:
ans..30
MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.
an32
ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.
an64
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
ans..30
MerchantID, assigned by Computop
an32
ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.
an32
ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate
ans..64
|
|
|
ans..1024
n8
Error code according to Paygate Response Codes (A4 Error codes)
ans..1024
If specified at request, Paygate forwards the parameter with the payment result to the shop.
RefNr
ns..30
O
|
|
Response parameters for status requests of Alipay+ Cashier Payment