Über Riverty (AfterPay) SCA
Allgemeines zu Riverty (AfterPay) SCA
| Logo |
|
|---|---|
| Info | Riverty (AfterPay) SCA bietet Rechnungskauf nach der Lieferung an. Käufer können die Artikel per Rechnung, Lastschrift oder Ratenzahlung bezahlen. Für den Händler gibt es gibt kein Risiko für Betrug oder Zahlungsausfall. Nach einem Risikocheck übernimmt Riverty das gesamte Ausfallrisiko des Endkunden für jede einzelne Transaktion. |
| Typ | Zahlungen per Rechnungs- und Ratenkauf |
Weitere Informationen finden Sie auch auf der Webseite von Riverty (https://www.riverty.com/de/).
Auf dieser Seite
Diagramme zum Prozessablauf
Alternativer Prozessablauf, wenn die Autorisierungsantwort in Schritt 7 nicht outcome=Pending und code=200.019 liefert. In diesem Fall ist keine zusätzliche Verifizierung erforderlich.
The page Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro-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:
The page Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macroafterpay.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:
| Key | Format | CND | Beschreibung |
|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| TransID | ans..18 | C | TransaktionsID, die für jede Zahlung eindeutig sein muss. Der Parameter wird für EventToken="Return" nicht benötigt. |
RefNr | ns..30 | C | Eindeutige Referenznummer. Der Parameter wird für EventToken="Return" nicht benötigt. |
| PayID | an32 | C | Vom The page Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro vergebene ID für die Zahlung, in deren Rahmen Waren zurückgegeben wurden. Der Parameter wird nur für EventToken="Return" benötigt. |
| InvoiceNr | ans..30 | C | Rechnungsnummer, die im Riverty-Portal angezeigt wird. Eine Bestellung kann mehrere Rechnungen enthalten. Der Parameter wird nur für EventToken="Return" benötigt. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Currency | a3 | M | Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| EventToken | a..19 | M | Der zweistufige Prozess wird durch die Übermittlung von "PAYMENTMETHODS" ausgelöst. Der Wert „Return“ löst eine Rücksendebenachrichtigung aus (Händler teilt Riverty mit, dass ein Kunde Waren zurückgesendet hat das eine Zahlung des Kunden von Riverty nicht erwartet werden sollte). |
| AddrCountryCode | a2 | M | Ländercode „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE” |
| Order | ans..1024 | M | Bestellinformationen als JSON-String im Format Base64. Siehe JSON-Objekt: Order Für EventToken="Return", siehe JSON-Objekt RefundOrder |
Parameter für Zahlungen mit Riverty (AfterPay) SCA
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
| Key | Format | CND | Beschreibung |
|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| TransID | ans..18 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | Eindeutige Referenznummer |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Status | a..50 | M | OK oder AUTHORIZED (URLSuccess) sowie FAILED (URLFailure) |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| 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! |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Code | an8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| CodeExt | n..10 | O | Fehlercode von Riverty, wenn mit The page Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro abgesprochen |
| ErrorText | ans..1024 | O | Fehlertext von Riverty, wenn mit The page Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro abgesprochen |
| AllowedPayMethods | ans..1024 | O | Erlaubte Zahlungsarten als JSON-String im Format Base64. (siehe JSON-Objekte: AllowedPayMethods) |
Ergebnis-Parameter für Riverty (AfterPay) SCA
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:
The page Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macroafterpaySCA.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:
| Key | Format | CND | Beschreibung |
|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request. |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| TransID | ans..18 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | Eindeutige Referenznummer |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Currency | a3 | M | Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| URLSuccess | ans..256 | M | Vollständige URL, die das Paygate 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.
|
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| URLFailure | ans..256 | M | Vollständige URL, die das Paygate 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.
|
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Response | a7 | O | Die Status-Rückmeldung, die das Paygate an URLSuccess und URLFailure sendet, sollte verschlüsselt werden. Dazu übergeben Sie den Parameter Response=encrypt. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| URLNotify | ans..256 | M | Vollständige URL, die das Paygate 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.
|
Key | Format | CND | Beschreibung |
|---|---|---|---|
| PayType | a..19 | M | Zahlungsmethode: „Invoice“ für Rechnung Für Lastschrift muss der Parameter PayType auf "Invoice" gesetzt und Parameter IBAN angegeben werden. |
| bdCompanyOrPerson | a..7 | M | Kundenkategorie: „Company“ für Unternehmen „Person“ für Personen (Standardwert) |
| SocialSecurityNumber | ans..16 | C | Pflicht: FI, NO, SE. Optional: AT, BE, CH, DE, DK, NL. Sozialversicherungsnummer bei einer Person in Schweden. Registrierungsnummer im Falle eines Unternehmens. Dieser Parameter ist mit dem Parameter bdCompanyOrPerson verknüpft. |
| LegalForm | ans..50 | O | Rechtsform des Unternehmens. Dieser Parameter ist mit dem Parameter bdCompanyOrPerson verknüpft. Mögliche Werte: Für Deutschland: AG, AG & Co. KG, eG, EK, e.V., GbR, GmbH, GmbH & Co. KG, KG, OHG, UG Für Österreich: AG, AG & Co. KG, eG, EK, e.V., GesbR, GmbH, GmbH & Co. KG, KG, OHG, UG Für die Schweiz: AG, eG, e.V. |
| AddrCountryCode | a2 | O | Ländercode: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE” |
| AddrZip | ans..10 | M | Postleitzahl |
| AddrStreet | ans..80 | M | Straße oder Packstation |
| AddrStreetNr | a..50 | O | Haus- oder Packstationsnummer |
| AddrStreetNr2 | ans..10 | O | Hausnummernzusatz |
| AddrCity | ans..100 | M | Ort |
| careOf | ans..50 | O | per Adresse. Vermittler, der für die Beförderung einer Postsendung vom Postsystem zum endgültigen Empfänger verantwortlich ist. Zum Beispiel Jane c/o John (“Jane an der Adresse von John”). Dieses Feld muss auch für Firmen-, Behörden- und Organisationsnamen verwendet werden – z. B. "Sportverein Blau-Weiß e.V." |
| FirstName | ans..50 | M | Vorname |
| LastName | ans..50 | M | Nachname |
| CustomerID | ans..20 | O | Eindeutige Kundennummer |
| Salutation | a..4 | O | Anrede: „Mr“ für Herr „Mrs“ für Frau „Miss“ für Fräulein |
| bdEmail | ans..100 | M | E-Mail-Adresse |
| bdPhone | ns..20 | O | Telefonnummer |
| bdMobileNo | ns..20 | M | Handynummer |
| DateOfBirth | an10 | M | Geburtsdatum im Format JJJJ-MM-TT. Für Firmen nicht zutreffend. |
| bdCompany | ans..255 | C | Name des kaufenden Unternehmens. Erforderlich, wenn bdCompanyOrPerson gleich 'Company' ist. |
| VatID | ans..50 | C | Umsatzsteuer-Identifikationsnummer, die eindeutige Nummer, die ein Unternehmen identifiziert. Das Feld ist für die Abwicklung von B2B-Transaktionen für Deutschland obligatorisch. |
| CustomerRisk | ans..1024 | M | Risikorelevante Daten als JSON-String im Base64-Format (siehe JSON-Objekte: CustomerRisk) Händler können externe Risikoprüfungen durchführen und Riverty diese Informationen zusenden. |
| Language | a2 | O | Sprache: „NO“, „SE“, „FI“, „DK”, “EN”, “DE”, “NL”, “FR” zulässig |
| CompanyOrPerson | a..7 | C | Kundenkategorie der Lieferadresse: „Company“ für Unternehmen „Person“ für Personen (Standardwert) Erforderlich, falls eines der sd-Felder (siehe unten) angegeben wird. |
| sdCountryCode | a2 | O | Ländercode der Lieferadresse: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE” |
| sdZip | ans..10 | O | Postleitzahl der Lieferadresse |
| sdStreet | ans..80 | O | Straße oder Packstation der Lieferadresse |
| sdStreetNr | a..50 | O | Haus- oder Packstationsnummer der Lieferadresse |
| sdStreetNr2 | ans..10 | O | Straßennummernzusatz der Lieferadresse |
| sdCity | ans..100 | O | Ort der Lieferadresse |
| sdcareOf | ans..50 | O | per Adresse. Vermittler, der für die Beförderung einer Postsendung vom Postsystem zum endgültigen Empfänger verantwortlich ist. Zum Beispiel Jane c/o John (“Jane an der Adresse von John”). Dieses Feld muss auch für Firmen-, Behörden- und Organisationsnamen verwendet werden – z. B. "Sportverein Blau-Weiß e.V." |
| ShippingMethod | ans..50 | O | Adressentyp. Mögliche Werte: "Standard" (Standardwert), "PickUpPoint", "InStore" |
| sdFirstName | ans..50 | O | Vorname der Lieferadresse |
| sdLastName | ans..50 | O | Nachname der Lieferadresse |
| sdSalutation | a..4 | O | Anrede der Lieferadresse „Mr“ für Herr „Mrs“ für Frau „Miss“ für Fräulein Gültig bei AddrCountryCode = „DE“, „DK“,“NL“, „BE“, „AT“ oder „CH“ |
ans..100 | O | E-Mail-Adresse der Lieferadresse | |
| Phone | ns..50 | C | Telefonnummer in der Lieferadresse und Pflichtparameter, wenn der Händler den OTP/SCA-Ablauf verarbeitet. (Derzeit unterstützt Riverty für DE nur OTP statt SCA). |
| MobileNo | ns..50 | C | Handynummer der Lieferadresse und Pflichtparameter, wenn der Händler den SCA-Abaluf verarbeitet. |
| sdCompany | ans..50 | C | Name des kaufenden Unternehmens. Erforderlich, wenn CompanyOrPerson gleich 'Company' ist. Alles ab 50 Zeichen wird abgeschnitten. |
| BIC | ans..11 | O | Bank Identifier Code (gültig bei AddrCountryCode = “DE”) |
| IBAN | ans..34 | C | International Bank Account Number (gültig bei AddrCountryCode = “DE”). Bitte beachten Sie, dass IBAN obligatorisch ist, wenn PayTape=invoice oder PayType=installment. |
| ProductNr | n..8 | C | Profilnummer Pflicht bei PayType = "Account" oder "Installment" |
| InvoiceDate | an10 | O | Rechnungsdatum im Format JJJJ-MM-TT. Nur bei PayType = "ConsolidatedInvoice" |
Parameter für Riverty
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate 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: 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
| Key | Format | CND | Beschreibung |
|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| TransID | ans..18 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | Eindeutige Referenznummer |
| Status | a..50 | M | AUTHORIZE_REQUEST oder FAILED |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| 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! |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Code | an8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| CodeExt | n..10 | O | Fehlercode von Riverty, wenn mit The page Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro abgesprochen |
| ErrorText | ans..1024 | O | Fehlertext von Riverty, wenn mit The page Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro abgesprochen |
| BillingAddress | ans..1024 | O | Gegebenenfalls korrigierte Rechnungsadresse als JSON-String im Base64-Format. (siehe JSON-Objekte: Address) |
| ShippingAddress | ans..1024 | O | Gegebenenfalls korrigierte Lieferadresse als JSON-String im Base64-Format. (siehe JSON-Objekte: Address) |
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:
The page Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macroafterpaySCA.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:
| Key | Format | CND | Beschreibung |
|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| TransID | ans..18 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | Eindeutige Referenznummer |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Currency | a3 | M | Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| URLSuccess | ans..256 | M | Vollständige URL, die das Paygate 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.
|
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| URLFailure | ans..256 | M | Vollständige URL, die das Paygate 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.
|
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Response | a7 | O | Die Status-Rückmeldung, die das Paygate an URLSuccess und URLFailure sendet, sollte verschlüsselt werden. Dazu übergeben Sie den Parameter Response=encrypt. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| URLNotify | ans..256 | M | Vollständige URL, die das Paygate 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.
|
Key | Format | CND | Beschreibung |
|---|---|---|---|
| PayType | a..19 | M | Zahlungsmethode: „Invoice“ für Rechnung Für Lastschrift muss der Parameter PayType auf "Invoice" gesetzt und Parameter IBAN angegeben werden. |
| BIC | ans..11 | O | Bank Identifier Code (gültig bei AddrCountryCode = “DE”) |
| IBAN | ans..34 | C | International Bank Account Number (gültig bei AddrCountryCode = “DE”). Bitte beachten Sie, dass IBAN obligatorisch ist, wenn PayTape=invoice oder PayType=installment. |
| bdCompanyOrPerson | a..7 | O | Kundenkategorie: „Company“ für Unternehmen „Person“ für Personen (Standardwert) |
| SocialSecurityNumber | ans..16 | C | Pflicht: FI, NO, SE. Optional: AT, BE, CH, DE, DK, NL. Sozialversicherungsnummer bei einer Person in Schweden. Registrierungsnummer im Falle eines Unternehmens. Dieser Parameter ist mit dem Parameter bdCompanyOrPerson verknüpft. |
| LegalForm | ans..50 | O | Rechtsform des Unternehmens. Dieser Parameter ist mit dem Parameter bdCompanyOrPerson verknüpft. Mögliche Werte: Für Deutschland: AG, AG & Co. KG, eG, EK, e.V., GbR, GmbH, GmbH & Co. KG, KG, OHG, UG Für Österreich: AG, AG & Co. KG, eG, EK, e.V., GesbR, GmbH, GmbH & Co. KG, KG, OHG, UG Für die Schweiz: AG, eG, e.V. |
| AddrCountryCode | a2 | O | Ländercode: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE” |
| AddrZip | ans..10 | M | Postleitzahl |
| AddrStreet | ans..80 | M | Straße oder Packstation |
| AddrStreetNr | a..50 | O | Haus- oder Packstationsnummer |
| AddrStreetNr2 | ans..10 | O | Hausnummernzusatz |
| AddrCity | ans..100 | M | Ort |
| careOf | ans..50 | O | per Adresse. Vermittler, der für die Beförderung einer Postsendung vom Postsystem zum endgültigen Empfänger verantwortlich ist. Zum Beispiel Jane c/o John (“Jane an der Adresse von John”). Dieses Feld muss auch für Firmen-, Behörden- und Organisationsnamen verwendet werden – z. B. "Sportverein Blau-Weiß e.V." |
| FirstName | ans..50 | M | Vorname |
| LastName | ans..50 | M | Nachname |
| CustomerID | ans..20 | O | Eindeutige Kundennummer |
| Salutation | a..4 | O | Anrede: „Mr“ für Herr „Mrs“ für Frau „Miss“ für Fräulein |
| bdEmail | ans..100 | M | E-Mail-Adresse |
| bdPhone | ns..20 | O | Telefonnummer |
| bdMobileNo | ns..20 | M | Handynummer |
| DateOfBirth | an10 | M | Geburtsdatum im Format JJJJ-MM-TT. Für Firmen nicht zutreffend. |
| bdCompany | ans..50 | C | Name des kaufenden Unternehmens. Erforderlich, wenn bdCompanyOrPerson gleich 'Company' ist. Alles ab 50 Zeichen wird abgeschnitten. |
| VatID | ans..50 | C | Umsatzsteuer-Identifikationsnummer, die eindeutige Nummer, die ein Unternehmen identifiziert. Das Feld ist für die Abwicklung von B2B-Transaktionen für Deutschland obligatorisch. |
| CustomerRisk | ans..1024 | M | Risikorelevante Daten als JSON-String im Base64-Format (siehe JSON-Objekte: CustomerRisk) Händler können externe Risikoprüfungen durchführen und Riverty diese Informationen zusenden. |
| Language | a2 | O | Sprache: „NO“, „SE“, „FI“, „DK”, “EN”, “DE”, “NL”, “FR” zulässig |
| CompanyOrPerson | a..7 | C | Kundenkategorie der Lieferadresse: „Company“ für Unternehmen „Person“ für Personen (Standardwert) Erforderlich, falls eines der sd-Felder (siehe unten) angegeben wird. |
| sdCountryCode | a2 | O | Ländercode der Lieferadresse: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE” |
| sdZip | ans..10 | O | Postleitzahl der Lieferadresse |
| sdStreet | ans..80 | O | Straße oder Packstation der Lieferadresse |
| sdStreetNr | a..50 | O | Haus- oder Packstationsnummer der Lieferadresse |
| sdStreetNr2 | ans..10 | O | Straßennummernzusatz der Lieferadresse |
| sdCity | ans..100 | O | Ort der Lieferadresse |
| sdcareOf | ans..50 | O | per Adresse. Vermittler, der für die Beförderung einer Postsendung vom Postsystem zum endgültigen Empfänger verantwortlich ist. Zum Beispiel Jane c/o John (“Jane an der Adresse von John”). Dieses Feld muss auch für Firmen-, Behörden- und Organisationsnamen verwendet werden – z. B. "Sportverein Blau-Weiß e.V." |
| ShippingMethod | ans..50 | O | Adressentyp. Mögliche Werte: "Standard" (Standardwert), "PickUpPoint", "InStore" |
| sdFirstName | ans..50 | O | Vorname der Lieferadresse |
| sdLastName | ans..50 | O | Nachname der Lieferadresse |
| sdSalutation | a..4 | O | Anrede der Lieferadresse „Mr“ für Herr „Mrs“ für Frau „Miss“ für Fräulein Gültig bei AddrCountryCode = „DE“, „DK“,“NL“, „BE“, „AT“ oder „CH“ |
ans..100 | O | E-Mail-Adresse der Lieferadresse | |
| Phone | ns..50 | O | Telefonnummer der Lieferadresse |
| MobileNo | ns..50 | O | Handynummer der Lieferadresse |
| sdCompany | ans..50 | C | Name des kaufenden Unternehmens. Erforderlich, wenn CompanyOrPerson gleich 'Company' ist. Alles ab 50 Zeichen wird abgeschnitten. |
| Order | ans..1024 | M | Bestellinformationen als JSON-String im Format Base64. Siehe JSON-Objekt: Order |
Parameter für Zahlungen mit Riverty
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate 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: 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
| Key | Format | CND | Beschreibung |
|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| TransID | ans..18 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | Eindeutige Referenznummer |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) oder FAILED (URLFailure) |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| 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! |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Code | an8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| CodeExt | n..10 | O | Fehlercode von Riverty, wenn mit The page Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro abgesprochen |
| ErrorText | ans..1024 | O | Fehlertext von Riverty, wenn mit The page Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro abgesprochen |
| BillingAddress | ans..1024 | O | Gegebenenfalls korrigierte Rechnungsadresse als JSON-String im Base64-Format. (siehe JSON-Objekte: Address) |
| ShippingAddress | ans..1024 | O | Gegebenenfalls korrigierte Lieferadresse als JSON-String im Base64-Format. (siehe JSON-Objekte: Address) |
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:
The page Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macrocapture.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:
| Key | Format | CND | Beschreibung |
|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| PayID | an32 | M | Vom Paygate vergebene ID für die zu buchende Zahlung |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| TransID | ans..18 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | Eindeutige Referenznummer |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Currency | a3 | M | Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| OrderDesc | ans..768 | O | Beschreibung der gekauften Waren, Einzelpreise, Händlerkommentar etc. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| 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 Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück. Bitte beachten Sie, dass das Computop Paygate 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 Paygate 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 Paygate gelöscht. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| Order | ans..1024 | C | Pflicht bei Teilbuchung oder wenn sich die Bestellinformationen bei gleichem Gesamtbetrag geändert haben. Bestellinformationen als JSON-String im Format Base64. Siehe JSON-Objekt: Order |
| InvoiceNr | ans..30 | O | Wird nur berücksichtigt, wenn Order ebenfalls gesendet wird. Rechnungsnummer, die im Riverty-Portal angezeigt wird. Eine Bestellung kann mehrere Rechnungen enthalten. |
| ShippingData | ans..1024 | O | Wird nur berücksichtigt, wenn Order ebenfalls gesendet wird. Versandinformationen als JSON-String im Base64-Format. (siehe JSON-Objekte: ShippingData) |
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
| Key | Format | CND | Beschreibung |
|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| TransID | ans..18 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | Eindeutige Referenznummer |
| Status | a..50 | M | OK, CAPTURE_REQUEST oder FAILED |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| 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! |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Code | an8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| InvoiceNumber | ans..30 | O | Buchungsnummer: wird vom Händler erzeugt oder falls nicht verfügbar von Riverty. Sie ist für Teilgutschriften erforderlich. |
| CodeExt | n..10 | O | Fehlercode von Riverty, wenn mit The page Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro abgesprochen |
| ErrorText | ans..1024 | O | Fehlertext von Riverty, wenn mit The page Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro abgesprochen |
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:
The page Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macrocredit.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:
| Key | Format | CND | Beschreibung |
|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| PayID | an32 | M | Vom Paygate vergebene ID für die gutzuschreibende Zahlung |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| TransID | ans..18 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | Referenznummer (z.B. Rechnungsnummer), die für jede Retoure eindeutig sein muss |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Currency | a3 | M | Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| OrderDesc | ans..768 | O | Beschreibung der gekauften Waren, Einzelpreise, Händlerkommentar etc. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| 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 Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück. Bitte beachten Sie, dass das Computop Paygate 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 Paygate 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 Paygate gelöscht. |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| Order | ans..1024 | C | Pflicht bei Teilgutschriften Bestellinformationen als JSON-String im Format Base64. Siehe JSON-Objekt: RefundOrder |
| InvoiceNr | ans..30 | C | Wird nur berücksichtigt, wenn Order ebenfalls gesendet wird, ist dann allerdings Pflicht. Rechnungsnummer, die im Riverty-Portal angezeigt wird. Eine Bestellung kann mehrere Rechnungen enthalten. |
| RefundType | enum | O | Art der Gutschrift: Mögliche Werte sind „Refund“ und „Return“ Wird nur bei einer kompletten Gutschrift benötigt. |
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
| Key | Format | CND | Beschreibung |
|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| TransID | ans..18 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | Eindeutige Referenznummer des Händlers |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) oder FAILED (URLFailure) |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| 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! |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Code | an8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| CodeExt | n..10 | O | Fehlercode von Riverty, wenn mit The page Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro abgesprochen |
| ErrorText | ans..1024 | O | Fehlertext von Riverty, wenn mit The page Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro abgesprochen |
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:
The page Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macroreverse.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:
| Key | Format | CND | Beschreibung |
|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| PayID | an32 | M | Vom Paygate vergebene ID für die zu stornierende Zahlung |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| TransID | ans..18 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Currency | a3 | M | Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| 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 Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück. Bitte beachten Sie, dass das Computop Paygate 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 Paygate 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 Paygate gelöscht. |
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
| Key | Format | CND | Beschreibung |
|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| TransID | ans..18 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Currency | a3 | M | Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) oder FAILED (URLFailure) |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| 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! |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Code | an8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| CodeExt | n..10 | O | Fehlercode von Riverty, wenn mit The page Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro abgesprochen |
| ErrorText | ans..1024 | O | Fehlertext von Riverty, wenn mit The page Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro abgesprochen |
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:
Action | Version | Beschreibung |
|---|---|---|
| Capture | 1.0 / 2.0 | Standardversion ohne Rückgabe von Parameter Code |
1.x / 2.x | mit RefNr (gilt für alle Versionen außer 1.0) | |
Credit | 1.0 / 2.0 | Standardversion ohne Rückgabe von Parameter Code |
1.x / 2.x | mit RefNr (gilt für alle Versionen außer 1.0) | |
| Reverse | 1.0 / 2.0 | Standardversion ohne Rückgabe von Parameter Code |
1.x / 2.x | mit RefNr (gilt für alle Versionen außer 1.0) |
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:
Key | Format | CND | Beschreibung |
|---|---|---|---|
Type | a..11 | M | HEAD für Header, FOOT für Footer, AFTERPAY für Riverty |
Action | a..20 | M | Der Action-Parameter definiert die Art der Transaktion: Capture (Buchung) Credit (Gutschrift) Reverse (Storno) |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Currency | a3 | M | Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| TransID | ans..18 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | Eindeutige Referenznummer des Händlers |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| PayID | an32 | M | Vom Paygate vergebene ID für diese Transaktion |
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):
Key | Format | CND | Beschreibung |
|---|---|---|---|
Action | a..20 | M | Der Action-Parameter definiert die Art der Transaktion: Capture (Buchung) Credit (Gutschrift) Reverse (Storno) |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| PayID | an32 | M | Vom Paygate vergebene ID für diese Transaktion |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) oder FAILED (URLFailure) |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Code | an8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
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.
Key | Format | CND | Beschreibung |
|---|---|---|---|
| existingCustomer | bool | O | Gibt an, ob der Kunde ein für den Händler bereits existierender Kunde ist |
| verifiedCustomerIdentification | bool | O | Gibt an, ob der Kunde verifiziert wurde |
| marketingOptIn | bool | O | Gibt an, ob Marketing-Material erwünscht ist |
| customerSince | dttm | O | Datum, seit dem der Kunde existiert im Format JJJJ-MM-TT |
| customerClassification | ans..32 | O | Kundenklassifizierung |
| acquisitionChannel | enum | O | Gibt den genutzten Kanal an, um auf die Händlerseite zu gelangen. Mögliche Werte: „NotSet“, „Advertisment“, „SocialNetwork“, „Direct“, „SearchEngine“, “Other” |
| hasCustomerCard | bool | O | Gibt an, ob der Kunde eine Kundenkarte besitzt |
| customerCardSince | dttm | O | Datum, seit dem eine Kundenkarte existiert im Format JJJJ-MM-TT |
| customerCardClassification | ans..32 | O | Gibt den Level der Kundenkarte an, z.B. „Gold Member“ |
| profileTrackingId | ans..64 | O | Eindeutige TrackingID |
| ipAddress | ans..15 | M | IP-Adresse des Kunden |
| numberOfTransactions | n..5 | O | Anzahl der erfolgreichen Transaktionen, die der Kunden bereits getätigt hat |
| customerIndividualScore | n..5 | O | Vom Händler zur Verfügung gestellter individueller Score für den Kunden |
| userAgent | ans..32 | O | UserAgent dieses bestimmten Kunden |
| amountOfTransactions | n..5 | O | Betrag der bezahlten Bestellungen in den letzten 12 Monaten |
| otherPaymentMethods | bool | O | Andere Zahlungsmethode außer MI im Wallet |
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.
Key | Format | CND | Beschreibung |
|---|---|---|---|
| totalGrossAmount | ans..16 | M | Bruttobetrag der Bestellung. Muss gleich dem Wert aller Artikel aus items (grossUnitPrice * quantity) sein. Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
| currency | enum | O | Währung: Mögliche Werte sind „EUR“, „NOK“, „SEK“, „DKK“, „CHF“ |
| risk | ans..1024 | O | Risikorelevante Daten der Bestellung als JSON-String im Base64 (siehe JSON-Objekt: OrderRisk) |
| items | Array | M | Array von OrderItems (siehe JSON-Objekt: OrderItem) |
| totalNetAmount | ans..16 | M | Nettobetrag der Bestellung Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
| imageUrl | ans..256 | O | URL für ein Bild zur Bestellung. Dieses Bild kann auf der Rechnung oder neben der Ratenzahlung im Riverty-Portal gesehen werden. Beschränkt auf 100-1280px. |
OrderRisk
Hier werden die Informationen zum Risiko der Bestellung definiert.
Key | Format | CND | Beschreibung |
|---|---|---|---|
| channelType | ans..64 | O | Kanal der Bestellung. Mögliche Werte: "Internet", "Catalog", "CallCenter", "Stationary", "Other". |
| deliveryType | ans..64 | O | Typ der Lieferung. Mögliche Werte: "Normal", "Express". |
| ticketDeliveryMethod | ans..64 | O | Name der Ticket-Methode. Mögliche Werte: "NotSet", "PickUp", "Email", "Post", "Phone". |
OrderItem
Hier werden die Informationen zu einem Artikel definiert.
Key | Format | CND | Beschreibung |
|---|---|---|---|
| productId | ans..64 | M | Artikelnummer |
| description | ans..128 | M | Artikelbeschreibung |
| type | ans..64 | O | Typ des Artikels. Mögliche Werte: "PhysicalArticle", "DigitalArticle", "GiftCard", "Discount", "ShippingFee", "Surcharge", "Info" |
| quantity | n..8 | M | Artikelanzahl. Dezimalwerte, wenn mit The page Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro und Riverty abgesprochen. |
| grossUnitPrice | ans..16 | M | Bruttopreis pro Artikel Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
| grouId | ans..64 | O | GruppenID |
| netUnitPrice | ans..16 | M | Nettopreis pro Artikel Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
| unitCode | ans..16 | O | Einheit (z.B. Stück, Liter, Kilogramm, etc.) |
| vatCategory | enum | O | Umsatzsteuerkategorie Mögliche Werte: "HighCategory", "LowCategory", "NullCategory", "NoCategory", "MiddleCategory", "OtherCategory" |
| vatPercent | n..2 | M | Umsatzsteuer in Prozent |
| vatAmount | ans..16 | M | Umsatzsteuer als Betrag pro Artikel Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
| imageUrl | ans..256 | O | URL für ein Bild zur Bestellung. Dieses Bild kann auf der Rechnung oder neben der Ratenzahlung im Riverty-Portal gesehen werden. Beschränkt auf 100-1280px. |
googleProductCategoryId | n..16 | O | Google Product Category ID |
googleProductCategory | ans..64 | O | Google Product Category |
merchantProductType | ans..64 | O | Kategorisierung des Händlers ergänzend zur Google-Klassifizierung |
lineNumber | n.3 | O | Der Händler kann eine Zeilennummer für jeden Artikel angeben, um die Artikel zu sortieren |
discountAmount | ans..16 | O | Rabattbetrag (nur für statistische Zwecke) Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
productUrl | ans..256 | O | URL zum Artikel |
marketPlaceSellerId | ans..64 | O | ID eines bestimmten Marktplatzes |
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.
Key | Format | CND | Beschreibung |
|---|---|---|---|
| type | ans..32 | O | Verfügbare Zahlungsart Mögliche Werte: "Invoice", "Account", "Installment", "Consolidatedinvoice" |
| account | AccountProduct | O | Account-Informationen (siehe JSON-Objekt: AccountProduct) |
| directDebit | DirectDebitInfo | O | Direct-Debit-Informationen (siehe JSON-Objekt: DirectDebitInfo) |
| campaigns | Array | O | Array von Kampagnen-Informationen (siehe JSON-Objekt: CampaignInfo) |
| Installment | InstallmentInfo | O | Ratenkauf-Informationen (siehe JSON-Objekt: InstallmentInfo) |
| legalInfo | legalInfo | O | Legal info containing Terms and Conditions, Privacy statement, etc. (see JSON object: LegalInfo) |
AccountProduct
Hier werden die Informationen zu einem AccountProduct definiert.
Key | Format | CND | Beschreibung |
|---|---|---|---|
| profileNo | n..32 | M | Account-Profilnummer |
DirectDebitInfo
Hier werden die Informationen zu DirectDebitInfo definiert.
Key | Format | CND | Beschreibung |
|---|---|---|---|
| Available | bool | O | Gibt an, ob DirectDebit verfügbar ist |
CampaignInfo
Hier werden die Informationen zu CampaignInfo definiert.
Key | Format | CND | Beschreibung |
|---|---|---|---|
| campaignNo | n..32 | O | Kampagnennummer |
| description | ans..128 | O | Kampagnenbeschreibung |
InstallmentInfo
Hier werden die Informationen zu InstallmentInfo definiert.
Key | Format | CND | Beschreibung |
|---|---|---|---|
| basketAmount | enum | O | Verfügbare Zahlungsart Mögliche Werte: "Invoice", "Account", "Installment", "Consolidatedinvoice" Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
numberOfInstallments | n..2 | O | Anzahl der Raten |
installmentAmount | ans..16 | O | Ratenbetrag für jeden Monat Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
firstInstallmentAmount | ans..16 | O | Erster Ratenbetrag Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
lastInstallmentAmount | ans..16 | O | Letzter Ratenbetrag Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
interestRate | ans..16 | O | Zinssatz |
effectiveInterestRate | ans..16 | O | Effektiver Zinssatz |
effectiveAnnualPercentageRate | ans..16 | O | Effektiver jährlicher Prozentsatz |
totalInterestAmount | ans..16 | O | Gesamtzinssatz Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
startupFee | ans..16 | O | Anfangsgebühr |
monthlyFee | ans..16 | O | Monatliche Gebühr |
totalAmount | ans..16 | O | Gesamtbetrag |
installmentProfileNumber | ans..16 | O | Raten Profilnummer |
readMore | ans..128 | O | Weitere Informationen zum Ratenprozess |
LegalInfo
Hier werden die Informationen zu LegalInfo definiert.
Key | Format | CND | Beschreibung |
|---|---|---|---|
| requiresCustomerConsent | bool | O | "true", if customer consent is required |
termsAndConditionsUrl | ans..250 | O | URL to Terms and Conditions |
privacyStatementUrl | ans..250 | O | URL to Privacy Statement |
bgb507Url | ans..250 | O | URL to § 507 BGB |
text | ans..2500 | O | Legal text |
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.
Key | Format | CND | Beschreibung |
|---|---|---|---|
countryCode | enum | M | Ländercode Mögliche Werte: "NO“, „SE“, „FI“, „DK“, „DE“, „AT“, „CH“, „NL“, „BE“ |
postalCode | ans..10 | M | Postleitzahl |
postalPlace | ans..100 | M | Ort |
Street | ans..100 | M | Straße oder Packstation |
streetNumber | ans..10 | M | Haus- oder Packstationsnummer |
streetNumberAdditional | ans..10 | O | Hausnummernzusatz |
careOf | ans..50 | O | Verantwortlicher für den Versand der Sendung |
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.
Key | Format | CND | Beschreibung |
|---|---|---|---|
totalGrossAmount | ans..16 | O | Bruttobetrag der Bestellung. Muss gleich dem Wert aller Artikel aus items (grossUnitPrice * quantity) sein. Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
currency | enum | O | Währung. Mögliche Werte sind „EUR“, „NOK“, „SEK“, „DKK“, „CHF“ |
items | Array | O | Array von OrderItems (siehe JSON-Objekt: OrderItem) |
totalNetAmount | ans..16 | O | Nettobetrag der Bestellung Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
imageUrl | ans..256 | O | URL für ein Bild zur Bestellung. Dieses Bild kann auf der Rechnung oder neben der Ratenzahlung im Riverty-Portal gesehen werden. Beschränkt auf 100-1280px. |
googleAnalyticsUserId | ans..64 | O | Google Analytics UserID |
googleAnalyticsClientId | ans..64 | O | Google Analytics ClientID |
discountAmount | ans..16 | O | Rabattbetrag (nur für statistische Zwecke) Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
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.
Key | Format | CND | Beschreibung |
|---|---|---|---|
| shippingDetails | Array | M | Array von Versandinformationen (siehe JSON-Objekt: ShippingDetails) |
ShippingDetails
Hier werden die Informationen zu ShippingDetails definiert.
Key | Format | CND | Beschreibung |
|---|---|---|---|
| type | enum | M | Versandtyp: Mögliche Werte sind „Shipment“, „Return“ |
| shippingCompany | ans..64 | M | Versandunternehmen |
| trackingId | ans..64 | M | Eindeutige TrackingID |
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.
Key | Format | CND | Beschreibung |
|---|---|---|---|
| orderItems | Array | M | Array von Artikeln zum Gutschreiben (siehe JSON-Objekt: RefundOrderItem) |
RefundOrderItem
Hier werden die Informationen zu einem RefundOrderItem definiert.
Key | Format | CND | Beschreibung |
|---|---|---|---|
refundType | ans..32 | C | Gutschriftstyp: Mögliche Werte sind „Refund“, „Return“ |
productId | ans..64 | M | Artikelnummer |
description | ans..128 | M | Artikelbeschreibung |
quantity | n..8 | M | Artikelanzahl. Dezimalwerte, wenn mit The page Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro und Riverty abgesprochen. |
grossUnitPrice | ans..16 | M | Bruttopreis pro Artikel Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
groupId | ans..64 | O | GruppenID |
netUnitPrice | ans..16 | M | Nettopreis pro Artikel Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
unitCode | ans..16 | O | Einheit (z.B. Stück, Liter, Kilogramm, etc.) |
vatCategory | ans..32 | O | Umsatzsteuerkategorie Mögliche Werte: "HighCategory", "LowCategory", "NullCategory", "NoCategory", "MiddleCategory", "OtherCategory" |
vatPercent | n..2 | M | Umsatzsteuer in Prozent |
vatAmount | ans..16 | M | Umsatzsteuer als Betrag pro Artikel Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
imageUrl | ans..256 | O | URL für ein Bild zur Bestellung. Dieses Bild kann auf der Rechnung oder neben der Ratenzahlung im Riverty-Portal gesehen werden. Beschränkt auf 100-1280px. |
googleProductCategoryId | n..16 | O | Google Product Category ID |
googleProductCategory | ans..64 | O | Google Product Category |
merchantProductType | ans..64 | O | Kategorisierung des Händlers ergänzend zur Google-Klassifizierung |
lineNumber | n.3 | O | Der Händler kann eine Zeilennummer für jeden Artikel angeben, um die Artikel zu sortieren |
discountAmount | ans..16 | O | Rabattbetrag (nur für statistische Zwecke) Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
productUrl | ans..256 | O | URL zum Artikel |
marketPlaceSellerId | ans..64 | O | ID eines bestimmten Marktplatzes |
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
}
]