- Created by Peter Posse, last modified on 25. Sep 2024
About Riverty
General information about Riverty
Logo | |
---|---|
Info | Riverty offers purchase on account after delivery. Buyers can pay for articles by invoice, direct debit or installment. There is no risk of fraud or payment default for the merchant. After a credit check, Riverty assumes the entire end customer payment default risk for each transaction. |
Type | Payments by Invoice and Installments |
Further information can be found on the website of Riverty (https://www.riverty.com/en/).
Process Flow Chart
On this page
Paygate interface
Format Description a alphabetical as alphabetical with special characters n numeric an alphanumeric ans alphanumeric with special characters ns numeric with special characters bool boolean expression (true or false) 3 fixed length with 3 digits/characters ..3 variable length with maximum 3 digits/characters enum enumeration of allowed values dttm ISODateTime (YYYY-MM-DDThh:mm:ss) Abbreviation Description CND condition M mandatory O optional C conditional Notice: Please note that the names of parameters can be returned in upper or lower case.Definitions
Data formats
Abbreviations
Comment If a parameter is mandatory, then it must be present If a parameter is optional, then it can be present, but it is not required If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional
Query about available payment types (two-stage authorisation)
Riverty differentiates between one-stage and two-stage authorisation. One-stage authorisation is designed for merchants who only use the normal method of payment by invoice in their checkout. Two-stage authorisation permits, for a specific shopping basket, a query of the available payment types and a request for further information.
In order to process two-stage authorisation with Riverty via server-to-server communication, please use the following URL:
https://www.computop-paygate.com/afterpay.aspx |
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter. The following table describes the encrypted payment request parameters:
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 | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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..18 | C | 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 | 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..30 | C | 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. |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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. |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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 |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
--- | 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 |
---|---|---|---|---|---|
EventToken | "payment": {"riverty": {"eventToken": "..." }} | a..19 | M | 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"= "..." }}} | a2 | M | Country code „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE” | Ländercode „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE” |
Order | "order": JSON | ans..1024 | M | 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 |
Parameters for payments with Riverty
The following table describes the result parameters with which the Computop Paygate responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
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 | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | HändlerID, die von Computop vergeben wird |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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 |
---|---|---|---|---|---|
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..18 | M | TransactionID which should be unique for each payment | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | Unique reference number | Eindeutige Referenznummer |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
Status | a..50 | M | OK or AUTHORIZED (URLSuccess) as well as FAILED (URLFailure) | OK oder AUTHORIZED (URLSuccess) sowie FAILED (URLFailure) |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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! |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
Code | "code": ... | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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) |
Result parameters for Riverty
The second stage involves the transfer of the customer and order data as well as payment type and, if relevant, further information relating to the payment type.
The second stage is triggered by using the following URL:
https://www.computop-paygate.com/afterpay.aspx |
Â
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter. The following table describes the encrypted payment request parameters:
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 | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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 |
---|---|---|---|---|---|
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..18 | M | TransactionID which should be unique for each payment | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | Unique reference number | Eindeutige Referenznummer |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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. |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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 |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
--- | 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 |
---|---|---|---|---|---|
PayType | "payment": {"riverty": {"paymentType": "..." }} | a..19 | M | 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. |
bdCompanyOrPerson | a..7 | M | Customer category: „Company“ „Person“ (default value) | Kundenkategorie: „Company“ für Unternehmen „Person“ für Personen (Standardwert) | |
SocialSecurityNumber | 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. For AT, BE, CH, DE and NL is also important: The number has to begin with "HRB" for trading companies and corporations or with "HRA" for sole traders and partnerships. 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. Für AT, BE, CH, DE und NL gilt zusätzlich: Die Nummer muss mit „HRB“ für Handelsgesellschaften und Kapitalgesellschaften oder mit „HRA“ für Einzelkaufleute und Personengesellschaften beginnen. Dieser Parameter ist mit dem Parameter bdCompanyOrPerson verknüpft. | |
LegalForm | "billing": {"business": {"companyLegalForm": "..." }} | ans..50 | O | 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": "..." } }} | a2 | O | 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..10 | M | Postcode | Postleitzahl |
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..100 | M | City | Ort |
careOf | "payment": {"riverty": {"billingCareO": "..." }} | ans..50 | O | 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..50 | M | First name | Vorname |
LastName | "billing": {"consumer": {"lastName": "..." }} | ans..50 | M | Last name | Nachname |
CustomerID | "billing": {"consumer": {"customerId": "..." }} | ans..20 | O | Unique customer number | Eindeutige Kundennummer |
Salutation | "billing": {"consumer": {"salutation": "..." }} | a..4 | O | 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 | O | 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..255 | C | Purchasing company name. Required if bdCompanyOrPerson is 'Company'. | Name des kaufenden Unternehmens. Erforderlich, wenn bdCompanyOrPerson gleich 'Company' ist. |
VatID | "payment": {"riverty": {"vatId": "..." }} | ans..50 | C | 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” permitted | Sprache: „NO“, „SE“, „FI“, „DK”, “EN”, “DE”, “NL”, “FR” zulässig |
CompanyOrPerson | a..7 | C | 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": "..." } }} | a2 | O | Country 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..50 | O | 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..50 | O | 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“ |
"shipping": {"contactInfo": {"email": "..." }} | ans..100 | O | E-mail address of the delivery address | E-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..50 | C | 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 PayType=invoice or PayType=installment. | International Bank Account Number (gültig bei AddrCountryCode = “DE”). Bitte beachten Sie, dass IBAN obligatorisch ist, wenn PayType=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": "..."} | an10 | O | Date of invoice in the format YYYY-MM-DD. Only for PayType = "ConsolidatedInvoice" | Rechnungsdatum im Format JJJJ-MM-TT. Nur bei PayType = "ConsolidatedInvoice" |
Parameters for Riverty
Â
The following table describes the result parameters with which the Computop Paygate responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
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 | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | HändlerID, die von Computop vergeben wird |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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 |
---|---|---|---|---|---|
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..18 | M | TransactionID which should be unique for each payment | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | Unique reference number | Eindeutige Referenznummer | |
Status | a..50 | M | AUTHORIZE_REQUEST or FAILED | AUTHORIZE_REQUEST oder FAILED |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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! |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
Code | "code": ... | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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..1024 | O | 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..1024 | O | 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) |
Result parameters for Riverty
Calling the interface for one-stage authorisation
To process one-stage authorisation with Riverty, please use the following URL:
https://www.computop-paygate.com/afterpay.aspx |
Â
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter. The following table describes the encrypted payment request parameters:
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 | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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..18 | M | TransactionID which should be unique for each payment | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | Unique reference number | Eindeutige Referenznummer |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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. |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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 |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
--- | 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 |
---|---|---|---|---|---|
PayType | "payment": {"riverty": {"paymentType": "..." }} | a..19 | M | 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 | 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. For AT, BE, CH, DE and NL is also important: The number has to begin with "HRB" for trading companies and corporations or with "HRA" for sole traders and partnerships. 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. Für AT, BE, CH, DE und NL gilt zusätzlich: Die Nummer muss mit „HRB“ für Handelsgesellschaften und Kapitalgesellschaften oder mit „HRA“ für Einzelkaufleute und Personengesellschaften beginnen. Dieser Parameter ist mit dem Parameter bdCompanyOrPerson verknüpft. | |
LegalForm | "billing": {"business": {"companyLegalForm": "..." }} | ans..50 | O | 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": "..." } }} | a2 | O | 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..10 | M | Postcode | Postleitzahl |
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..100 | M | City | Ort |
careOf | "payment": {"riverty": {"billingCareO": "..." }} | ans..50 | O | 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..50 | M | First name | Vorname |
LastName | "billing": {"consumer": {"lastName": "..." }} | ans..50 | M | Last name | Nachname |
CustomerID | "billing": {"consumer": {"customerId": "..." }} | ans..20 | O | Unique customer number | Eindeutige Kundennummer |
Salutation | "billing": {"consumer": {"salutation": "..." }} | a..4 | O | 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 | O | 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..50 | C | 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..50 | C | 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” permitted | Sprache: „NO“, „SE“, „FI“, „DK”, “EN”, “DE”, “NL”, “FR” zulässig |
CompanyOrPerson | a..7 | C | 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": "..." } }} | a2 | O | Country 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..50 | O | 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..50 | O | 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“ |
"shipping": {"contactInfo": {"email": "..." }} | ans..100 | O | E-mail address of the delivery address | E-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..50 | C | 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": JSON | ans..1024 | M | Order information as JSON string in Base64 format. See JSON object: Order | Bestellinformationen als JSON-String im Format Base64. Siehe JSON-Objekt: Order |
Parameters for payments with Riverty
The following table describes the result parameters with which the Computop Paygate responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
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 | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | HändlerID, die von Computop vergeben wird |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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 |
---|---|---|---|---|---|
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..18 | M | TransactionID which should be unique for each payment | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | Unique reference number | Eindeutige Referenznummer |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | OK (URLSuccess) oder FAILED (URLFailure) |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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! |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
Code | "code": ... | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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..1024 | O | 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..1024 | O | 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) |
Result parameters for Riverty
Â
Capture
Captures are possible via a Server-to-Server connection. To carry out a Capture for Riverty via a Server-to-Server connection, please use the following URL:
https://www.computop-paygate.com/capture.aspx |
Â
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter. The following table describes the encrypted payment request parameters:
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 | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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 |
---|---|---|---|---|---|
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..18 | M | TransactionID which should be unique for each payment | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | Unique reference number | Eindeutige Referenznummer |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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. |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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 |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
--- | 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..768 | O | Description of purchased goods, unit prices, merchant’s comment etc. | Beschreibung der gekauften Waren, Einzelpreise, Händlerkommentar etc. |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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 |
---|---|---|---|---|---|
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": JSON | ans..1024 | C | 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..30 | O | 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": JSON | ans..1024 | O | 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) |
Parameters for Riverty captures
Â
The following table describes the result parameters with which the Computop Paygate responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
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 | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | HändlerID, die von Computop vergeben wird |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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 |
---|---|---|---|---|---|
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..18 | M | TransactionID which should be unique for each payment | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | Unique reference number | Eindeutige Referenznummer | |
Status | a..50 | M | OK, CAPTURE_REQUEST or FAILED | OK, CAPTURE_REQUEST oder FAILED |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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! |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
Code | "code": ... | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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..30 | O | Booking 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 |
Result parameters for Riverty captures
Â
Credit with reference
Credits (refunds) are possible via a Server-to-Server connection. For a Credit with reference to a capture the amount of the Credit is limited to the amount of the previous capture. To carry out a credit with a reference transaction, please use the following URL:
https://www.computop-paygate.com/credit.aspx |
Â
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter. The following table describes the encrypted payment request parameters:
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 | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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 |
---|---|---|---|---|---|
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..18 | M | TransactionID which should be unique for each payment | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | 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 |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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. |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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 |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
--- | 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..768 | O | Description of purchased goods, unit prices, merchant’s comment etc. | Beschreibung der gekauften Waren, Einzelpreise, Händlerkommentar etc. |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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 |
---|---|---|---|---|---|
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": JSON | ans..1024 | C | 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..30 | C | 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 | enum | O | Type of 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. |
Parameters for credits of Riverty payments
Â
The following table describes the result parameters with which the Computop Paygate responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
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 | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | HändlerID, die von Computop vergeben wird |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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 |
---|---|---|---|---|---|
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..18 | M | TransactionID which should be unique for each payment | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | Merchant’s unique reference number | Eindeutige Referenznummer des Händlers |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | OK (URLSuccess) oder FAILED (URLFailure) |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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! |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
Code | "code": ... | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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 |
Result parameters for credits of Riverty payments
Â
Reverse
Reversals are possible via a Server-to-Server connection. In order to reverse an Riverty transaction, please use the following URL:
https://www.computop-paygate.com/reverse.aspx |
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter. The following table describes the encrypted payment request parameters:
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 | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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 |
---|---|---|---|---|---|
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..18 | M | TransactionID which should be unique for each payment | TransaktionsID, die für jede Zahlung eindeutig sein muss |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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. |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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 |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
--- | 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 |
---|---|---|---|---|---|
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 |
---|---|---|---|---|---|
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": JSON | ans..1024 | C | 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 |
Parameters for reversals of Riverty payments
Â
The following table describes the result parameters with which the Computop Paygate responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
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 | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | HändlerID, die von Computop vergeben wird |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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 |
---|---|---|---|---|---|
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..18 | M | TransactionID which should be unique for each payment | TransaktionsID, die für jede Zahlung eindeutig sein muss |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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. |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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 |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | OK (URLSuccess) oder FAILED (URLFailure) |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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! |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
Code | "code": ... | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
Key | REST | Format | CND | Description | Beschreibung |
---|---|---|---|---|---|
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 |
Result parameters for reversals of Riverty payments
Batch processing via the interface
Basic information about using Batch files and about their structure can be found in the Batch Manager manual. Within batch processing not alle functions are available which are usually available for the online interface.
This section describes the parameters which must be transferred within the data set (Record) for executing a Riverty payment and information can be found within the response file about the payment status.
Notice: Please note that partial captures, partial credits and partial reversals for Riverty are not possible with batch.
Following table gives an overview of all batch versions that are possible for a specific action and their specialities:
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) |
Description of the possible batch versions
The structure for a Riverty payment in a Batch file to be submitted is as follows:
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>
Example for Master MID function:
HEAD,[Master]MerchantID,Date,2.x Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action) FOOT,CountRecords,SumAmount
The following table describes the individual fields and values used within the data set (record) in the batch file:
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) |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
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. |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
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 |
---|---|---|---|---|
TransID | ans..18 | M | TransactionID which should be unique for each payment | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | Merchant’s unique reference number | Eindeutige Referenznummer des Händlers |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
PayID | an32 | M | ID assigned by Paygate for this transaction | Vom Paygate vergebene ID für diese Transaktion |
Description of fields within the record for Batch files
Â
The record area within the response file for Batch transactions looks as follows:
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>
The following table describes the individual fields and values used within the data set (record) in the batch file:
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) |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
PayID | an32 | M | ID assigned by Paygate for this transaction | Vom Paygate vergebene ID für diese Transaktion |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | OK (URLSuccess) oder FAILED (URLFailure) |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
Description of result parameters within the record for Batch files
JSON Objects
The JavaScript Object Notation, JSON for short, is a compact data format in an easy-to-read text format for the purpose of exchanging data between applications. JSON does not depend on the programming language. Parsers exist in practically all widely used languages. You can find more information about JSON via this link:
Â
The next section describes JSON objects which are required for requests or returned in the response.
Notice: The JSON string can include special characters and so must also be Base64 encoded. Transfer problems may otherwise occur.
CustomerRisk
Risk-relevant data about the customer. Merchants can conduct external risk checks and send this information to Riverty.
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 |
---|---|---|---|---|
existingCustomer | bool | O | Indicates whether the customer is an existing customer of the merchant | Gibt 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 |
userAgent | ans..32 | O | UserAgent of this specific consumer | UserAgent dieses bestimmten Kunden |
amountOfTransactions | n..5 | O | Amount of paid orders last 12 months | Betrag der bezahlten Bestellungen in den letzten 12 Monaten |
otherPaymentMethods | bool | O | Other payment method than MI in wallet | Andere Zahlungsmethode außer MI im Wallet |
Example CustomerRisk as 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
The order information is defined here.
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 instalment 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
The order risk information is defined here.
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". |
ticketDeliveryMethod | ans..64 | O | 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
The order information is defined here.
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 | M | Article number | Artikelnummer |
description | ans..128 | M | Article description | Artikelbeschreibung |
type | ans..64 | O | 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. |
groupId | 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 |
Example of Order as 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
The information about the allowed payment types is defined here in an array.
PaymentMethod
The article information is defined here.
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) |
legalInfo | legalInfo | O | Legal 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
The AccountProduct information is defined here.
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 |
---|---|---|---|---|
profileNo | n..32 | M | Account profile number | Account-Profilnummer |
DirectDebitInfo
The DirectDebitInfo information is defined here.
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 |
---|---|---|---|---|
Available | bool | O | Indicates whether DirectDebit is available | Gibt an, ob DirectDebit verfügbar ist |
CampaignInfo
The CampaignInfo information is defined here.
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
The InstallmentInfo information is defined here.
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 |
---|---|---|---|---|
basketAmount | enum | O | 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
The LegalInfo information is defined here.
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 |
---|---|---|---|---|
requiresCustomerConsent | bool | O | "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 Statement | URL to Privacy Statement |
bgb507Url | ans..250 | O | URL to § 507 BGB | URL to § 507 BGB |
text | ans..2500 | O | Legal text | Legal text |
Example of AllowedPaymentMethods as 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
The information about corrected billing address data is defined here in an array if necessary.
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 |
Example of Address as JSON string
{ [{ "countryCode" : "DE", "postalCode" : "10405", "street" : "Prenzlauer Allee", "streetNumber" : 20 "streetNumberAdditional" : "3. Stock", "postalPlace" : "Berlin", "addressType" : null, "careOf" : null } ] }
OrderSummary
The OrderSummary information is defined here.
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. |
Example of OrderSummary as 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
The information about dispatch is defined here in an array.
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 |
---|---|---|---|---|
shippingDetails | Array | M | Array of shipping information (see JSON object: ShippingDetails) | Array von Versandinformationen (siehe JSON-Objekt: ShippingDetails) |
ShippingDetails
The ShippingDetails information is defined here.
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 |
Example of ShippingData as JSON string
{ "shippingDetails" : [{ "type" : "Shipment", "shippingCompany" : "DHL", "trackingId" : "234324234" }, { "type" : "Shipment", "shippingCompany" : "Hermes", "trackingId" : "687654" } ] }
RefundOrder
The information about the articles to be credited is defined here.
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 |
---|---|---|---|---|
orderItems | Array | M | Array of articles to be credited (see JSON object: RefundOrderItem) | Array von Artikeln zum Gutschreiben (siehe JSON-Objekt: RefundOrderItem) |
RefundOrderItem
The RefundOrderItem information is defined here.
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 |
---|---|---|---|---|
refundType | ans..32 | C | Credit type: Possible values are "Refund“, "Return" The parameter is not required for EventToken="Return". | Gutschriftstyp: Mögliche Werte sind „Refund“, „Return“ |
productId | ans..64 | M | Article number | Artikelnummer |
description | ans..128 | M | Article description | Artikelbeschreibung |
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. |
groupId | 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 | ans..32 | 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 | <