Paygate-Schnittstelle
Abfrage verfügbarer Zahlungsarten (Zwei-Schritt-Autorisierung)
Riverty 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 Riverty über eine Server-zu-Server-Verbindung abzuwickeln, verwenden Sie bitte folgende URL:
https://www.computop-paygate.com/afterpay.aspx |
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 Riverty
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. mid, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden
Ergebnis-Parameter für Riverty
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:
https://www.computop-paygate.com/afterpay.aspx |
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 Riverty
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. mid, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden
Ergebnis-Parameter für Riverty
Aufruf der Schnittstelle für Ein-Schritt-Autorisierung
Um eine Ein-Schritt-Autorisierung mit Riverty abzuwickeln, verwenden Sie bitte folgende URL:
https://www.computop-paygate.com/afterpay.aspx |
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 Riverty
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. mid, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden
Ergebnis-Parameter für Riverty
Buchung
Buchungen sind über eine Server-zu-Server-Kommunikation möglich. Um eine Buchung (Capture) für Riverty über eine Server-zu-Server-Verbindung auszuführen, verwenden Sie bitte folgende URL:
https://www.computop-paygate.com/capture.aspx |
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 Riverty-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. mid, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden
Ergebnis-Parameter für Riverty-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:
https://www.computop-paygate.com/credit.aspx |
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 Riverty-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. mid, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden
Ergebnis-Parameter für Gutschrift von Riverty-Zahlungen
Storno
Stornierungen sind über eine Server-zu-Server-Kommunikation möglich. Um eine Transaktion bei Riverty zu stornieren, verwenden Sie bitte folgende URL:
https://www.computop-paygate.com/reverse.aspx |
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 Riverty-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. mid, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden
Ergebnis-Parameter für Storno von Riverty-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 Riverty-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 Riverty 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 Riverty-Zahlung in einer einzureichenden Batch-Datei sieht folgendermaßen aus:
HEAD,<MerchantID>,<Date>,<Version> AFTERPAY,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> AFTERPAY,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> AFTERPAY,Reverse,<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:
Beschreibung der Felder im Datensatz von Batch-Dateien
Der Record-Bereich in der Antwort-Datei zu Batch-Transaktionen sieht folgendermaßen aus:
HEAD,<MerchantID>,<Date>,<Version> AFTERPAY,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> AFTERPAY,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> AFTERPAY,Reverse,<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):
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 Riverty diese Informationen zusenden.
Beispiel CustomerRisk als JSON-String
{ "existingCustomer" : true, "verifiedCustomerIdentification" : "true", "marketingOptIn" : "false", "customerSince" : "2015-11-20", "customerClassification" : "Classification", "acquisitionChannel" : “SearchEngine”, "hasCustomerCard" : true, "customerCardSince" : "2016-01-23", "customerCardClassification" : "Gold Member", "profileTrackingId" : "TrackingID123456", "ipAddress" : "201.18.14.2", "numberOfTransactions" : 27, "customerIndividualScore" : 98, "userAgent" : "", "amountOfTransactions" : 1, "otherPaymentMethods" : true }
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
{ "totalGrossAmount" : 12.40, "totalNetAmount" : 10.43, "currency" : "EUR", "risk" : { "channelType" : "Catalog", "deliveryType" : "Normal", "ticketDeliveryMethod" : "NotSet" }, "items" : [{ "productId" : "1", "description" : "Tablet Black", "type" : "PhysicalArticle", "grossUnitPrice" : 4.10, "netUnitPrice" : 3.45, "quantity" : 2.0, "vatAmount" : 0.65, "vatPercent" : 19.0 }, { "productId" : "2", "description" : "MusicPlayer Black", "type" : "PhysicalArticle", "grossUnitPrice" : 4.20, "netUnitPrice" : 3.53, "quantity" : 1.0, "vatAmount" : 0.67, "vatPercent" : 19.0 } ] }
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
"paymentMethods": [{ "type": "string", "title": "string", "tag": "string", "consumerFeeAmount": 1.00, "logo": "string", "account": { ... } , "directDebit": {"available": true}, "campaigns": { ... }, "installment": { "basketAmount": 1.00, "numberOfInstallments": 1, "installmentAmount": 1.00, "firstInstallmentAmount": 1.00, "lastInstallmentAmount": 1.00, "interestRate": 1.00, "effectiveInterestRate": 1.00, "effectiveAnnualPercentageRate": 1.00, "totalInterestAmount": 1.00, "startupFee": 1.00, "monthlyFee": 1.00, "totalAmount": 1.00, "installmentProfileNumber": 1, "readMore": "string" }, "legalInfo": { "requiresCustomerConsent": true, "termsAndConditionsUrl": "string", "privacyStatementUrl": "string", "bgb507Url": "string", "text": "string" }, }]
Address
Hier werden die Informationen zu ggfls. korrigierten Rechnungsdaten in einem Array definiert.
Beispiel Address als JSON-String
{ [{ "countryCode" : "DE", "postalCode" : "10405", "street" : "Prenzlauer Allee", "streetNumber" : 20 "streetNumberAdditional" : "3. Stock", "postalPlace" : "Berlin", "addressType" : null, "careOf" : null } ] }
OrderSummary
Hier werden die Informationen zu einer OrderSummary definiert.
Beispiel OrderSummary als JSON-String
{ "totalGrossAmount" : 8.30, "currency" : "EUR", "items" : [{ "productId" : "1", "description" : "Tablet Black", "grossUnitPrice" : 4.10, "quantity" : 1.0 }, { "productId" : "2", "description" : "MusicPlayer Black", "grossUnitPrice" : 4.20, "quantity" : 1.0 } ] }
ShippingData
Hier werden die Informationen zum Versand in einem Array definiert.
ShippingDetails
Hier werden die Informationen zu ShippingDetails definiert.
Beispiel ShippingData als JSON-String
{ "shippingDetails" : [{ "type" : "Shipment", "shippingCompany" : "DHL", "trackingId" : "234324234" }, { "type" : "Shipment", "shippingCompany" : "Hermes", "trackingId" : "687654" } ] }
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
[ { "refundType" : "Return", "productId" : "1", "description" : "Tablet Black", "quantity" : 1.0, "grossUnitPrice" : 4.10, "netUnitPrice" : 3.45, "vatPercent" : 19.0, "vatAmount" : 0.65 } , { "refundType" : "Return", "productId" : "2", "description" : "MusicPlayer Black", "quantity" : 1.0, "grossUnitPrice" : 4.20, "netUnitPrice" : 3.53, "vatPercent" : 19.0, "vatAmount" : 0.67 } ]