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

Diagramm zum Prozessablauf


Auf dieser Seite


Paygate-Schnittstelle

Definitionen

Datenformate

FormatBeschreibung

a

alphabetisch

as

alphabetisch mit Sonderzeichen

n

numerisch

an

alphanumerisch

ans

alphanumerisch mit Sonderzeichen

ns

numerisch mit Sonderzeichen

bool

Bool’scher Ausdruck (true oder false)

3

feste Länge mit 3 Stellen/Zeichen

..3

variable Länge mit maximal 3 Stellen/Zeichen

enum

Aufzählung erlaubter Werte

dttm

ISODateTime (JJJJ-MM-TTThh:mm:ss)


Abkürzungen

AbkürzungBeschreibungKommentar

CND

Bedingung (condition)


M

Pflicht (mandatory)

Wenn ein Parameter Pflicht ist, dann muss er vorhanden sein

O

optional

Wenn ein Parameter optional ist, dann kann er vorhanden sein, ist aber nicht erforderlich

C

bedingt (conditional)

Wenn ein Parameter bedingt ist, dann gibt es eine Bedingungsregel, die angibt, ob er Pflicht oder optional ist


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


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

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

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

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


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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

Key

REST

Format

CND

Description

Beschreibung

TransID"transactionId": "..."ans..18C

TransactionID which should be unique for each payment.

The parameter is not required for EventToken="Return".

TransaktionsID, die für jede Zahlung eindeutig sein muss.

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

RefNr

"referenceNumber": "..."

ns..30

C

Unique reference number.

The parameter is not required for EventToken="Return".

Eindeutige Referenznummer.

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

PayID"paymentId": "..."

an32

C

ID assigned by Paygate for the payment in scope of which goods were returned.

The parameter is required only for EventToken="Return".

Vom Paygate vergebene ID für die Zahlung, in deren Rahmen Waren zurückgegeben wurden.

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

InvoiceNr"order": {"number": "..."}ans..30C

Invoice number that is displayed within Riverty portal. An order can contain more than one invoice.

The parameter is required only for EventToken="Return".

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

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

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "currency": "..."}

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

KeyRESTFormatCNDDescriptionBeschreibung

MAC

---

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

Key

REST

Format

CND

Description

Beschreibung

EventToken"payment": {"riverty": {"eventToken": "..." }}a..19M

The two-stage process is triggered by the transfer of "PAYMENTMETHODS".

Value "Return" triggers return notification (merchant notifies Riverty that a customer has returned some goods, and a payment from the customer should not be expected by Riverty).

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"billing": {"addressInfo": { "country": {"A2"= "..." }}}a2M

Country code

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

Ländercode

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

Order"order": JSONans..1024M

Order information as JSON string in Base64 format.

See JSON object: Order

For EventToken="Return", see JSON object RefundOrder

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:

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

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

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyRESTFormatCNDDescriptionBeschreibung
XID"xId": "..."

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

Key

REST

Format

CND

Description

Beschreibung

TransID"transactionId": "..."ans..18MTransactionID which should be unique for each paymentTransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

"referenceNumber": "..."

ns..30

O

Unique reference number

Eindeutige Referenznummer

KeyRESTFormatCNDDescriptionBeschreibung
Status

"status": "OK"

"status": "AUTHORIZED"

"status": "FAILED"

a..50

M

OK or AUTHORIZED (URLSuccess) as well as FAILED (URLFailure)

OK oder AUTHORIZED (URLSuccess) sowie FAILED (URLFailure)

KeyRESTFormatCNDDescriptionBeschreibung
Description"description": "..."

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyRESTFormatCNDDescriptionBeschreibung
Code"code": ...

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

Key

REST

Format

CND

Description

Beschreibung

CodeExt"externalErrorCode": ...

n..10

O

Error code from Riverty, if agreed with Computop Helpdesk

Fehlercode von Riverty, wenn mit Computop Helpdesk abgesprochen

ErrorText"payment": {"rivertyErrorText": "..."}

ans..1024

O

Error text from Riverty, if agreed with Computop Helpdesk

Fehlertext von Riverty, wenn mit Computop Helpdesk abgesprochen

AllowedPayMethods"payment": {"paymentMethods": "..."}

ans..1024

O

Permissible payment methods as JSON string in the Base64 format

(see JSON objects: AllowedPayMethods)

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:

https://www.computop-paygate.com/afterpaySCA.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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

Key

REST

Format

CND

Description

Beschreibung

TransID"transactionId": "..."ans..18MTransactionID which should be unique for each paymentTransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

"referenceNumber": "..."

ns..30

O

Unique reference number

Eindeutige Referenznummer

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "currency": "..."}

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

KeyRESTFormatCNDDescriptionBeschreibung

MAC

---

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyFormatCNDDescriptionBeschreibung
URLSuccess

ans..256

M

Complete URL which calls up Paygate if payment has been successful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

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.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

KeyFormatCNDDescriptionBeschreibung
URLFailure

ans..256

M

Complete URL which calls up Paygate if payment has been unsuccessful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Vollständige URL, die das Paygateaufruft, 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.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

KeyFormatCNDDescriptionBeschreibung
Response

a7

O

Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.

Die Status-Rückmeldung, die das Paygate an URLSuccess und URLFailure sendet, sollte verschlüsselt werden. Dazu übergeben Sie den Parameter Response=encrypt.

KeyFormatCNDDescriptionBeschreibung
URLNotify

ans..256

M

Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443. It may not contain parameters: Use the UserData parameter instead.

(info) Common notes:

  • Fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

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.

(info) Allgemeine Hinweise:

  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

Key

REST

Format

CND

Description

Beschreibung

PayType"payment": {"riverty": {"paymentType": "..." }}a..19M

Payment method:

"Invoice" for Invoice
"Account" for flexible payment plan
"Installment" for payment by instalment
"ConsolidatedInvoice" for consolidated invoice

For Direct Debit option parameter PayType has to be set to "Invoice" and parameter IBAN has to be filled.

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

Customer category:

„Company“

„Person“ (default value)

Kundenkategorie:

„Company“ für Unternehmen

„Person“ für Personen (Standardwert)

SocialSecurityNumber

"billing": {"consumer": {"socialSecurityNumber": "..." }}

"billing": {"business": {"registrationNumber": "..." }}

ans..16

C

Required: FI, NO, SE. Optional: AT, BE, CH, DE, DK, NL.

Social security number for a person in Sweden. Registration number in case of a company. This parameter is linked to the parameter bdCompanyOrPerson.

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"billing": {"business": {"companyLegalForm": "..." }}ans..50O

Legal form of company. This parameter is linked to the parameter bdCompanyOrPerson.

Possible values:

For Germany: AG, AG & Co. KG, eG, EK,  e.V., GbR, GmbH, GmbH & Co. KG, KG, OHG, UG

For Austria: AG, AG & Co. KG, eG, EK,  e.V., GesbR, GmbH, GmbH & Co. KG, KG, OHG, UG

For Switzerland: AG, eG, e.V.

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"billing": {"addressInfo": { "country": { "A2": "..." } }}a2O

Country code:

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

Ländercode:

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

AddrZip"billing": {"addressInfo": {"postalCode": "..." }}ans..10MPostcodePostleitzahl
AddrStreet"billing": {"addressInfo": {"addressLine1": { "street": "..." } }}

ans..80

M

Street name or packstation

Straße oder Packstation
AddrStreetNr"billing": {"addressInfo": {"addressLine1": { "streetNumber": "..." } }}

a..50

O

Street number or packstation number

Haus- oder Packstationsnummer
AddrStreetNr2"billing": {"addressInfo": { "addressLine2": "..." }}

ans..10

O

Street number addition

Hausnummernzusatz
AddrCity"billing": {"addressInfo": { "city": "..." }}ans..100MCityOrt
careOf"payment": {"riverty": {"billingCareO": "..." }}ans..50O

Care of.

Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”). This field has to be used for company, authority and organization names as well – e. g. "Sportverein Blau-Weiß e.V."

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"billing": {"consumer": {"firstName": "..." }}ans..50MFirst nameVorname
LastName"billing": {"consumer": {"lastName": "..." }}ans..50MLast nameNachname
CustomerID"billing": {"consumer": {"customerId": "..." }}ans..20OUnique customer numberEindeutige Kundennummer
Salutation"billing": {"consumer": {"salutation": "..." }}a..4O

Salutation:

„Mr“

„Mrs“

„Miss“

Anrede:

„Mr“ für Herr

„Mrs“ für Frau

„Miss“ für Fräulein

bdEmail"billing": {"contactInfo": {"email": "..." }}

ans..100

M

E-mail address

E-Mail-Adresse
bdPhone"billing": {"contactInfo": {"phone": ... }}

ns..20

O

Telephone number

Telefonnummer
bdMobileNo"billing": {"contactInfo": {"mobilePhone": ... }}

ns..20

M

Mobile number

Handynummer
DateOfBirth"billing": {"contactInfo": {"birthdate": "..." }}

an10

M

Date of birth in the format YYYY-MM-DD. Not applicable to companies.

Geburtsdatum im Format JJJJ-MM-TT. Für Firmen nicht zutreffend.
bdCompany"billing": {"business": {"companyLegalName": "..." }}ans..255C

Purchasing company name.

Required if bdCompanyOrPerson is 'Company'.

Name des kaufenden Unternehmens.

Erforderlich, wenn bdCompanyOrPerson gleich 'Company' ist.

VatID"payment": {"riverty": {"vatId": "..." }}ans..50C

VAT registration number, the unique number that identifies a business.

The field is mandatory for processing B2B transactions for Germany. 

Umsatzsteuer-Identifikationsnummer, die eindeutige Nummer, die ein Unternehmen identifiziert.

Das Feld ist für die Abwicklung von B2B-Transaktionen für Deutschland obligatorisch.

CustomerRisk"payment": {"riverty": {"customerRisk": "..." }}

ans..1024

M

Risk-relevant data as JSON string in Base64 format (see JSON objects: CustomerRisk)

Merchants can conduct external risk checks and send this information to Riverty.

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

a2

O

Language: "NO", "SE", "FI", "DK”, "EN”, "DE”, "NL”, "FR” permittedSprache: „NO“, „SE“, „FI“, „DK”, “EN”, “DE”, “NL”, “FR” zulässig
CompanyOrPerson

"companyOrPerson": "Company"

"companyOrPerson": ""

a..7C

Customer category for delivery address:

„Company“

„Person“ (default value)

Requred if any of sd-fields (refer below) is provided.

Kundenkategorie der Lieferadresse:

„Company“ für Unternehmen

„Person“ für Personen (Standardwert)

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

sdCountryCode"shipping": {"addressInfo": { "country": { "A2": "..." } }}a2OCountry code of the delivery address: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”Ländercode der Lieferadresse: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”
sdZip"shipping": {"addressInfo": {"postalCode": "..." }}

ans..10

O

Postcode in the delivery address

Postleitzahl der Lieferadresse
sdStreet"shipping": {"addressInfo": {"addressLine1": { "street": "..." } }}

ans..80

O

Street name or packstation of the delivery address

Straße oder Packstation der Lieferadresse
sdStreetNr"shipping": {"addressInfo": {"addressLine1": { "streetNumber": "..." } }}

a..50

O

Street number or packstation number of the delivery address

Haus- oder Packstationsnummer der Lieferadresse
sdStreetNr2"shipping": {"addressInfo": { "addressLine2": "..." }}

ans..10

O

Street number addition of the delivery address

Straßennummernzusatz der Lieferadresse
sdCity"shipping": {"addressInfo": { "city": "..." }}

ans..100

O

Town/city of the delivery address

Ort der Lieferadresse
sdcareOf"payment": {"riverty": {"shippingCareO": "..." }}ans..50O

Care of.

Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”). This field has to be used for company, authority and organization names as well – e. g. "Sportverein Blau-Weiß e.V."

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"payment": {"riverty": {"shippingMethod": "..." }}ans..50O

Address type.

Possible values: "Standard" (default value), "PickUpPoint", "InStore"

Adressentyp.

Mögliche Werte: "Standard" (Standardwert), "PickUpPoint", "InStore"

sdFirstName"shipping": {"consumer": {"firstName": "..." }}

ans..50

O

First name in the delivery address

Vorname der Lieferadresse
sdLastName"shipping": {"consumer": {"lastName": "..." }}

ans..50

O

Last name in the delivery address

Nachname der Lieferadresse
sdSalutation"shipping": {"consumer": {"salutation": "..." }}

a..4

O

Salutation in the delivery address

„Mr“

„Mrs“

„Miss“

Valid for AddrCountryCode = „DE“, „DK“,“NL“, „BE“, „AT“ or „CH“

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"shipping": {"contactInfo": {"email": "..." }}

ans..100

O

E-mail address of the delivery addressE-Mail-Adresse der Lieferadresse
Phone"shipping": {"contactInfo": {"phone": "..." }}

ns..50

C

Phone number in the delivery address and mandatory request data if the merchant will process the OTP/SCA flow. (currently Riverty support only OTP instead of SCA for DE).

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"shipping": {"contactInfo": {"mobilePhone": "..." }}

ns..50

C

Mobile number of the delivery address and mandatory request data if the merchant will process the SCA flow.

Handynummer der Lieferadresse und Pflichtparameter, wenn der Händler den SCA-Abaluf verarbeitet.
sdCompany"shipping": {"business": {"companyLegalName": "..." }}ans..50C

Delivery company name.

Required if CompanyOrPerson is 'Company'. Everything over 50 characters will be truncated.

Name des kaufenden Unternehmens.

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

BIC"payment": {"riverty": { "account": { "code": "..." } }}

ans..11

O

Bank Identifier Code (valid for AddrCountryCode = “DE”)

Bank Identifier Code (gültig bei AddrCountryCode = “DE”)
IBAN"payment": {"riverty": { "account": { "number": "..." } }}

ans..34

C

International Bank Account Number (valid for AddrCountryCode = “DE”).

Please note, that IBAN is mandatory if PayTape=invoice or PayType=installment.

International Bank Account Number (gültig bei AddrCountryCode = “DE”).

Bitte beachten Sie, dass IBAN obligatorisch ist, wenn PayTape=invoice oder PayType=installment.

ProductNr"payment": {"riverty": {"profileNumber": ... }}

n..8

C

Profile number

Obligatory for PayType = "Account" or "Installment"

Profilnummer

Pflicht bei PayType = "Account" oder "Installment"

InvoiceDate"order": {"creationDate": "..."}an10O

Date of invoice in the format YYYY-MM-DD.

Only for PayType = "ConsolidatedInvoice"

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:

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

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

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyRESTFormatCNDDescriptionBeschreibung
XID"xId": "..."

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

Key

REST

Format

CND

Description

Beschreibung

TransID"transactionId": "..."ans..18MTransactionID which should be unique for each paymentTransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

"referenceNumber": "..."

ns..30

O

Unique reference number

Eindeutige Referenznummer

Status

"status": "AUTHORIZE_REQUEST"

"status": "FAILED"

a..50MAUTHORIZE_REQUEST or FAILEDAUTHORIZE_REQUEST oder FAILED

KeyRESTFormatCNDDescriptionBeschreibung
Description"description": "..."

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyRESTFormatCNDDescriptionBeschreibung
Code"code": ...

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

Key

REST

Format

CND

Description

Beschreibung

CodeExt"payment": {"riverty": {"errorCode": ... }}

n..10

O

Error code from Riverty, if agreed with Computop Helpdesk

Fehlercode von Riverty, wenn mit Computop Helpdesk abgesprochen

ErrorText"payment": {"riverty": {"errorText": ... }}

ans..1024

O

Error text from Riverty, if agreed with Computop Helpdesk

Fehlertext von Riverty, wenn mit Computop Helpdesk   abgesprochen

BillingAddress"payment": {"billing": JSON }ans..1024O

If necessary corrected billing address as JSON string in the Base64 format

(see JSON objects: Address)

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

(siehe JSON-Objekte: Address)

ShippingAddress"payment": {"shipping": JSON }ans..1024O

If necessary corrected shipping address as JSON string in the Base64 format

(see JSON objects: Address)

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:

https://www.computop-paygate.com/afterpaySCA.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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

Key

REST

Format

CND

Description

Beschreibung

TransID"transactionId": "..."ans..18MTransactionID which should be unique for each paymentTransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

"referenceNumber": "..."

ns..30

O

Unique reference number

Eindeutige Referenznummer

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "currency": "..."}

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

KeyRESTFormatCNDDescriptionBeschreibung

MAC

---

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyFormatCNDDescriptionBeschreibung
URLSuccess

ans..256

M

Complete URL which calls up Paygate if payment has been successful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

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.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

KeyFormatCNDDescriptionBeschreibung
URLFailure

ans..256

M

Complete URL which calls up Paygate if payment has been unsuccessful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Vollständige URL, die das Paygateaufruft, 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.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

KeyFormatCNDDescriptionBeschreibung
Response

a7

O

Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.

Die Status-Rückmeldung, die das Paygate an URLSuccess und URLFailure sendet, sollte verschlüsselt werden. Dazu übergeben Sie den Parameter Response=encrypt.

KeyFormatCNDDescriptionBeschreibung
URLNotify

ans..256

M

Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443. It may not contain parameters: Use the UserData parameter instead.

(info) Common notes:

  • Fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

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.

(info) Allgemeine Hinweise:

  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

Key

REST

Format

CND

Description

Beschreibung

PayType"payment": {"riverty": {"paymentType": "..." }}a..19M

Payment method:

"Invoice" for Invoice

For Direct Debit option parameter PayType has to be set to "Invoice" and parameter IBAN has to be filled.

Zahlungsmethode:

„Invoice“ für Rechnung

Für Lastschrift muss der Parameter PayType auf "Invoice" gesetzt und Parameter IBAN angegeben werden.

BIC"payment": {"riverty": { "account": { "code": "..." } }}

ans..11

O

Bank Identifier Code (valid for AddrCountryCode = “DE”)

Bank Identifier Code (gültig bei AddrCountryCode = “DE”)
IBAN"payment": {"riverty": { "account": { "number": "..." } }}

ans..34

C

International Bank Account Number (valid for AddrCountryCode = “DE”).

Please note, that IBAN is mandatory if PayTape=invoice or PayType=installment.

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

Customer category:

„Company“

„Person“ (default value)

Kundenkategorie:

„Company“ für Unternehmen

„Person“ für Personen (Standardwert)

SocialSecurityNumber

"billing": {"consumer": {"socialSecurityNumber": "..." }}

"billing": {"business": {"registrationNumber": "..." }}

ans..16

C

Required: FI, NO, SE. Optional: AT, BE, CH, DE, DK, NL.

Social security number for a person in Sweden. Registration number in case of a company. This parameter is linked to the parameter bdCompanyOrPerson.

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"billing": {"business": {"companyLegalForm": "..." }}ans..50O

Legal form of company. This parameter is linked to the parameter bdCompanyOrPerson.

Possible values:

For Germany: AG, AG & Co. KG, eG, EK,  e.V., GbR, GmbH, GmbH & Co. KG, KG, OHG, UG

For Austria: AG, AG & Co. KG, eG, EK,  e.V., GesbR, GmbH, GmbH & Co. KG, KG, OHG, UG

For Switzerland: AG, eG, e.V.

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"billing": {"addressInfo": { "country": { "A2": "..." } }}a2O

Country code:

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

Ländercode:

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

AddrZip"billing": {"addressInfo": {"postalCode": "..." }}ans..10MPostcodePostleitzahl
AddrStreet"billing": {"addressInfo": {"addressLine1": { "street": "..." } }}

ans..80

M

Street name or packstation

Straße oder Packstation
AddrStreetNr"billing": {"addressInfo": {"addressLine1": { "streetNumber": "..." } }}

a..50

O

Street number or packstation number

Haus- oder Packstationsnummer
AddrStreetNr2"billing": {"addressInfo": { "addressLine2": "..." }}

ans..10

O

Street number addition

Hausnummernzusatz
AddrCity"billing": {"addressInfo": { "city": "..." }}ans..100MCityOrt
careOf"payment": {"riverty": {"billingCareO": "..." }}ans..50O

Care of.

Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”). This field has to be used for company, authority and organization names as well – e. g. "Sportverein Blau-Weiß e.V."

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"billing": {"consumer": {"firstName": "..." }}ans..50MFirst nameVorname
LastName"billing": {"consumer": {"lastName": "..." }}ans..50MLast nameNachname
CustomerID"billing": {"consumer": {"customerId": "..." }}ans..20OUnique customer numberEindeutige Kundennummer
Salutation"billing": {"consumer": {"salutation": "..." }}a..4O

Salutation:

„Mr“

„Mrs“

„Miss“

Anrede:

„Mr“ für Herr

„Mrs“ für Frau

„Miss“ für Fräulein

bdEmail"billing": {"contactInfo": {"email": "..." }}

ans..100

M

E-mail address

E-Mail-Adresse
bdPhone"billing": {"contactInfo": {"phone": ... }}

ns..20

O

Telephone number

Telefonnummer
bdMobileNo"billing": {"contactInfo": {"mobilePhone": ... }}

ns..20

M

Mobile number

Handynummer
DateOfBirth"billing": {"contactInfo": {"birthdate": "..." }}

an10

M

Date of birth in the format YYYY-MM-DD. Not applicable to companies.

Geburtsdatum im Format JJJJ-MM-TT. Für Firmen nicht zutreffend.
bdCompany"billing": {"business": {"companyLegalName": "..." }}ans..50C

Purchasing company name.

Required if bdCompanyOrPerson is 'Company'. Everything over 50 characters will be truncated.

Name des kaufenden Unternehmens.

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

VatID"payment": {"riverty": {"vatId": "..." }}ans..50C

VAT registration number, the unique number that identifies a business.

The field is mandatory for processing B2B transactions for Germany. 

Umsatzsteuer-Identifikationsnummer, die eindeutige Nummer, die ein Unternehmen identifiziert.

Das Feld ist für die Abwicklung von B2B-Transaktionen für Deutschland obligatorisch.

CustomerRisk"payment": {"riverty": {"customerRisk": "..." }}

ans..1024

M

Risk-relevant data as JSON string in Base64 format (see JSON objects: CustomerRisk)

Merchants can conduct external risk checks and send this information to Riverty.

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

a2

O

Language: "NO", "SE", "FI", "DK”, "EN”, "DE”, "NL”, "FR” permittedSprache: „NO“, „SE“, „FI“, „DK”, “EN”, “DE”, “NL”, “FR” zulässig
CompanyOrPerson

"companyOrPerson": "Company"

"companyOrPerson": ""

a..7C

Customer category for delivery address:

„Company“

„Person“ (default value)

Requred if any of sd-fields (refer below) is provided.

Kundenkategorie der Lieferadresse:

„Company“ für Unternehmen

„Person“ für Personen (Standardwert)

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

sdCountryCode"shipping": {"addressInfo": { "country": { "A2": "..." } }}a2OCountry code of the delivery address: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”Ländercode der Lieferadresse: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”
sdZip"shipping": {"addressInfo": {"postalCode": "..." }}

ans..10

O

Postcode in the delivery address

Postleitzahl der Lieferadresse
sdStreet"shipping": {"addressInfo": {"addressLine1": { "street": "..." } }}

ans..80

O

Street name or packstation of the delivery address

Straße oder Packstation der Lieferadresse
sdStreetNr"shipping": {"addressInfo": {"addressLine1": { "streetNumber": "..." } }}

a..50

O

Street number or packstation number of the delivery address

Haus- oder Packstationsnummer der Lieferadresse
sdStreetNr2"shipping": {"addressInfo": { "addressLine2": "..." }}

ans..10

O

Street number addition of the delivery address

Straßennummernzusatz der Lieferadresse
sdCity"shipping": {"addressInfo": { "city": "..." }}

ans..100

O

Town/city of the delivery address

Ort der Lieferadresse
sdcareOf"payment": {"riverty": {"shippingCareO": "..." }}ans..50O

Care of.

Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”). This field has to be used for company, authority and organization names as well – e. g. "Sportverein Blau-Weiß e.V."

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"payment": {"riverty": {"shippingMethod": "..." }}ans..50O

Address type.

Possible values: "Standard" (default value), "PickUpPoint", "InStore"

Adressentyp.

Mögliche Werte: "Standard" (Standardwert), "PickUpPoint", "InStore"

sdFirstName"shipping": {"consumer": {"firstName": "..." }}

ans..50

O

First name in the delivery address

Vorname der Lieferadresse
sdLastName"shipping": {"consumer": {"lastName": "..." }}

ans..50

O

Last name in the delivery address

Nachname der Lieferadresse
sdSalutation"shipping": {"consumer": {"salutation": "..." }}

a..4

O

Salutation in the delivery address

„Mr“

„Mrs“

„Miss“

Valid for AddrCountryCode = „DE“, „DK“,“NL“, „BE“, „AT“ or „CH“

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"shipping": {"contactInfo": {"email": "..." }}

ans..100

O

E-mail address of the delivery addressE-Mail-Adresse der Lieferadresse
Phone"shipping": {"contactInfo": {"phone": "..." }}

ns..50

O

Phone number in the delivery address

Telefonnummer der Lieferadresse
MobileNo"shipping": {"contactInfo": {"mobilePhone": "..." }}

ns..50

O

Mobile number of the delivery address

Handynummer der Lieferadresse
sdCompany"shipping": {"business": {"companyLegalName": "..." }}ans..50C

Delivery company name.

Required if CompanyOrPerson is 'Company'. Everything over 50 characters will be truncated.

Name des kaufenden Unternehmens.

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

Order"order": JSONans..1024M

Order information as JSON string in Base64 format.

See JSON object: Order

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:

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

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

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyRESTFormatCNDDescriptionBeschreibung
XID"xId": "..."

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

Key

REST

Format

CND

Description

Beschreibung

TransID"transactionId": "..."ans..18MTransactionID which should be unique for each paymentTransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

"referenceNumber": "..."

ns..30

O

Unique reference number

Eindeutige Referenznummer

KeyRESTFormatCNDDescriptionBeschreibung
Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyRESTFormatCNDDescriptionBeschreibung
Description"description": "..."

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyRESTFormatCNDDescriptionBeschreibung
Code"code": ...

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

Key

REST

Format

CND

Description

Beschreibung

CodeExt"payment": {"riverty": {"errorCode": ... }}

n..10

O

Error code from Riverty, if agreed with Computop Helpdesk

Fehlercode von Riverty, wenn mit Computop Helpdesk abgesprochen

ErrorText"payment": {"riverty": {"errorText": ... }}

ans..1024

O

Error text from Riverty, if agreed with Computop Helpdesk

Fehlertext von Riverty, wenn mit Computop Helpdesk abgesprochen

BillingAddress"payment": {"billing": JSON }ans..1024O

If necessary corrected billing address as JSON string in the Base64 format

(see JSON objects: Address)

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

(siehe JSON-Objekte: Address)

ShippingAddress"payment": {"shipping": JSON }ans..1024O

If necessary corrected shipping address as JSON string in the Base64 format

(see JSON objects: Address)

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:

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


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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment to be captured

Vom Paygate vergebene ID für die zu buchende Zahlung

Key

REST

Format

CND

Description

Beschreibung

TransID"transactionId": "..."ans..18MTransactionID which should be unique for each paymentTransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

"referenceNumber": "..."

ns..30

O

Unique reference number

Eindeutige Referenznummer

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "currency": "..."}

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

KeyRESTFormatCNDDescriptionBeschreibung

MAC

---

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

REST

Format

CND

Description

Beschreibung

OrderDesc"order": {"description[0]": "..."}ans..768ODescription of purchased goods, unit prices, merchant’s comment etc.Beschreibung der gekauften Waren, Einzelpreise, Händlerkommentar etc.

KeyRESTFormatCNDDescriptionBeschreibung
ReqId"requestId": "..."

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

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.

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

Key

REST

Format

CND

Description

Beschreibung

Order"order": JSONans..1024C

Mandatory for partial capture or if order information have changed with the same total amount.

Order information as JSON string in Base64 format.

See JSON object: Order

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"order": {"creationDate": "..."}ans..30O

Is considered only if Order is also transferred.

Invoice number that is displayed within Riverty portal. An order can contain more than one invoice.

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

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

ShippingData"shipping": JSONans..1024O

Is considered only if Order is also transferred.

Shipping information as JSON string in Base64 format.

(see JSON objects: ShippingData)

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:

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

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

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyRESTFormatCNDDescriptionBeschreibung
XID"xId": "..."

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

Key

REST

Format

CND

Description

Beschreibung

TransID"transactionId": "..."ans..18MTransactionID which should be unique for each paymentTransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

"referenceNumber": "..."

ns..30

O

Unique reference number

Eindeutige Referenznummer

Status

"status": "OK"

"status": "CAPTURE_REQUEST"

"status": "FAILED"

a..50MOK, CAPTURE_REQUEST or FAILEDOK, CAPTURE_REQUEST oder FAILED

KeyRESTFormatCNDDescriptionBeschreibung
Description"description": "..."

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyRESTFormatCNDDescriptionBeschreibung
Code"code": ...

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

Key

REST

Format

CND

Description

Beschreibung

InvoiceNumber"order": {"number": "..."}ans..30OBooking number: generated by merchant or, if not available, by Riverty. Is necessary for partial credits.Buchungsnummer: wird vom Händler erzeugt oder falls nicht verfügbar von Riverty. Sie ist für Teilgutschriften erforderlich.
CodeExt"externalErrorCode": ...

n..10

O

Error code from Riverty, if agreed with Computop Helpdesk

Fehlercode von Riverty, wenn mit Computop Helpdesk abgesprochen

ErrorText"payment": {"rivertyErrorText": "..."}

ans..1024

O

Error text from Riverty, if agreed with Computop Helpdesk

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

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


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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment to be credited

Vom Paygate vergebene ID für die gutzuschreibende Zahlung

Key

REST

Format

CND

Description

Beschreibung

TransID"transactionId": "..."ans..18MTransactionID which should be unique for each paymentTransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

"referenceNumber": "..."

ns..30

O

Reference number (e.g. invoice number) which must be unique for each return shipment

Referenznummer (z.B. Rechnungsnummer), die für jede Retoure eindeutig sein muss

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "currency": "..."}

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

KeyRESTFormatCNDDescriptionBeschreibung

MAC

---

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

REST

Format

CND

Description

Beschreibung

OrderDesc"order": {"description[0]": "..."}ans..768ODescription of purchased goods, unit prices, merchant’s comment etc.Beschreibung der gekauften Waren, Einzelpreise, Händlerkommentar etc.

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

KeyRESTFormatCNDDescriptionBeschreibung
ReqId"requestId": "..."

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

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

REST

Format

CND

Description

Beschreibung

Order"order": JSONans..1024C

Mandatory for partial credits

Order information as JSON string in Base64 format.

See JSON object: RefundOrder

Pflicht bei Teilgutschriften

Bestellinformationen als JSON-String im Format Base64.

Siehe JSON-Objekt: RefundOrder

InvoiceNr"order": {"creationDate": "..."}ans..30C

Is considered only if Order is also transferred, but then it is mandatory.

Invoice number that is displayed within Riverty portal. An order can contain more than one invoice.

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

"order": {"items[i]": {"type": "Refund" }}

"order": {"items[i]": {"type": "Return" }}

enumO

Type or credit: Possible values are "Refund“ and "Return"

Is necessary only for a full credit.

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:

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

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

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyRESTFormatCNDDescriptionBeschreibung
XID"xId": "..."

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

Key

REST

Format

CND

Description

Beschreibung

TransID"transactionId": "..."ans..18MTransactionID which should be unique for each paymentTransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

"referenceNumber": "..."

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyRESTFormatCNDDescriptionBeschreibung
Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyRESTFormatCNDDescriptionBeschreibung
Description"description": "..."

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyRESTFormatCNDDescriptionBeschreibung
Code"code": ...

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

Key

REST

Format

CND

Description

Beschreibung

CodeExt"payment": {"riverty": {"errorCode": ... }}

n..10

O

Error code from Riverty, if agreed with Computop Helpdesk

Fehlercode von Riverty, wenn mit Computop Helpdesk abgesprochen

ErrorText"payment": {"riverty": {"errorText": ... }}

ans..1024

O

Error text from Riverty, if agreed with Computop Helpdesk

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

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


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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment to be reversed

Vom Paygate vergebene ID für die zu stornierende Zahlung

Key

REST

Format

CND

Description

Beschreibung

TransID"transactionId": "..."ans..18MTransactionID which should be unique for each paymentTransaktionsID, die für jede Zahlung eindeutig sein muss

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "currency": "..."}

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

KeyRESTFormatCNDDescriptionBeschreibung

MAC

---

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

KeyRESTFormatCNDDescriptionBeschreibung
ReqId"requestId": "..."

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

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

REST

Format

CND

Description

Beschreibung

Order"order": JSONans..1024C

Mandatory for partial reversals

Order information as JSON string in Base64 format.

See JSON object: Order

Pflicht bei Teilstornierungen

Bestellinformationen als JSON-String im Format Base64.

Siehe JSON-Objekt: Order

Parameter für Storno von Riverty-Zahlungen


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

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

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

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyRESTFormatCNDDescriptionBeschreibung
XID"xId": "..."

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

Key

REST

Format

CND

Description

Beschreibung

TransID"transactionId": "..."ans..18MTransactionID which should be unique for each paymentTransaktionsID, die für jede Zahlung eindeutig sein muss

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "currency": "..."}

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

KeyRESTFormatCNDDescriptionBeschreibung
Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyRESTFormatCNDDescriptionBeschreibung
Description"description": "..."

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyRESTFormatCNDDescriptionBeschreibung
Code"code": ...

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

Key

REST

Format

CND

Description

Beschreibung

CodeExt"payment": {"riverty": {"errorCode": ... }}

n..10

O

Error code from Riverty, if agreed with Computop Helpdesk

Fehlercode von Riverty, wenn mit Computop Helpdesk abgesprochen

ErrorText"payment": {"riverty": {"errorText": ... }}

ans..1024

O

Error text from Riverty, if agreed with Computop Helpdesk

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

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Action

Version

Description

Beschreibung
Capture

1.0 / 2.0

Standard version without return of parameter Code

Standardversion ohne Rückgabe von Parameter Code

1.x / 2.x

with RefNr (valid for all versions other than 1.0)

mit RefNr (gilt für alle Versionen außer 1.0)

Credit

1.0 / 2.0

Standard version without return of parameter Code

Standardversion ohne Rückgabe von Parameter Code


1.x / 2.x

with RefNr (valid for all versions other than 1.0)

mit RefNr (gilt für alle Versionen außer 1.0)
Reverse

1.0 / 2.0

Standard version without return of parameter Code

Standardversion ohne Rückgabe von Parameter Code

1.x / 2.x

with RefNr (valid for all versions other than 1.0)

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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

Format

CND

Description

Beschreibung

Type

a..11

M

HEAD for Header, FOOT for Footer, AFTERPAY for Riverty

HEAD für Header, FOOT für Footer, AFTERPAY für Riverty

Action

a..20

M

The parameter Action defines the type of transaction:

Capture

Credit

Reverse (cancellation)

Der Action-Parameter definiert die Art der Transaktion:

Capture (Buchung)

Credit (Gutschrift)

Reverse (Storno)

KeyFormatCNDDescriptionBeschreibung
Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

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.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

Key

Format

CND

Description

Beschreibung

TransIDans..18MTransactionID which should be unique for each paymentTransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for this transaction

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

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

Format

CND

Description

Beschreibung

Action

a..20

M

The parameter Action defines the type of transaction:

Capture

Credit

Reverse (cancellation)

Der Action-Parameter definiert die Art der Transaktion:

Capture (Buchung)

Credit (Gutschrift)

Reverse (Storno)

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for this transaction

Vom Paygate vergebene ID für diese Transaktion

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

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:

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.

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

Format

CND

Description

Beschreibung
existingCustomerboolOIndicates whether the customer is an existing customer of the merchantGibt an, ob der Kunde ein für den Händler bereits existierender Kunde ist
verifiedCustomerIdentification

bool

O

Indicates whether the customer has been verified

Gibt an, ob der Kunde verifiziert wurde
marketingOptIn

bool

O

Indicates whether marketing material is requested

Gibt an, ob Marketing-Material erwünscht ist
customerSince

dttm

O

Date in format YYYY-MM-DD since which the customer has existed

Datum, seit dem der Kunde existiert im Format JJJJ-MM-TT
customerClassification

ans..32

O

Customer classification

Kundenklassifizierung
acquisitionChannel

enum

O

Indicates the channel via which the merchant is reached. Possible values: „NotSet“, „Advertisment“, „SocialNetwork“, „Direct“, „SearchEngine“, “Other”

Gibt den genutzten Kanal an, um auf die Händlerseite zu gelangen. Mögliche Werte: „NotSet“, „Advertisment“, „SocialNetwork“, „Direct“, „SearchEngine“, “Other”
hasCustomerCard

bool

O

Indicates whether the customer has a loyalty card

Gibt an, ob der Kunde eine Kundenkarte besitzt
customerCardSince

dttm

O

Date in format YYYY-MM-DD since which the loyalty card has existed

Datum, seit dem eine Kundenkarte existiert im Format JJJJ-MM-TT
customerCardClassification

ans..32

O

Indicates the loyalty card level, e.g. "Gold Member"

Gibt den Level der Kundenkarte an, z.B. „Gold Member“
profileTrackingId

ans..64

O

Unique TrackingID

Eindeutige TrackingID
ipAddress

ans..15

M

Customer´s IP address

IP-Adresse des Kunden
numberOfTransactions

n..5

O

Number of successful transactions already completed by the customer

Anzahl der erfolgreichen Transaktionen, die der Kunden bereits getätigt hat
customerIndividualScore

n..5

O

Individual score for the customer supplied by the merchant

Vom Händler zur Verfügung gestellter individueller Score für den Kunden
userAgentans..32OUserAgent of this specific consumer UserAgent dieses bestimmten Kunden
amountOfTransactionsn..5OAmount of paid orders last 12 months Betrag der bezahlten Bestellungen in den letzten 12 Monaten
otherPaymentMethodsboolOOther payment method than MI in walletAndere 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.

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

Format

CND

Description

Beschreibung
totalGrossAmount

ans..16

M

Gross order amount. Must equal the value of all items (grossUnitPrice * quantity).

Please note, that values has to be specified with “.” as decimal separator.

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

Currency: Possible values are „EUR“, „NOK“, „SEK“, „DKK“, „CHF“

Währung: Mögliche Werte sind „EUR“, „NOK“, „SEK“, „DKK“, „CHF“
risk

ans..1024

O

Order risk-relevant data as JSON string in Base64 format (see JSON object: OrderRisk)

Risikorelevante Daten der Bestellung als JSON-String im Base64 (siehe JSON-Objekt: OrderRisk)
items

Array

M

Array of OrderItems (see JSON object: OrderItem)

Array von OrderItems (siehe JSON-Objekt: OrderItem)
totalNetAmount

ans..16

M

Net order amount

Please note, that values has to be specified with “.” as decimal separator.

Nettobetrag der Bestellung

Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.

imageUrl

ans..256

O

URL for order image. This image can be viewed on the invoice or next to the instal-ment payment in the Riverty portal. Limited to 100-1280px.

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.

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

Format

CND

Description

Beschreibung
channelType

ans..64

O

Order channel type. Possible values:

"Internet", "Catalog", "CallCenter", "Stationary", "Other".

Kanal der Bestellung. Mögliche Werte:

"Internet", "Catalog", "CallCenter", "Stationary", "Other".

deliveryType

ans..64

O

Order delivery type. Possible values:

"Normal", "Express".

Typ der Lieferung. Mögliche Werte:

"Normal", "Express".

ticketDeliveryMethodans..64O

Name of the tickets' method. Possible values:

"NotSet", "PickUp", "Email", "Post", "Phone".

Name der Ticket-Methode. Mögliche Werte:

"NotSet", "PickUp", "Email", "Post", "Phone".

OrderItem

Hier werden die Informationen zu einem Artikel definiert.

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

Format

CND

Description

Beschreibung
productId

ans..64

MArticle numberArtikelnummer
description

ans..128

M

Article description

Artikelbeschreibung
typeans..64O

Order item type. Possible values:

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

Typ des Artikels. Mögliche Werte:

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

quantity

n..8

M

Article quantity

Decimal values, if agreed with Computop and Riverty.

Artikelanzahl.

Dezimalwerte, wenn mit Computop und Riverty abgesprochen.

grossUnitPrice

ans..16

M

Gross price per article

Please note, that values has to be specified with “.” as decimal separator.

Bruttopreis pro Artikel

Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.

grouId

ans..64

O

GroupID

GruppenID
netUnitPrice

ans..16

M

Net price per article

Please note, that values has to be specified with “.” as decimal separator.

Nettopreis pro Artikel

Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.

unitCode

ans..16

O

Unit (e.g. pieces, litres, kilograms, etc.)

Einheit (z.B. Stück, Liter, Kilogramm, etc.)
vatCategory

enum

O

VAT category

Possible values: "HighCategory", "LowCategory", "NullCategory", "NoCategory", "MiddleCategory", "OtherCategory"

Umsatzsteuerkategorie

Mögliche Werte: "HighCategory", "LowCategory", "NullCategory", "NoCategory", "MiddleCategory", "OtherCategory"

vatPercent

n..2

M

VAT in percent

Umsatzsteuer in Prozent
vatAmount

ans..16

M

VAT as amount per item

Please note, that values has to be specified with “.” as decimal separator.

Umsatzsteuer als Betrag pro Artikel

Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.

imageUrl

ans..256

O

URL for order image. This image can be viewed on the invoice or next to the instal-ment payment in the Riverty portal. Limited to 100-1280px.

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

Google Product Category ID

googleProductCategory

ans..64

O

Google Product Category

Google Product Category

merchantProductType

ans..64

O

Merchant category in addition to Google classification

Kategorisierung des Händlers ergänzend zur Google-Klassifizierung

lineNumber

n.3

O

The merchant can specify a line number for each article for sorting purposes

Der Händler kann eine Zeilennummer für jeden Artikel angeben, um die Artikel zu sortieren

discountAmount

ans..16

O

Discount amount (only for statistical purposes)

Please note, that values has to be specified with “.” as decimal separator.

Rabattbetrag (nur für statistische Zwecke)

Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.

productUrl

ans..256

O

Article URL

URL zum Artikel

marketPlaceSellerId

ans..64

O

ID of a specific market place

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.

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

Format

CND

Description

Beschreibung
type

ans..32

O

Available payment method

Possible values: "Invoice", "Account", "Installment", "Consolidatedinvoice"

Verfügbare Zahlungsart

Mögliche Werte: "Invoice", "Account", "Installment", "Consolidatedinvoice"

account

AccountProduct

O

Account information (see JSON object: AccountProduct)

Account-Informationen (siehe JSON-Objekt: AccountProduct)
directDebit

DirectDebitInfo

O

Direct-Debit information (see JSON object: DirectDebitInfo)

Direct-Debit-Informationen (siehe JSON-Objekt: DirectDebitInfo)
campaigns

Array

O

Array of campaign information (see JSON object: CampaignInfo)

Array von Kampagnen-Informationen (siehe JSON-Objekt: CampaignInfo)
Installment

InstallmentInfo

O

Instalment payment information (see JSON object: InstallmentInfo)

Ratenkauf-Informationen (siehe JSON-Objekt: InstallmentInfo)
legalInfolegalInfoOLegal info containing Terms and Conditions, Privacy statement, etc. (see JSON object: LegalInfo)Legal info containing Terms and Conditions, Privacy statement, etc. (see JSON object: LegalInfo)

AccountProduct

Hier werden die Informationen zu einem AccountProduct definiert.

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

Format

CND

Description

Beschreibung
profileNon..32MAccount profile numberAccount-Profilnummer

DirectDebitInfo

Hier werden die Informationen zu DirectDebitInfo definiert.

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

Format

CND

Description

Beschreibung
AvailableboolOIndicates whether DirectDebit is availableGibt an, ob DirectDebit verfügbar ist

CampaignInfo

Hier werden die Informationen zu CampaignInfo definiert.

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

Format

CND

Description

Beschreibung
campaignNo

n..32

O

Campaign number

Kampagnennummer
description

ans..128

O

Campaign description

Kampagnenbeschreibung

InstallmentInfo

Hier werden die Informationen zu InstallmentInfo definiert.

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

Format

CND

Description

Beschreibung
basketAmountenumO

Available payment method

Possible values: "Invoice", "Account", "Installment", "Consolidatedinvoice"

Please note, that values has to be specified with “.” as decimal separator.

Verfügbare Zahlungsart

Mögliche Werte: "Invoice", "Account", "Installment", "Consolidatedinvoice"

Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.

numberOfInstallments

n..2

O

Number of installments

Anzahl der Raten

installmentAmount

ans..16

O

Installment amount for each month

Please note, that values has to be specified with “.” as decimal separator.

Ratenbetrag für jeden Monat

Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.

firstInstallmentAmount

ans..16

O

First installment amount

Please note, that values has to be specified with “.” as decimal separator.

Erster Ratenbetrag

Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.

lastInstallmentAmount

ans..16

O

Final installment amount

Please note, that values has to be specified with “.” as decimal separator.

Letzter Ratenbetrag

Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.

interestRate

ans..16

O

Interest rate

Zinssatz

effectiveInterestRate

ans..16

O

Effective interest rate

Effektiver Zinssatz

effectiveAnnualPercentageRate

ans..16

O

Effective annual percentage

Effektiver jährlicher Prozentsatz

totalInterestAmount

ans..16

O

Total interest rate

Please note, that values has to be specified with “.” as decimal separator.

Gesamtzinssatz

Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.

startupFee

ans..16

O

Starting fee

Anfangsgebühr

monthlyFee

ans..16

O

Monthly fee

Monatliche Gebühr

totalAmount

ans..16

O

Total amount

Gesamtbetrag

installmentProfileNumber

ans..16

O

Installment profile number

Raten Profilnummer

readMore

ans..128

O

Further information about the installment process

Weitere Informationen zum Ratenprozess

LegalInfo

Hier werden die Informationen zu LegalInfo definiert.

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

Format

CND

Description

Beschreibung
requiresCustomerConsentboolO"true", if customer consent is required"true", if customer consent is required

termsAndConditionsUrl

ans..250

O

URL to Terms and Conditions

URL to Terms and Conditions

privacyStatementUrl

ans..250

O

URL to Privacy StatementURL to Privacy Statement

bgb507Url

ans..250

O

URL to § 507 BGB

URL to § 507 BGB

text

ans..2500

O

Legal text

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.

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

Format

CND

Description

Beschreibung

countryCode

enum

M

Country code

Possible values: "NO“, „SE“, „FI“, „DK“, „DE“, „AT“, „CH“, „NL“, „BE“

Ländercode

Mögliche Werte: "NO“, „SE“, „FI“, „DK“, „DE“, „AT“, „CH“, „NL“, „BE“

postalCode

ans..10

M

Postal code

Postleitzahl

postalPlace

ans..100

M

City

Ort

Street

ans..100

M

Street or packstation

Straße oder Packstation

streetNumber

ans..10

M

Street number or packstation number

Haus- oder Packstationsnummer

streetNumberAdditional

ans..10

O

Street number addition

Hausnummernzusatz

careOf

ans..50

O

Responsible person for dispatch of shipment

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.

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

Format

CND

Description

Beschreibung

totalGrossAmount

ans..16

O

Gross order amount. Must equal the value of all items (grossUnitPrice * quantity).

Please note, that values has to be specified with “.” as decimal separator.

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

Currency. Possible values are „EUR“, „NOK“, „SEK“, „DKK“, „CHF“

Währung. Mögliche Werte sind „EUR“, „NOK“, „SEK“, „DKK“, „CHF“

items

Array

O

Array of OrderItems (see JSON object: OrderItem)

Array von OrderItems (siehe JSON-Objekt: OrderItem)

totalNetAmount

ans..16

O

Net order amount

Please note, that values has to be specified with “.” as decimal separator.

Nettobetrag der Bestellung

Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.

imageUrl

ans..256

O

URL for order image. This image can be viewed on the invoice or next to the instal-ment payment in the Riverty portal. Limited to 100-1280px.

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

Google Analytics UserID

googleAnalyticsClientId

ans..64

O

Google Analytics ClientID

Google Analytics ClientID

discountAmount

ans..16

O

Discount amount (only for statistical purposes)

Please note, that values has to be specified with “.” as decimal separator.

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.

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

Format

CND

Description

Beschreibung
shippingDetailsArrayMArray of shipping information (see JSON object: ShippingDetails)Array von Versandinformationen (siehe JSON-Objekt: ShippingDetails)

ShippingDetails

Hier werden die Informationen zu ShippingDetails definiert.

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

Format

CND

Description

Beschreibung
type

enum

M

Dispatch type: Possible values are "Shipment", "Return"

Versandtyp: Mögliche Werte sind „Shipment“, „Return“
shippingCompany

ans..64

M

Shipping company

Versandunternehmen
trackingId

ans..64

M

Unique TrackingID

Eindeutige TrackingID