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

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Platform-Kurz
PageWithExcerpt	Wording

. Alipay Spot Payment is available only for cross-border partners.

Page properties

Logo

Info

Excerpt
Customers and merchants can send and receive payments with the E-Wallet from China’s leading online payment system. Alipay has over 800 million registered users and in 2014 it processed over 100 million online payments per day.

Type

Payments by eWallet

Further information you will find also on the webpage of Alipay (https://intl.alipay.com/).

Process flow chart

Multiexcerpt

MultiExcerptName	ProcessFlow

draw.io Diagram

border	true
diagramName	Alipay PPRO Payment
simpleViewer	false
links	auto
tbstyle	top
lbox	true
diagramWidth	1109

Multiexcerpt include
SpaceWithExcerpt EN
MultiExcerptName Platform-Kurz
PageWithExcerpt Wording
interface

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Definition
PageWithExcerpt	Definition EN

Payment with Alipay over
Multiexcerpt include
SpaceWithExcerpt EN
MultiExcerptName Platform-Kurz
PageWithExcerpt Wording
form interface

To make an Alipay payment via PPRO over a

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Platform-Kurz
PageWithExcerpt	Wording

form, please use the following URL:

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	BaseURL
PageWithExcerpt	Wording

alipay.aspx

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Request_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1646386343950_-1541069930
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	alipay_request

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1646386343952_891909210
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MerchantID
page	MerchantID
type	page

Table Excerpt Include

static	true
name	TransID
page	TransID
type	page

Key	Format	CND	Description	Beschreibung
RefNr	ans..40	O	Merchant’s unique reference number. Only characters a-zA-Z0-9,-_ are allowed.	Eindeutige Referenznummer des Händlers. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt.

Table Excerpt Include

static	true
name	Amount
page	Amount
type	page

Key	Format	CND	Description	Beschreibung
Currency	A3	M	Currency, three digits DIN / ISO 4217. Only EUR, GBP, USD allowed. Please find an overview here: A1 Currency table EN	Währung, drei Zeichen DIN / ISO 4217. Nur EUR, GBP, USD zulässig. Hier eine Übersicht: A1 Währungstabelle

Table Excerpt Include

static	true
name	MAC
page	MAC
type	page

Key	Format	CND	Description	Beschreibung
OrderDesc	ans..768	M	Description of purchased goods, unit prices etc.	Beschreibung der gekauften Waren, Einzelpreise etc.

Table Excerpt Include

static	true
name	UserData
page	UserData
type	page

Table Excerpt Include

static	true
name	URLSuccess
page	URLSuccess
type	page

Table Excerpt Include

static	true
name	URLFailure
page	URLFailure
type	page

Table Excerpt Include

static	true
name	Response
page	Response
type	page

Table Excerpt Include

static	true
name	URLNotify
page	URLNotify
type	page

Table Excerpt Include

static	true
name	ReqId-ans..32
page	ReqId
type	page

Table Excerpt Include

static	true
name	SellingPoint
page	SellingPoint
type	page

Table Excerpt Include

static	true
name	Service
page	Service
type	page

Table Excerpt Include

static	true
name	Channel
page	Channel
type	page

Key	Format	CND	Description	Beschreibung
Language	a2	O	2-letter language code (e.g.. de) that should be preferred when presenting payment pages to the consumer	2-stelliger Sprachcode (z.B. de), der für die Zahlungsseiten für den Kunden bevorzugt werden soll
AccOwner	ans..50	M	Name of account holder	Name des Kontoinhabers
Device	a6	O	When submitting “Mobile” the mobile version of Alipay is called instead of the desktop version	Bei Übergabe von „Mobile“ wird statt der Desktop-Version die Mobil-Version von Alipay aufgerufen
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.	Ländercode der Rechnungsadresse des Kontoinhabers zweistellig gemäß ISO 3166. Nur CN zulässig, im Code festgelegt.
HotelName	ans..128	C	Name of the hotel for which the reservation is for. Mandatory in case the merchant’s business type is Hotel.	Name des Hotels, für das die Reservierung gamacht wurde. Obligatorisch, wenn die Geschäftsart des Händlers Hotel ist.
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\|2020-02-10	Datum des Eincheckens in GMT+8 im Format: JJJJ-MM-TT. Obligatorisch, wenn die Geschäftsart des Händlers Hotel ist. Beispiel: 2020-01-22 Mehrere Einträge sollten mit einem ‘\|’ getrennt werden. Beispiel: 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	Datum des Auscheckens in GMT+8 im Format: JJJJ-MM-TT. Obligatorisch, wenn die Geschäftsart des Händlers Hotel ist. Beispiel: 2020-01-25 Mehrere Einträge sollten mit einem ‘\|’ getrennt werden. Beispiel: 2020-01-25\|2020-02-14
OrderDesc2	ans..400	C	Base64 encoded JSON object with description of purchased products and their quantity	Base64-codiertes JSON-Objekt mit Beschreibung und Menge der gekauften Produkte

Table Excerpt Include

static	true
name	Plain
page	Plain
type	page

Table Excerpt Include

static	true
name	Custom
page	Custom
type	page

Parameters for payments with Alipay

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Response_IntroURL
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1646387266088_-144781558
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	alipay_response

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1646387266090_1452593712
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MID
page	mid
type	page

Table Excerpt Include

static	true
name	PayID
page	PayID
type	page

Table Excerpt Include

static	true
name	XID
page	XID
type	page

Table Excerpt Include

static	true
name	TransID
page	TransID
type	page

Table Excerpt Include

static	true
name	Status_OK_FAILED
page	Status
type	page

Table Excerpt Include

static	true
name	Description
page	Description
type	page

Table Excerpt Include

static	true
name	Code
page	Code
type	page

Key	Format	CND	Description	Beschreibung
RefNr	ans..40	O	Merchant’s unique reference number. Only characters a-zA-Z0-9,-_ are allowed.	Eindeutige Referenznummer des Händlers. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt.

Table Excerpt Include

static	true
name	UserData
page	UserData
type	page

Table Excerpt Include

static	true
name	MAC
page	MAC
type	page

Table Excerpt Include

static	true
name	PaymentPurpose
page	PaymentPurpose
type	page

Table Excerpt Include

static	true
name	PaymentGuarantee
page	PaymentGuarantee
type	page

Table Excerpt Include

static	true
name	ErrorText_PPRO
page	ErrorText
type	page

Key	Format		CND	Description	Beschreibung
TransactionID	an..20		O	Unique transaction number from PPRO	Eindeutige Transaktionsnummer bei PPRO

Table Excerpt Include

static	true
name	Plain
page	Plain
type	page

Table Excerpt Include

static	true
name	Custom
page	Custom
type	page

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.

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Credit_Intro
PageWithExcerpt	Reuse API

To carry out a credit with a reference transaction, please use the following URL:

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	BaseURL
PageWithExcerpt	Wording

credit.aspx

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Request_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1646346968740_-927424328
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	credit_request

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1646346968743_-1689162482
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MerchantID
page	MerchantID
type	page

Table Excerpt Include

static	true
name	PayID_Credit
page	PayID
type	page

Table Excerpt Include

static	true
name	TransID
page	TransID
type	page

Key	Format	CND	Description	Beschreibung
RefNr	ans..40	O	Merchant’s unique reference number. Only characters a-zA-Z0-9,-_ are allowed.	Eindeutige Referenznummer des Händlers. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt.

Table Excerpt Include

static	true
name	Amount
page	Amount
type	page

Table Excerpt Include

static	true
name	Currency
page	Currency
type	page

Table Excerpt Include

static	true
name	MAC
page	MAC
type	page

Table Excerpt Include

static	true
name	UserData_256
page	UserData
type	page

Table Excerpt Include

static	true
name	ReqId-ans..32
page	ReqId
type	page

Parameters for credit payments with Alipay via socket connection

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Response_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1646347411691_174405580
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	credit_response

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1646347411692_-1548931520
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MID
page	mid
type	page

Table Excerpt Include

static	true
name	PayID
page	PayID
type	page

Table Excerpt Include

static	true
name	XID
page	XID
type	page

Table Excerpt Include

static	true
name	TransID
page	TransID
type	page

Table Excerpt Include

static	true
name	Status_OK_FAILED
page	Status
type	page

Table Excerpt Include

static	true
name	Description
page	Description
type	page

Table Excerpt Include

static	true
name	Code
page	Code
type	page

Table Excerpt Include

static	true
name	UserData_256
page	UserData
type	page

Key	Format	CND	Description	Beschreibung
RefNr	ans..40	OC	Merchant’s unique reference number. Only characters a-zA-Z0-9,-_ are allowed.	Eindeutige Referenznummer des Händlers. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt.
ErrorText	ans..256	OC	Detailed PPRO error message	Detaillierte PPRO-Fehlermeldung

Response parameters for credit payments with Alipay via socket connection

Batch processing via the interface

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Batch_Intro
PageWithExcerpt	Reuse API

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:

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1646342947399_446920502
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	batch_versions

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1646342947401_-1124726690
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Action	Version	Description	Beschreibung
Credit	1.0 / 2.0	Standard version without return of parameter Code	Standardversion ohne Rückgabe von Parameter Code
	1.x / 2.x	with RefNr (valid for all versions other than 1.0)	mit RefNr (gilt für alle Versionen außer 1.0)

Description of the possible batch versions

The structure for an Alipay payment within a Batch file to be submitted is as follows:

Multiexcerpt

MultiExcerptName	batch_structure
shouldDisplayInlineCommentsInIncludes	false

Code Block

language	xml

HEAD,<MerchantID>,<Date>,<Version>
Alipay,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>
FOOT,<CountRecords>,<SumAmount>

Example for Master MID function:

Multiexcerpt

MultiExcerptName	batch_MasterMid
shouldDisplayInlineCommentsInIncludes	false

Code Block

language	xml

HEAD,[Master]MerchantID,Date,2.x
Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action)
FOOT,CountRecords,SumAmount

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Batch_Request_Intro
PageWithExcerpt	Reuse API

The following table describes the individual fields and values used within the data set (record) in the batch file:

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1646343499627_1972111528
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	batch_request

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1646343499628_1997138816
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Key	Format	CND	Description	Beschreibung
Type	a..11	M	HEAD for Header, FOOT for Footer, Alipay for Alipay	HEAD für Header, FOOT für Footer, Alipay für Alipay
Action	a..20	M	The parameter Action defines the type of transaction: Credit	Der Action-Parameter definiert die Art der Transaktion: Credit (Gutschrift)

Table Excerpt Include

name	Amount
page	Amount
type	page

Table Excerpt Include

static	true
name	Currency
page	Currency
type	page

Table Excerpt Include

static	true
name	TransID
page	TransID
type	page

Key	Format	CND	Description	Beschreibung
RefNr	ans..40	O	Merchant’s unique reference number. Only characters a-zA-Z0-9,-_ are allowed.	Eindeutige Referenznummer des Händlers. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt.

Table Excerpt Include

static	true
name	PayID_Batch
page	PayID
type	page

Description of fields within the record for Batch files

The record area within the response file for Batch transactions looks as follows:

Multiexcerpt

MultiExcerptName	batch_structure_response
shouldDisplayInlineCommentsInIncludes	false

Code Block

language	xml

HEAD,<MerchantID>,<Date>,<Version>
Alipay,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>
FOOT,<CountRecords>,<SumAmount>

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Batch_Response_Intro
PageWithExcerpt	Reuse API

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

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1646344414292_-1815387064
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	batch_response

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1646344414294_1364607256
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Key	Format	CND	Description	Beschreibung
Action	a..20	M	The parameter Action defines the type of transaction: Credit	Der Action-Parameter definiert die Art der Transaktion: Credit (Gutschrift)

Table Excerpt Include

static	true
name	PayID_Batch
page	PayID
type	page

Table Excerpt Include

static	true
name	Status_OK_FAILED
page	Status
type	page

Table Excerpt Include

static	true
name	Code
page	Code
type	page

Description of result parameters within the record for Batch files

JSON object OrderDesc2

Scheme

Multiexcerpt

MultiExcerptName	JSON_OrderDesc2_Scheme
shouldDisplayInlineCommentsInIncludes	false

Code Block

language	json
linenumbers	true

{
    "$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

Multiexcerpt

MultiExcerptName	JSON_OrderDesc2_Example
shouldDisplayInlineCommentsInIncludes	false

Code Block

language	json
linenumbers	true

[{
     "itemDescription": "Book",
     "number": 3
}, {
     "itemDescription": "Movie",
     "number": 2
}
]

Space shortcuts

Page tree

Versions Compared

Old Version 4

New Version 5

Key

About Alipay

General information about Alipay

Process flow chart

On this page

Multiexcerpt include
SpaceWithExcerpt EN
MultiExcerptName Platform-Kurz
PageWithExcerpt Wording
interface

Payment with Alipay over
Multiexcerpt include
SpaceWithExcerpt EN
MultiExcerptName Platform-Kurz
PageWithExcerpt Wording
form interface

Credit with reference

Batch processing via the interface

JSON object OrderDesc2

Scheme

Example

Paygate

Computop

Help

Intranet Tools

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 4

New Version 5

Key

About Alipay

General information about Alipay

Process flow chart

On this page

Multiexcerpt includeSpaceWithExcerptENMultiExcerptNamePlatform-KurzPageWithExcerptWording interface

Payment with Alipay over Multiexcerpt includeSpaceWithExcerptENMultiExcerptNamePlatform-KurzPageWithExcerptWording form interface

Credit with reference

Batch processing via the interface

JSON object OrderDesc2

Scheme

Example

Multiexcerpt include
SpaceWithExcerpt EN
MultiExcerptName Platform-Kurz
PageWithExcerpt Wording
interface

Payment with Alipay over
Multiexcerpt include
SpaceWithExcerpt EN
MultiExcerptName Platform-Kurz
PageWithExcerpt Wording
form interface