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 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 Payment platform. Alipay Spot Payment is available only for cross-border partners.
| 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. |
Further information you will find also on the webpage of Alipay (https://intl.alipay.com/).
Process flow charts
Alipay process flow
Payment platform interface
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 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
Payment with Alipay over Payment platform form interface
To make an Alipay payment via PPRO over a Payment platform form, go to the following URL:
Notice: For security reasons, Payment platform 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. Additionally this parameter has to be passed in plain language too. | |
TransID | ans..64 | M | Merchant transaction number, which must be unique | |
RefNr | ans..40 | O | Unique reference number. Only characters a-zA-Z0-9,-_ are allowed. | |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). | |
Currency | a3 | M | Currency, three digits DIN / ISO 4217. Only EUR, GBP, USD allowed. | |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm | |
OrderDesc | ans..768 | M | Description of delivered products, services etc. | |
URLSuccess | ans..256 | M | Complete URL which calls up Payment platform 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 Payment platform and shop, please use the parameter UserData. | |
URLFailure | ans..256 | M | Complete URL which calls up Payment platform 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 Payment platform and shop, please use the parameter UserData. | |
Response | a7 | O | Status response sent by Payment platform to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter. | |
URLNotify | ans..256 | M | Complete URL which Payment platform 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. | |
UserData | ans..1024 | O | If specified at request, Payment platform 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, the payment platform will not carry out the payment, but will just return the status of the original transaction. Please note that the payment platform must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. | |
SellingPoint | ans..50 | O | Selling point | |
Service | ans..50 | O | Products or service sold | |
Channel | ans..64 | O | Configuration channel of the PPRO contract (account and ContractID are stored in the system). If it exists, it may overwrite channels stored in the system. | |
| Language | a2 | O | 2-letter language code (e.g.. de) that should be preferred when presenting payment pages to the consumer | |
AccOwner | ans..50 | M | Name of account holder | |
Device | a6 | O | When submitting “Mobile” the mobile version of Alipay is called instead of the desktop version | |
AddrCountryCode | a2 | O | Country code for the account holder’s invoicing address, 2 characters according to ISO 3166. Only CN allowed, defined within the code. | |
| HotelName | ans..128 | C | Name of the hotel for which the reservation is for. Mandatory in case the merchant’s business type is Hotel. | |
| CheckInTime | ans..128 | C | Date of the check-in expressed in GMT+8, in format: YYYY-MM-DD. Mandatory in case the merchant’s business type is Hotel. Example: 2020-01-22 In case of multiple entries, they should be separated by a ‘|’ . Example: 2020-01-22|020-02-10 | |
| CheckOutTime | ans..128 | C | Date of the check-out expressed in GMT+8, in format: YYYY-MM-DD. Mandatory in case the merchant’s business type is Hotel. Example: 2020-01-25 In case of multiple entries, they should be separated by a ‘|’’. Example: 2020-01-25|2020-02-14 | |
| OrderDesc2 | ans..400 | C | Base64 encoded JSON object with description of purchased products and their quantity | |
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
The following table describes the result parameters that the Payment platform transmits to your URLSuccess, URLFailure or URLNotify. 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 |
PayID | an32 | M | ID assigned by Payment platform for the payment, e.g. for referencing in batch files. |
XID | an32 | M | ID for all single transactions for one payment assigned by Payment platform |
TransID | ans..64 | M | Merchant’s transaction number |
RefNr | ans..40 | O | Merchant’s unique reference number. Only characters a-zA-Z0-9,-_ are allowed. |
Status | a..30 | M | OK in the case of URLSuccess and AUTHORIZE_REQUEST or FAILED in the case of 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 Payment platform Response Codes Excel file |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
UserData | ans..1024 | O | If specified at request, Payment platform forwards the parameter with the payment result to the shop |
PaymentPurpose | ans..26 | M | Purpose of payment |
PaymentGuarantee | a..12 | C | NONE = no payment guarantee, VALIDATED= customer account valid, but no payment guarantee, FULL= payment guarantee Notice: This parameter is only returned if the Status=OK. |
ErrorText | ans..256 | C | Detailed PPRO error message. Notice: Is returned only if Status=FAILED. Use is possible only in agreement with support. |
TransactionID | an..20 | O | Unique transaction number with PPRO |
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 |
Return parameters for URLSuccess, URLFailure and URLNotify with Alipay
Credit with reference
Credits (refunds) are possible via a Server-to-Server connection. For a Credit with reference to a capture the amount of the Credit is limited to the amount of the previous capture.
To carry out a credit with a reference transaction, please use the following URL:
Notice: For security reasons, Payment platform 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. Additionally this parameter has to be passed in plain language too. |
PayID | an32 | M | ID assigned by Payment platform for the payment to be credited |
TransID | ans..64 | M | TransactionID which should be unique for each payment |
RefNr | ans..40 | O | Merchant’s unique reference number. Only characters a-zA-Z0-9,-_ are allowed. |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | 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, Payment platform 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, the payment platform will not carry out the payment, but will just return the status of the original transaction. Please note that the payment platform 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 credit payments with Alipay via socket connection
The following table describes the Payment platform response parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | MerchantID |
PayID | an32 | M | ID assigned by Payment platform 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 Payment platform |
TransID | ans..64 | M | Merchant’s transaction number |
Status | a..30 | 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 Payment platform Response Codes Excel file |
UserData | ans..256 | O | If specified at request, Payment platform forwards the parameter with the payment result to the shop |
RefNr | ans..40 | O | Merchant’s unique reference number. Only characters a-zA-Z0-9,-_ are allowed. |
ErrorText | ans..256 | O | Detailed PPRO error message |
Response parameters for credit payments with Alipay via socket connection
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 credits with Alipay, which 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 and 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) |
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> 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 |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency code, three digits DIN / ISO 4217 |
TransID | ans..64 | M | TransactionID which should be unique for each payment |
RefNr | ans..40 | O | Unique reference number. Only characters a-zA-Z0-9,-_ are allowed. |
PayID | an32 | M | ID for this transaction given by Payment platform |
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> 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 |
PayID | an32 | M | ID for this transaction given by Payment platform |
Status | a..50 | M | OK or FAILED |
Code | n8 | M | Error code according to Payment platform Response Codes Excel file |
Description of result parameters within the record for Batch files
JSON object OrderDesc2
Scheme
{
"$schema": "http://json-schema.org/draft-06/schema#",
"type": "array",
"items": {
"$ref": "#/definitions/GoodsInfoElement"
},
"definitions": {
"GoodsInfoElement": {
"type": "object",
"additionalProperties": false,
"properties": {
"itemDescription": {
"type": "string"
},
"number": {
"type": "integer"
}
},
"required": [
"itemDescription",
"number"
],
"title": "GoodsInfoElement"
}
}
}
Example
[{
"itemDescription": "Book",
"number": 3
}, {
"itemDescription": "Movie",
"number": 2
}
]