Alipay (via PPRO)

1. Über Alipay(via PPRO)

1.1 Allgemeines zu Alipay

Info	Typ
Mit dem E-Wallet von Chinas führendem Online-Bezahlsystem können Kunden und Händler Zahlungen senden und empfangen. Alipay hat über 800 Mio. registrierte Nutzer und 2014 über 100 Mio. Online-Zahlungen pro Tag verarbeitet.	Zahlungen per Wallet

Weitere Informationen finden Sie auch auf der Webseite von Alipay ( https://intl.alipay.com/ ).

1.2 Diagramm zum Prozessablauf

2. 1cs Online Bezahlsystem-Schnittstelle

2.1 Definitionen

Datenformate:

Format	Beschreibung
a	alphabetisch
as	alphabetisch mit Sonderzeichen
n	numerisch
an	alphanumerisch
ans	alphanumerisch mit Sonderzeichen
ns	numerisch mit Sonderzeichen
bool	Bool’scher Ausdruck (true oder false)
3	feste Länge mit 3 Stellen/Zeichen
..3	variable Länge mit maximal 3 Stellen/Zeichen
enum	Aufzählung erlaubter Werte
dttm	ISODateTime (JJJJ-MM-TTThh:mm:ss)

Abkürzungen:

Abkürzung	Beschreibung	Kommentar
CND	Bedingung (condition)
M	Pflicht (mandatory)	Wenn ein Parameter Pflicht ist, dann muss er vorhanden sein
O	optional	Wenn ein Parameter optional ist, dann kann er vorhanden sein, ist aber nicht erforderlich
C	bedingt (conditional)	Wenn ein Parameter bedingt ist, dann gibt es eine Bedingungsregel, die angibt, ob er Pflicht oder optional ist

Hinweis: Bitte beachten Sie, dass die Bezeichnungen der Parameter in Groß- oder Kleinbuchstaben zurückgegeben werden können.

2.2 Alipay-Zahlung via Formular-Schnittstelle

Um mittels PPRO eine Alipay-Zahlung über ein Paygate-Formular abzuwickeln, verwenden Sie bitte folgende URL:

https://www.computop-paygate.com/alipay.aspx

Hinweis: Aus Sicherheitsgründen lehnt das 1cs OBS alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Key	Format	CND	Beschreibung
MerchantID	ans..30	M	HändlerID, die von der First Cash Solution vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.
TransID	ans..64	M	Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss
RefNr	ans..40	O	Eindeutige Referenznummer des Händlers. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt.
Amount	n..10	M	Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den 1cs Support, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.
Currency	a3	M	Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Nur CHF zulässig. Hier eine Übersicht: Währungstabelle
MAC	an64	M	Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: HMAC Authentication (Request) HMAC Authentication (Notify)
UserData	ans..1024	O	Wenn beim Aufruf angegeben, übergibt das 1cs OBS die Parameter mit dem Zahlungsergebnis an den Shop.
URLSuccess	ans..256	M	Vollständige URL, die das 1cs OBS aufruft, wenn die Zahlung erfolgreich war. Die URL darf nur über Port 443 aufgerufen werden. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen nutzen Sie stattdessen den Parameter UserData. Allgemeine Hinweise: Wir empfehlen, den Parameter „response=encrypt“ zu verwenden, um eine verschlüsselte Antwort von 1cs OBS zu erhalten. Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess senden. Überprüfen Sie daher unbedingt den „code“-Wert des DATA-Elements. Nur eine Antwort mit „code=00000000“ sollte als erfolgreich angesehen werden.
URLFailure	ans..256	M	Vollständige URL, die das 1cs OBS aufruft, wenn die Zahlung gescheitert ist. Die URL darf nur über Port 443 aufgerufen werden. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen nutzen Sie stattdessen den Parameter UserData. Allgemeine Hinweise: Wir empfehlen, den Parameter „response=encrypt“ zu verwenden, um eine verschlüsselte Antwort vom 1cs OBS zu erhalten. Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den „code“-Wert des DATA-Elements. Nur eine Antwort mit „code=00000000“ sollte als erfolgreich angesehen werden.
Response	a7	O	Die Status-Rückmeldung, die das 1cs OBS an URLSuccess und URLFailure sendet, sollte verschlüsselt werden. Dazu übergeben Sie den Parameter Response=encrypt.
URLNotify	ans..256	M	Vollständige URL, die das 1cs OBS aufruft, um den Shop zu benachrichtigen. Die URL darf nur über Port 443 aufgerufen werden. Sie darf keine Parameter enthalten: Nutzen Sie stattdessen den Parameter UserData. Allgemeine Hinweise: Wir empfehlen, den Parameter „response=encrypt“ zu verwenden, um eine verschlüsselte Antwort vom 1cs OBS zu erhalten. Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den „code“-Wert des DATA-Elements. Nur eine Antwort mit „code=00000000“ sollte als erfolgreich angesehen werden
ReqId	ans..32	O	Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das 1cs OBS keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück. Bitte beachten Sie, dass das 1cs OBS für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am 1cs OBS nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom 1cs OBS gelöscht.
OrderDesc	ans..768	M	Beschreibung der Waren, Einzelpreise usw., Verwendungszweck auf dem Kontoauszug
SellingPoint	ans..50	O	Verkaufsstelle
Service	ans..50	O	verkaufte Produkte oder Dienstleistung
Channel	ans..64	O	Konfigurationskanal des PPRO-Vertrags (Account und ContractID sind im System hinterlegt). Wenn vorhanden, überschreibt er den eventuell im System hinterlegten Channel.
Language	a2	O	2-stelliger Sprachcode, der für die Zahlungsseiten für den Kunden bevorzugt werden soll. Mögliche Werte: CN: Vereinfachtes Chinesisch TW: Traditionelles Chinesisch US: Englisch (Standard) Wenn der Parameter leer ist, wird die Standardsprache verwendet.
AccOwner	ans3..50	M	Name des Kontoinhabers
Device	a6	O	Bei Übergabe von „Mobile“ wird statt der Desktop-Version die Mobil-Version von Alipay aufgerufen
AddrCountryCode	a2	M	Ländercode im Format ISO-3166-1, alphanumerisch 2-stellig
HotelName	ans..128	C	Name des Hotels, für das die Reservierung gemacht wurde. Obligatorisch, wenn die Geschäftsart des Händlers Hotel ist.
CheckInTime	ams..128	C	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
ChecoutTime	ans..128	C	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-codiertes JSON-Objekt mit Beschreibung und Menge der gekauften Produkte
Plain	ans..50	O	Ein einzelner Wert, der von Ihnen gesetzt werden kann, um Informationen wieder unverschlüsselt in der Antwort bzw. im Notify zurückzugeben, z.B. die MID. Da der „Plain“-Parameter Teil des verschlüsselten „Data“ im 1cs OBS ist, ist dieser vor Manipulationen geschützt.
Custom	ans..1024	O	Der „Custom“-Parameter wird vor der Verschlüsselung an den Aufruf angehängt und ist Teil des verschlüsselten „Data“ im 1cs OBS Aufruf. Dadurch ist der Wert gegen Manipulation geschützt.  Der Custom-Wert wird dann in Klartext an die 1cs OBS-Antwort angehängt und dabei wird „|“ durch „&“ ersetzt. Dadurch können Sie einen Custom-Wert übergeben und bekommen mehrere Key-Value-Paare zu Ihrer eigenen Verwendung in der Antwort zurück.

Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das 1cs OBS an Ihre URLSuccess, URLFailure und URLNotify übergibt. Wenn Sie den Parameter Response=encrypt angegeben haben, werden die folgenden Parameter mit Blowfish verschlüsselt an Ihr System übergeben:

Hinweis: es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

Hinweis: die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

Parameter	Format	CND	Beschreibung
mid	ans..30	M	HändlerID, die von der First Cash Solution vergeben wird.
PayID	an32	M	Vom 1cs OBS vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.
XID	an32	M	Vom 1cs OBS vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden
TransID	ans..64	M	Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss
Status	a…50	M	OK oder AUTHORIZE_REQUEST (URLSuccess) sowie FAILED (URLFailure)
Description	ans..1024	M	Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!
Code	n8	M	Fehlercode gemäß 1cs OBS Antwortcodes (Fehlercodes)
Refnr	ans..40	O	Eindeutige Referenznummer des Händlers. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt.
MAC	an64	M	Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: HMAC-Authentisierung (Anfrage) HMAC-Authentisierung (Notify)
UserData	ans..1024	O	Wenn beim Aufruf angegeben, übergibt das 1cs Online Bezahlsystem die Parameter mit dem Zahlungsergebnis an den Shop
PaymentPurpose	ans..26	O	Zahlungszweck
PaymentGuarantee	a..12	O	Wert + Beschreibung: NONE – keine Zahlungsgarantie VALIDATED – Kundenkonto valide, aber keine Zahlungsgarantie FULL – Zahlungsgarantie Hinweis: Dieser Parameter wird nur zurückgegeben, falls der Status=OK ist.
ErrorText	ans..128	C	Detaillierte PPRO Fehlermeldung. Hinweis: Wird nur bei Status=FAILED zurückgegeben. Nutzung nur in Abstimmung mit der 1cs möglich.
TransactionID	an..20	O	Eindeutige Transaktionsnummer bei PPRO
Plain	ans..50	O	Ein einzelner Wert, der von Ihnen gesetzt werden kann, um Informationen wieder unverschlüsselt in der Antwort bzw. im Notify zurückzugeben, z.B. die MID. Da der „Plain“-Parameter Teil des verschlüsselten „Data“ im 1cs OBS ist, ist dieser vor Manipulationen geschützt.
Custom	ans..1024	O	Der „Custom“-Parameter wird vor der Verschlüsselung an den Aufruf angehängt und ist Teil des verschlüsselten „Data“ im 1cs OBS Aufruf. Dadurch ist der Wert gegen Manipulation geschützt. Der Custom-Wert wird dann in Klartext an die 1cs OBS-Antwort angehängt und dabei wird „|“ durch „&“ ersetzt. Dadurch können Sie einen Custom-Wert übergeben und bekommen mehrere Key-Value-Paare zu Ihrer eigenen Verwendung in der Antwort zurück.

2.3 Gutschrift mit Referenz

Gutschriften sind über eine Server-zu-Server-Kommunikation möglich. Bei einer Gutschrift mit Bezug auf eine Buchung ist die Höhe der Gutschrift auf die Höhe der vorangegangen Buchung beschränkt. Um eine Gutschrift (Credit) mit Referenztransaktion auszuführen, verwenden Sie bitte folgende URL:

https://www.computop-paygate.com/credit.aspx

Hinweis: Aus Sicherheitsgründen lehnt das 1cs OBS alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter	Format	CND	Beschreibung
MerchantID	ans..30	M	HändlerID, die von der First Cash Solution vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.
PayID	an32	M	Vom 1cs Online Bezahlsystem vergebene ID für die gutzuschreibende Zahlung
TransID	ans..64	M	Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss.
Refnr	ans..40	O	Eindeutige Referenznummer des Händlers. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt.
MAC	an64	M	Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: HMAC-Authentisierung (Anfrage) HMAC-Authentisierung (Notify)
Amount	n..10	M	Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich andie First Cash Solution, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.
Currency	a3	M	Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: Währungstabelle
UserData	ans..256	O	Wenn beim Aufruf angegeben, übergibt das 1cs OBS die Parameter mit dem Zahlungsergebnis an den Shop.
ReqId	ans..32	O	Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das 1cs OBS keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück. Bitte beachten Sie, dass das 1cs OBS für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am 1cs OBS nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom 1cs OBS gelöscht.

Die folgende Tabelle beschreibt die Parameter, die das 1cs OBS als Antwort zurückgibt:

Hinweis: es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

Hinweis: die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

Parameter	Format	CND	Beschreibung
mid	ans..30	M	HändlerID, die von der First Cash Solution vergeben wird
PayID	an32	M	Vom 1cs Online Bezahlsystem vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request
XID	an32	M	Vom 1cs Online Bezahlsystem vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden
TransID	ans..64	M	Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss.
Status	a..50	M	OK (URLSuccess) oder FAILED (URLFailure)
Description	ans..1024	M	Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus!
Code	n8	M	Fehlercode gemäß 1cs Online Bezahlsystem Antwort Codes (Fehlercodes)
UserData	ans..256	O	Wenn beim Aufruf angegeben, übergibt das 1cs OBS die Parameter mit dem Zahlungsergebnis an den Shop.
RefNr	ans..40	O	Eindeutige Referenznummer des Händlers, welche als Auszahlungsreferenz in der entsprechenden Acquirer EPA-Datei angegeben wird. Bitte beachten Sie, ohne die Übergabe einer eigenen Auszahlungsreferenz können Sie die EPA-Transaktionen nicht zuordnen, zusätzlich kann das Computop Settlement File (CTSF) auch nicht zusätzlich angereichert werden. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt.
ErrorText	ans..128	C	Detaillierte PPRO Fehlermeldung. Hinweis: Wird nur bei Status=FAILED zurückgegeben. Nutzung nur in Abstimmung mit der First Cash Solution möglich

 

3. Batch-Nutzung der Schnittstelle

Grundsätzliche Informationen zur Arbeit mit Batch-Dateien sowie zu deren Aufbau erfahren Sie im separaten Handbuch zum Batchmanager. Im Batch-Verfahren sind nicht alle Funktionen verfügbar, die für die Online-Schnittstelle verfügbar sind.

Dieses Kapitel beschreibt die Parameter, die Sie im Datensatz (Record) für die Ausführung von Gutschriften mit Alipay übergeben müssen und welche Informationen Sie der Antwort-Datei über den Status des Zahlungsvorgangs entnehmen können.

Folgende Tabelle gibt eine Übersicht der pro Aktion jeweils möglichen Batch-Versionen und ihrer Besonderheiten:

Der Aufbau für eine Zahlung mit Alipay in einer einzureichenden Batch-Datei sieht folgendermaßen aus:

HEAD,<MerchantID>,<Date>,<Version>

Alipay,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>

FOOT,<CountRecords>,<SumAmount>

Beispiel für Master-MID-Funktion:

HEAD,[Master]MerchantID,Date,2.x

Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action)

FOOT,CountRecords,SumAmount

Die folgende Tabelle beschreibt die einzelnen Felder und Werte, die im Datensatz (Record) innerhalb der Batch-Datei verwendet werden:

Der Record-Bereich in der Antwort-Datei zu Batch-Transaktionen sieht folgendermaßen aus:

HEAD,<MerchantID>,<Date>,<Version>

Alipay,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>

FOOT,<CountRecords>,<SumAmount>

Die folgende Tabelle beschreibt die Antwort-Parameter, die der Batch-Manager im Record-Bereich zu jeder Transaktion speichert (hier nicht erklärte Standardparameter wie etwa <TransID> oder <RefNR> und Aufrufparameter werden unverändert zum Aufruf wieder zurückgegeben und sind vorstehend beschrieben):

4. JSON-Object OrderDesc2

Schema

{

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

        }

    }

}

Beispiel

[{

     "itemDescription": "Book",

     "number": 3

}, {

     "itemDescription": "Movie",

     "number": 2

}

]