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

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


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

afterpay.aspx


Key

Format

CND

Beschreibung

TransIDans..18C

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 vergebene ID für die Zahlung, in deren Rahmen Waren zurückgegeben wurden.

Der Parameter wird nur für EventToken="Return" benötigt.

InvoiceNrans..30C

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

EventTokena..19M

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

AddrCountryCodea2M

Ländercode

„NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”

Orderans..1024M

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


Key

Format

CND

Beschreibung

TransIDans..18MTransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

ns..30

O

Eindeutige Referenznummer

Key

Format

CND

Beschreibung

CodeExt

n..10

O

Fehlercode von Riverty, wenn mit abgesprochen

ErrorText

ans..1024

O

Fehlertext von Riverty, wenn mit 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:

afterpaySCA.aspx


Key

Format

CND

Beschreibung

TransIDans..18MTransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

ns..30

O

Eindeutige Referenznummer

Key

Format

CND

Beschreibung

PayTypea..19M

Zahlungsmethode:

„Invoice“ für Rechnung
„Account“ für flexibler Zahlungsplan
„Installment“ für Ratenzahlungen
„ConsolidatedInvoice“ für konsolidierte 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.

LegalFormans..50O

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.

AddrCountryCodea2O

Ländercode:

„NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”

AddrZipans..10MPostleitzahl
AddrStreet

ans..80

M

Straße oder Packstation
AddrStreetNr

a..50

O

Haus- oder Packstationsnummer
AddrStreetNr2

ans..10

O

Hausnummernzusatz
AddrCityans..100MOrt
careOfans..50O

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

FirstNameans..50MVorname
LastNameans..50MNachname
CustomerIDans..20OEindeutige Kundennummer
Salutationa..4O

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.
bdCompanyans..255C

Name des kaufenden Unternehmens.

Erforderlich, wenn bdCompanyOrPerson gleich 'Company' ist.

VatIDans..50C

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
CompanyOrPersona..7C

Kundenkategorie der Lieferadresse:

„Company“ für Unternehmen

„Person“ für Personen (Standardwert)

Erforderlich, falls eines der sd-Felder (siehe unten) angegeben wird.

sdCountryCodea2OLä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
sdcareOfans..50O

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

ShippingMethodans..50O

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“

Email

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.
sdCompanyans..50C

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"

InvoiceDatean10O

Rechnungsdatum im Format JJJJ-MM-TT.

Nur bei PayType = "ConsolidatedInvoice"

Parameter für Riverty


Key

Format

CND

Beschreibung

TransIDans..18MTransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

ns..30

O

Eindeutige Referenznummer

Statusa..50MAUTHORIZE_REQUEST oder FAILED

Key

Format

CND

Beschreibung

CodeExt

n..10

O

Fehlercode von Riverty, wenn mit abgesprochen

ErrorText

ans..1024

O

Fehlertext von Riverty, wenn mit   abgesprochen

BillingAddressans..1024O

Gegebenenfalls korrigierte Rechnungsadresse als JSON-String im Base64-Format.

(siehe JSON-Objekte: Address)

ShippingAddressans..1024O

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:

afterpaySCA.aspx


Key

Format

CND

Beschreibung

TransIDans..18MTransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

ns..30

O

Eindeutige Referenznummer

Key

Format

CND

Beschreibung

PayTypea..19M

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.

LegalFormans..50O

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.

AddrCountryCodea2O

Ländercode:

„NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”

AddrZipans..10MPostleitzahl
AddrStreet

ans..80

M

Straße oder Packstation
AddrStreetNr

a..50

O

Haus- oder Packstationsnummer
AddrStreetNr2

ans..10

O

Hausnummernzusatz
AddrCityans..100MOrt
careOfans..50O

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

FirstNameans..50MVorname
LastNameans..50MNachname
CustomerIDans..20OEindeutige Kundennummer
Salutationa..4O

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.
bdCompanyans..50C

Name des kaufenden Unternehmens.

Erforderlich, wenn bdCompanyOrPerson gleich 'Company' ist. Alles ab 50 Zeichen wird abgeschnitten.

VatIDans..50C

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
CompanyOrPersona..7C

Kundenkategorie der Lieferadresse:

„Company“ für Unternehmen

„Person“ für Personen (Standardwert)

Erforderlich, falls eines der sd-Felder (siehe unten) angegeben wird.

sdCountryCodea2OLä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
sdcareOfans..50O

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

ShippingMethodans..50O

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“

Email

ans..100

O

E-Mail-Adresse der Lieferadresse
Phone

ns..50

O

Telefonnummer der Lieferadresse
MobileNo

ns..50

O

Handynummer der Lieferadresse
sdCompanyans..50C

Name des kaufenden Unternehmens.

Erforderlich, wenn CompanyOrPerson gleich 'Company' ist. Alles ab 50 Zeichen wird abgeschnitten.

Orderans..1024M

Bestellinformationen als JSON-String im Format Base64.

Siehe JSON-Objekt: Order

Parameter für Zahlungen mit Riverty


Key

Format

CND

Beschreibung

TransIDans..18MTransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

ns..30

O

Eindeutige Referenznummer

Key

Format

CND

Beschreibung

CodeExt

n..10

O

Fehlercode von Riverty, wenn mit abgesprochen

ErrorText

ans..1024

O

Fehlertext von Riverty, wenn mit abgesprochen

BillingAddressans..1024O

Gegebenenfalls korrigierte Rechnungsadresse als JSON-String im Base64-Format.

(siehe JSON-Objekte: Address)

ShippingAddressans..1024O

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:

capture.aspx


Key

Format

CND

Beschreibung

TransIDans..18MTransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

ns..30

O

Eindeutige Referenznummer

Key

Format

CND

Beschreibung

OrderDescans..768OBeschreibung der gekauften Waren, Einzelpreise, Händlerkommentar etc.

Key

Format

CND

Beschreibung

Orderans..1024C

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

InvoiceNrans..30O

Wird nur berücksichtigt, wenn Order ebenfalls gesendet wird.

Rechnungsnummer, die im Riverty-Portal angezeigt wird. Eine Bestellung kann mehrere Rechnungen enthalten.

ShippingDataans..1024O

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


Key

Format

CND

Beschreibung

TransIDans..18MTransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

ns..30

O

Eindeutige Referenznummer

Statusa..50MOK, CAPTURE_REQUEST oder FAILED

Key

Format

CND

Beschreibung

InvoiceNumberans..30OBuchungsnummer: 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 abgesprochen

ErrorText

ans..1024

O

Fehlertext von Riverty, wenn mit abgesprochen

Ergebnis-Parameter für Riverty-Buchungen


Gutschrift mit Referenz

credit.aspx


Key

Format

CND

Beschreibung

TransIDans..18MTransaktionsID, 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

OrderDescans..768OBeschreibung der gekauften Waren, Einzelpreise, Händlerkommentar etc.

Key

Format

CND

Beschreibung

Orderans..1024C

Pflicht bei Teilgutschriften

Bestellinformationen als JSON-String im Format Base64.

Siehe JSON-Objekt: RefundOrder

InvoiceNrans..30C

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.

RefundTypeenumO

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


Key

Format

CND

Beschreibung

TransIDans..18MTransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

ns..30

O

Eindeutige Referenznummer des Händlers

Key

Format

CND

Beschreibung

CodeExt

n..10

O

Fehlercode von Riverty, wenn mit abgesprochen

ErrorText

ans..1024

O

Fehlertext von Riverty, wenn mit 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:

reverse.aspx


Key

Format

CND

Beschreibung

TransIDans..18MTransaktionsID, die für jede Zahlung eindeutig sein muss

Key

Format

CND

Beschreibung

Orderans..1024C

Pflicht bei Teilstornierungen

Bestellinformationen als JSON-String im Format Base64.

Siehe JSON-Objekt: Order

Parameter für Storno von Riverty-Zahlungen


Key

Format

CND

Beschreibung

TransIDans..18MTransaktionsID, die für jede Zahlung eindeutig sein muss

Key

Format

CND

Beschreibung

CodeExt

n..10

O

Fehlercode von Riverty, wenn mit abgesprochen

ErrorText

ans..1024

O

Fehlertext von Riverty, wenn mit abgesprochen

Ergebnis-Parameter für Storno von Riverty-Zahlungen


Batch-Nutzung der Schnittstelle

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:


Beispiel für Master-MID-Funktion:


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

TransIDans..18MTransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

ns..30

O

Eindeutige Referenznummer des Händlers

Beschreibung der Felder im Datensatz von Batch-Dateien


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


Key

Format

CND

Beschreibung

Action

a..20

M

Der Action-Parameter definiert die Art der Transaktion:

Capture (Buchung)

Credit (Gutschrift)

Reverse (Storno)

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:

https://wiki.selfhtml.org/wiki/JavaScript/JSON


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
existingCustomerboolOGibt 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
userAgentans..32OUserAgent dieses bestimmten Kunden
amountOfTransactionsn..5OBetrag der bezahlten Bestellungen in den letzten 12 Monaten
otherPaymentMethodsboolOAndere Zahlungsmethode außer MI im Wallet

Beispiel CustomerRisk als JSON-String



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

ticketDeliveryMethodans..64O

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

MArtikelnummer
description

ans..128

M

Artikelbeschreibung
typeans..64O

Typ des Artikels. Mögliche Werte:

"PhysicalArticle", "DigitalArticle", "GiftCard", "Discount", "ShippingFee", "Surcharge", "Info"

quantity

n..8

M

Artikelanzahl.

Dezimalwerte, wenn mit 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



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)
legalInfolegalInfoOLegal 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
profileNon..32MAccount-Profilnummer

DirectDebitInfo

Hier werden die Informationen zu DirectDebitInfo definiert.

Key

Format

CND

Beschreibung
AvailableboolOGibt an, ob DirectDebit verfügbar ist

CampaignInfo

Hier werden die Informationen zu CampaignInfo definiert.

Key

Format

CND

Beschreibung
campaignNo

n..32

OKampagnennummer
description

ans..128

OKampagnenbeschreibung

InstallmentInfo

Hier werden die Informationen zu InstallmentInfo definiert.

Key

Format

CND

Beschreibung
basketAmountenumO

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



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



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



ShippingData

Hier werden die Informationen zum Versand in einem Array definiert.

Key

Format

CND

Beschreibung
shippingDetailsArrayMArray 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



RefundOrder

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

Key

Format

CND

Beschreibung
orderItemsArrayMArray 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 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