Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space ENWORK and version Documentation

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
SpaceWithExcerptEN
MultiExcerptNamePlatform-Name
PageWithExcerptWording
. 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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Name
PageWithExcerptWording
, 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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Name
PageWithExcerptWording
. 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.


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.

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

Multiexcerpt
MultiExcerptNameProcessFlow

draw.io Diagram
bordertrue
diagramNameAlipay Website Payment
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth1109

Alipay Website Payment process flow

Multiexcerpt
MultiExcerptNameProcessFlowSpot


draw.io Diagram
bordertrue
diagramNameAlipay Spot Payment
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth1109

Alipay Spot Payment process flow

Multiexcerpt
MultiExcerptNameProcessFlowQRCode


draw.io Diagram
bordertrue
diagramNameAlipay QR Payment
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth1109

Alipay QR Code Payment process flow

Multiexcerpt
MultiExcerptNameProcessFlowApp


draw.io Diagram
bordertrue
diagramNameAlipay In-App Payment
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth1451

Alipay In-App Payment process flow

On this page

Table of Contents
exclude(Auf dieser Seite|In diesem Abschnitt).*


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
interface

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameDefinition
PageWithExcerptDefinition EN


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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Name
PageWithExcerptWording
form:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
alipay.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1647261323330_-9617693
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamealipay_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1647261323332_1575412568
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Unique reference number for your accounts

Eindeutige Referenznummer für Ihre Buchhaltung

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Key

Format

CND

Description

Beschreibung

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

Währung, drei Zeichen DIN / ISO 4217. Für Händler in China (Inland) ist nur CNY erlaubt, für Crossborder-Händler ist CNY nicht erlaubt. Hier eine Übersicht: A1 Währungstabelle

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Key

Format

CND

Description

Beschreibung

OrderDesc

ans..768

M

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

Name der gekauften Waren. Die Sonderzeichen „#“, „&“, „%“ sowie „+“ sind hier nicht zulässig.

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.

Beschreibung der gekauften Waren und deren Menge im Format goods_name1;Menge1+goods_name2;Menge2.

<;> trennt Waren und Menge innerhalb eines Datensatzes
<+> trennt mehrere Datensätze

Beispiel: iPhone X;1+iPhone 8;2

Die Sonderzeichen „#“, „&“ sowie „%“ sind hier nicht zulässig.

ShopURLan..128MURL of web shop, for example https://testmerchant.comURL des Internet-Shops, zum Beispiel https://testmerchant.com

Table Excerpt Include
statictrue
nameURLSuccess
pageURLSuccess
typepage

Table Excerpt Include
statictrue
nameURLFailure
pageURLFailure
typepage

Table Excerpt Include
statictrue
nameResponse
pageResponse
typepage

Table Excerpt Include
statictrue
nameURLNotify
pageURLNotify
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Key

Format

CND

Description

Beschreibung
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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
.

Zeitlimit für eine Transaktion (nur für Inlandshändler) von 1 Minute bis 15 Tage

Angaben erfolgen durch eine zweistellige Integer-Zahl plus eine Kennung:

m (Minute)

h (Stunde)

d (Tag)

Da nur ganzzahlige Werte zulässig sind, muss für 1,5 Stunden der Wert 90m verwendet werden. Zusätzlich bedeutet 1c bis zum Ende des aktuellen Tages.

Nutzung ist nur in Abstimmung mit dem

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
möglich.

CustomerIDans..16Ounique customer numbereindeutige Kundennummer
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

-     CMBC: China Minsheng Banking

-     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

Pflicht für E-Banking: Der Endkunde wird direkt zur angegebenen Bank weitergeleitet. Nur für Händler im Inland möglich.

-              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

-              CMBC: China Minsheng Banking

-              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: Postal Savings Bank of China

-              abc1003: Visa

-              abs1004: Master

Devicea6OWhen submitting “Mobile” the mobile version of Alipay is called instead of the desktop versionBei Übergabe von „Mobile“ wird statt der Desktop-Version die Mobil-Version von Alipay aufgerufen
FxCurrencya3OC

Currency for settlement. Three digits DIN / ISO 4217.

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

Währung für das Settlement. Drei Zeichen DIN / ISO 4217.

Nur für Crossborder-Händler erlaubt, Pflicht wenn Currency=CNY. CNY ist hier nicht erlaubt.

Table Excerpt Include
statictrue
namePlain
pagePlain
typepage

Table Excerpt Include
statictrue
nameCustom
pageCustom
typepage

Parameters for payments with Alipay Website payment


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_IntroURL
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1647262765389_480461482
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamealipay_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1647262765391_178735339
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameStatus_OK_AUTHORIZE_REQUEST
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Merchant's unique reference number

Eindeutige Referenznummer des Händlers

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
namePlain
pagePlain
typepage

Table Excerpt Include
statictrue
nameCustom
pageCustom
typepage

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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
alipayspot.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1647264835958_-1726932352
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamealipayspot_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1647264835961_175048933
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Unique reference number

Eindeutige Referenznummer

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Key

Format

CND

Description

Beschreibung

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

Währung, drei Zeichen DIN / ISO 4217. Für Händler in China (Inland) ist nur CNY erlaubt, für Crossborder-Händler ist CNY nicht erlaubt. Hier eine Übersicht: A1 Währungstabelle

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Key

Format

CND

Description

Beschreibung

OrderDesc

ans..256

M

Name of the transaction which is displayed in the transactions list

Name der Transaktion, die in der Transaktionsliste angezeigt wird

OrderDesc2ans..256OTransaction noticeTransaktionsnotiz

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Key

Format

CND

Description

Beschreibung
BuyerIDCodeans..32MCode generated by the Alipay-App. It is designed for the identification of a user.Code, der durch die Alipay-App generiert wurde. Er dient der Identifizierung eines Nutzers.

Parameters for payments with Alipay Spot Payment


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1647265681363_115393130
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamealipayspot_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1647265681365_1058291471
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

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

OK, FAILED sowie AUTHORIZE_REQUEST (Wenn noch kein endgültiger Status von Alipay vorliegt. Eventuell muss der Kunde die Zahlung mit seinem Payment-Passwort in der App bestätigen.)

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Merchant's unique reference number

Eindeutige Referenznummer des Händlers

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Key

Format

CND

Description

Beschreibung

ErrorText

ans..48

O

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
.

Fehlertext vom nachgelagertem System, nur wenn dessen Rückgabe mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
abgesprochen.

TIDans..64OTransactionID generated by Alipay systemVom Alipay-System generierte TransaktionsID

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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
alipayQRCode.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1647266551356_608484315
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamealipayqrcode_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1647266551357_-115554846
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Unique reference number

Eindeutige Referenznummer

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Key

Format

CND

Description

Beschreibung

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

Währung, drei Zeichen DIN / ISO 4217. Für Händler in China (Inland) ist nur CNY erlaubt, für Crossborder-Händler ist CNY nicht erlaubt. Hier eine Übersicht: A1 Währungstabelle

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Key

Format

CND

Description

Beschreibung

OrderDesc

ans..256

M

Name of the transaction which is displayed in the transactions list

Name der Transaktion, die in der Transaktionsliste angezeigt wird

OrderDesc2ans..256OTransaction noticeTransaktionsnotiz

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
nameURLNotify
pageURLNotify
typepage

Parameters for payments with Alipay QR Code Payment


The following table describes the result parameters, which the

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
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:

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1647275858807_-1823516323
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamealipayqrcode_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1647275858808_1920213330
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

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

OK, FAILED sowie AUTHORIZE_REQUEST (Wenn noch kein endgültiger Status von Alipay vorliegt. Eventuell muss der Kunde die Zahlung mit seinem Payment-Passwort in der App bestätigen.)

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Merchant's unique reference number

Eindeutige Referenznummer des Händlers

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Key

Format

CND

Description

Beschreibung

ErrorText

ans..48

O

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
.

Fehlertext vom nachgelagertem System, nur wenn dessen Rückgabe mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
abgesprochen.

QRCodeURLans..128OIf request processed successfully, QR Code Url will be returned, which can be converted to QR Code.Wenn die Anfrage erfolgreich verarbeitet worden ist, wird eine QR-Code Url zurückgegeben, die in einen QR-Code umgewandelt werden kann.

Parameters of synchronous response from Alipay QR Code Payment – Pre-ordering of QR Code


The following table describes the result parameters, which the

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
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:

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1647331141379_-1849129750
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamealipayqrcode_notify
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1647331141381_801752735
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

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

OK, FAILED sowie AUTHORIZE_REQUEST (Wenn noch kein endgültiger Status von Alipay vorliegt. Eventuell muss der Kunde die Zahlung mit seinem Payment-Passwort in der App bestätigen.)

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Merchant's unique reference number

Eindeutige Referenznummer des Händlers

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Key

Format

CND

Description

Beschreibung

ErrorText

ans..48

O

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
.

Fehlertext vom nachgelagertem System, nur wenn dessen Rückgabe mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
abgesprochen.

TIDans..64OTransactionID generated by Alipay systemVom Alipay-System generierte TransaktionsID
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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
alipayApp.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1647331469452_207707226
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamealipayapp_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1647331469454_-1337342286
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Unique reference number

Eindeutige Referenznummer

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Key

Format

CND

Description

Beschreibung

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

Währung, drei Zeichen DIN / ISO 4217. Für Händler in China (Inland) ist nur CNY erlaubt, für Crossborder-Händler ist CNY nicht erlaubt. Hier eine Übersicht: A1 Währungstabelle

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Key

Format

CND

Description

Beschreibung

OrderDesc

ans..256

M

Name of the transaction which is displayed in the transactions list

Name der Transaktion, die in der Transaktionsliste angezeigt wird

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.

Beschreibung der gekauften Waren und ihrer Anzahl im Format goods_name1;quantity1+goods_name2;quantity2.

<;> trennt Waren und Anzahl innerhalb eines Datensatzes
<+> trennt mehrere Datensätze

Beispiel: iPhone X;1+iPhone 8;2

Die Sonderzeichen “#”, “&” and “%” sind hier nicht erlaubt.

ShopURLan..128MURL of web shop, for example https://testmerchant.comURL des Web-Shops, zum Beispiel https://testmerchant.com

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
nameURLNotify
pageURLNotify
typepage

Key

Format

CND

Description

Beschreibung

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.

Währung für die Abrechnung. Drei Zeichen DIN / ISO 4217.

Nur für Crossborder-Händler erlaubt, Pflicht wenn Currency=CNY. CNY ist hier nicht erlaubt.

Parameters for payments with Alipay In-App Payment


The following table describes the result parameters, which the

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
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:

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1647331859039_-1849129750
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamealipayapp_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1647331859040_801752735
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

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

OK, FAILED sowie AUTHORIZE_REQUEST (Wenn noch kein endgültiger Status von Alipay vorliegt. Eventuell muss der Kunde die Zahlung mit seinem Payment-Passwort in der App bestätigen.)

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Merchant's unique reference number

Eindeutige Referenznummer des Händlers

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Key

Format

CND

Description

Beschreibung
RequestStringans..128OIf request is processed successfully, request string to call Alipay API In-App Payment will be returnedWenn die Anfrage erfolgreich verarbeitet worden ist, wird der Anfrage-String zum Aufruf der Alipay-API In-App Payment zurückgegeben

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
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:

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1647333059067_-1471161816
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamealipayapp_notify
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1647333059068_236993540
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

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

OK, FAILED sowie AUTHORIZE_REQUEST (Wenn noch kein endgültiger Status von Alipay vorliegt. Eventuell muss der Kunde die Zahlung mit seinem Payment-Passwort in der App bestätigen.)

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Merchant's unique reference number

Eindeutige Referenznummer des Händlers

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Key

Format

CND

Description

Beschreibung

ErrorText

ans..48

O

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
.

Fehlertext vom nachgelagertem System, nur wenn dessen Rückgabe mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
abgesprochen ist.

TIDans..64OTransactionID generated by Alipay systemVom Alipay-System generierte TransaktionsID

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
permits reversals that reference a capture or authorisation previously made via
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
. 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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
reverse.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1647334150090_1250592618
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamereverse_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1647334150092_584452778
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
namePayID_Reverse
pagePayID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Merchant's unique reference number

Eindeutige Referenznummer des Händlers

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Parameters for reversal of Alipay Spot Payment or QR Code payment


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1647334255511_-1590436273
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamereverse_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1647334255513_-1063278154
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Merchant's unique reference number

Eindeutige Referenznummer des Händlers

ErrorTextans..48O

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
.

Fehlertext vom nachgelagertem System, nur wenn dessen Rückgabe mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
abgesprochen ist.

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.

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
permits credits that reference on a capture previously made via
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
. 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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
credit.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1647334623358_75156725
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecredit_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1647334623359_1985049463
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
namePayID_Credit
pagePayID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Merchant's unique reference number

Eindeutige Referenznummer des Händlers

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Parameters for credits of Alipay payments

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1647334733637_216666854
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecredit_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1647334733639_-1509133085
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Merchant's unique reference number

Eindeutige Referenznummer des Händlers

ErrorTextans..48O

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
.

Fehlertext vom nachgelagertem System, nur wenn dessen Rückgabe mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
abgesprochen ist.

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.

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
permits status requests that reference a payment previously made via
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
. 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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
inquireExt.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1647335394150_55291780
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamealipaystatus_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1647335394152_49306083
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Merchant's unique reference number

Eindeutige Referenznummer des Händlers

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Parameters for status requests of Alipay Spot Payment

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1647335603234_729703269
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamealipaystatus_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1647335603236_-659313318
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

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

OK, FAILED sowie AUTHORIZE_REQUEST (Wenn noch kein endgültiger Status von Alipay vorliegt. Eventuell muss der Kunde die Zahlung mit seinem Payment-Passwort in der App bestätigen.)

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Merchant's unique reference number

Eindeutige Referenznummer des Händlers

ErrorTextans..48O

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
.

Fehlertext vom nachgelagertem System, nur wenn dessen Rückgabe mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
abgesprochen ist.

Response parameters for status requests of Alipay Spot Payment



Batch processing via the interface

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBatch_Intro
PageWithExcerptReuse 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 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:

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1647259980815_446920502
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamebatch_versions
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1647259980817_-1124726690
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * 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)
Reverse

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
MultiExcerptNamebatch_structure
shouldDisplayInlineCommentsInIncludesfalse
Code Block
languagexml
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:

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


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBatch_Request_Intro
PageWithExcerptReuse API
The following table describes the individual fields and values used within the data set (record) in the batch file:

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1647260240333_1972111528
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamebatch_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1647260240335_1997138816
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * 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

Reverse (cancellation)

Der Action-Parameter definiert die Art der Transaktion:

Credit (Gutschrift)

Reverse (Storno)

Table Excerpt Include
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Unique reference number

Eindeutige Referenznummer

Table Excerpt Include
statictrue
namePayID_Batch
pagePayID
typepage

Description of fields within the record for Batch files

 

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

Multiexcerpt
MultiExcerptNamebatch_Response
shouldDisplayInlineCommentsInIncludesfalse
Code Block
languagexml
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>


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBatch_Response_Intro
PageWithExcerptReuse 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
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1647260441638_-1815387064
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamebatch_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1647260441639_1364607256
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Key

Format

CND

Description

Beschreibung

Action

a..20

M

The parameter Action defines the type of transaction:

Credit

Reverse (cancellation)

Der Action-Parameter definiert die Art der Transaktion:

Credit (Gutschrift)

Reverse (Storno)

Table Excerpt Include
statictrue
namePayID_Batch
pagePayID
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Description of result parameters within the record for Batch files