Paygate-Schnittstelle

Definitionen

Datenformate:

Abkürzungen:

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

Abfrage verfügbarer Zahlungsarten (Zwei-Schritt-Autorisierung)

AfterPay unterscheidet zwischen der Ein-Schritt- und Zwei-Schritt-Autorisierung. Die Ein-Schritt-Autorisierung dient Händlern, die nur die normale Zahlung per Rechnung in ihrem Checkout nutzen. Die Zwei-Schritt-Autorisierung ermöglicht es, für einen bestimmten Warenkorb die hierfür verfügbaren Zahlungsarten und weitere Informationen dazu abzufragen.

Um eine Zwei-Schritt-Autorisierung mit AfterPay über eine Server-zu-Server-Verbindung abzuwickeln, verwenden Sie bitte folgende URL:

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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter für Zahlungen mit AfterPay

Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt:

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

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

Ergebnis-Parameter für AfterPay

Im zweiten Schritt werden die Kunden- und Bestelldaten sowie die zu verwendende Zahlungsart und evtl. weitere zur Zahlungsart gehörende Informationen übergeben.

Um den zweiten Schritt durchzuführen, verwenden Sie bitte folgende URL:

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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter für AfterPay

Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt:

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

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

Ergebnis-Parameter für AfterPay

Aufruf der Schnittstelle für Ein-Schritt-Autorisierung

Um eine Ein-Schritt-Autorisierung mit AfterPay abzuwickeln, verwenden Sie bitte folgende URL:

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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter für Zahlungen mit AfterPay

Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt:

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

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

Ergebnis-Parameter für AfterPay

Buchung

Buchungen sind über eine Server-zu-Server-Kommunikation möglich. Um eine Buchung (Capture) für AfterPay über eine Server-zu-Server-Verbindung auszuführen, verwenden Sie bitte folgende URL:

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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter für AfterPay-Buchungen

Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt:

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

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

Ergebnis-Parameter für AfterPay-Buchungen

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:

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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter für Gutschrift von AfterPay-Zahlungen

Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt:

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

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

Ergebnis-Parameter für Gutschrift von AfterPay-Zahlungen

Storno

Stornierungen sind über eine Server-zu-Server-Kommunikation möglich. Um eine Transaktion bei AfterPay zu stornieren, verwenden Sie bitte folgende URL:

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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter für Storno von AfterPay-Zahlungen

Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt:

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

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

Ergebnis-Parameter für Storno von AfterPay-Zahlungen

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 einer AfterPay-Zahlung übergeben müssen und welche Informationen Sie der Antwort-Datei über den Status des Zahlungsvorgangs entnehmen können.

Hinweis: Beachten Sie bitte, dass keine Teil-Stornierungen, -Buchungen oder -Gutschriften über Batch für AfterPay möglich sind.

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

Beschreibung der möglichen Batch-Versionen

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

The page EN:AfterPay was not found  -- Please check/update the page name used in the MultiExcerpt-Include macro

Beispiel für Master-MID-Funktion:

The page EN:AfterPay was not found  -- Please check/update the page name used in the MultiExcerpt-Include macro

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

Beschreibung der Felder im Datensatz von Batch-Dateien

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

The page EN:AfterPay was not found  -- Please check/update the page name used in the MultiExcerpt-Include macro

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

Beschreibung der Ergebnis-Parameter im Datensatz von Batch-Dateien

JSON-Objekte

Die JavaScript Object Notation, kurz JSON, ist ein kompaktes Datenformat in einer einfach lesbaren Textform zum Zweck des Datenaustauschs zwischen Anwendungen. JSON ist unabhängig von der Programmiersprache. Parser existieren in praktisch allen verbreiteten Sprachen. Einige Informationen über JSON sind unter diesem Link zu finden:

Im Folgenden werden die JSON-Objekte beschrieben, die für Requests benötigt, oder aber in der Response zurückgeliefert werden.

Hinweis: Da der JSON-String Sonderzeichen enthalten kann, muss er zusätzlich Base64-codiert werden. Anderenfalls kann es zu Problemen bei der Übertragung kommen.

CustomerRisk

Risikorelevante Daten zum Kunden. Händler können externe Risikoprüfungen durchführen und AfterPay diese Informationen zusenden.

Beispiel CustomerRisk als JSON-String

The page EN:AfterPay was not found  -- Please check/update the page name used in the MultiExcerpt-Include macro

Order

Hier werden die Informationen zu einer Bestellung definiert.

OrderRisk

Hier werden die Informationen zum Risiko der bestellung definiert.

OrderItem

Hier werden die Informationen zu einem Artikel definiert.

Beispiel Order als JSON-String

The page EN:AfterPay was not found  -- Please check/update the page name used in the MultiExcerpt-Include macro

AllowedPayMethods

Hier werden die Informationen zu den erlaubten Zahlungsarten in einem Array definiert.

PaymentMethod

Hier werden die Informationen zu einem Artikel definiert.

AccountProduct

Hier werden die Informationen zu einem AccountProduct definiert.

DirectDebitInfo

Hier werden die Informationen zu DirectDebitInfo definiert.

CampaignInfo

Hier werden die Informationen zu CampaignInfo definiert.

InstallmentInfo

Hier werden die Informationen zu InstallmentInfo definiert.

Beispiel AllowedPaymentMethods als JSON-String

The page EN:AfterPay was not found  -- Please check/update the page name used in the MultiExcerpt-Include macro

Address

Hier werden die Informationen zu ggfls. korrigierten Rechnungsdaten in einem Array definiert.

Beispiel Address als JSON-String

The page EN:AfterPay was not found  -- Please check/update the page name used in the MultiExcerpt-Include macro

OrderSummary

Hier werden die Informationen zu einer OrderSummary definiert.

Beispiel OrderSummary als JSON-String

The page EN:AfterPay was not found  -- Please check/update the page name used in the MultiExcerpt-Include macro

ShippingData

Hier werden die Informationen zum Versand in einem Array definiert.

ShippingDetails

Hier werden die Informationen zu ShippingDetails definiert.

Beispiel ShippingData als JSON-String

The page EN:AfterPay was not found  -- Please check/update the page name used in the MultiExcerpt-Include macro

RefundOrder

Hier werden die Informationen zu den Artikeln definiert, die gutzuschreiben sind.

RefundOrderItem

Hier werden die Informationen zu einem RefundOrderItem definiert.

Beispiel RefundOrder als JSON-String

The page EN:AfterPay was not found  -- Please check/update the page name used in the MultiExcerpt-Include macro