You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Über Riverty (AfterPay) SCA

Allgemeines zu Riverty (AfterPay) SCA

Logo

Info

Riverty (AfterPay) SCA bietet Rechnungskauf nach der Lieferung an. Käufer können die Artikel per Rechnung, Lastschrift oder Ratenzahlung bezahlen. Für den Händler gibt es gibt kein Risiko für Betrug oder Zahlungsausfall. Nach einem Risikocheck übernimmt Riverty das gesamte Ausfallrisiko des Endkunden für jede einzelne Transaktion.

TypZahlungen per Rechnungs- und Ratenkauf

Weitere Informationen finden Sie auch auf der Webseite von Riverty (https://www.riverty.com/de/).

Auf dieser Seite



Diagramme zum Prozessablauf



Alternativer Prozessablauf, wenn die Autorisierungsantwort in Schritt 7 nicht outcome=Pending und code=200.019 liefert. In diesem Fall ist keine zusätzliche Verifizierung erforderlich.



Paygate-Schnittstelle

Definitionen

Datenformate

FormatBeschreibung

a

alphabetisch

as

alphabetisch mit Sonderzeichen

n

numerisch

an

alphanumerisch

ans

alphanumerisch mit Sonderzeichen

ns

numerisch mit Sonderzeichen

bool

Bool’scher Ausdruck (true oder false)

3

feste Länge mit 3 Stellen/Zeichen

..3

variable Länge mit maximal 3 Stellen/Zeichen

enum

Aufzählung erlaubter Werte

dttm

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


Abkürzungen

AbkürzungBeschreibungKommentar

CND

Bedingung (condition)


M

Pflicht (mandatory)

Wenn ein Parameter Pflicht ist, dann muss er vorhanden sein

O

optional

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

C

bedingt (conditional)

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


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


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

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

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


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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

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

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

KeyFormatCNDDescription

MerchantID

ans..30

M

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

Key

Format

CND

Description

TransIDans..18C

TransactionID which should be unique for each payment.

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

RefNr

ns..30

C

Unique reference number.

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

PayID

an32

C

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

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

InvoiceNrans..30C

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

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

KeyFormatCNDDescription
Amountn..10M

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

KeyFormatCNDDescription
Currency

a3

M

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

KeyFormatCNDDescription

MAC

an64

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

KeyFormatCNDDescription
UserData

ans..1024

O

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

Key

Format

CND

Description

EventTokena..19M

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

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

AddrCountryCodea2M

Country code

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

Orderans..1024M

Order information as JSON string in Base64 format.

See JSON object: Order

For EventToken="Return", see JSON object RefundOrder

Parameter für Zahlungen mit Riverty (AfterPay) SCA


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

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

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

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

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

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

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

KeyFormatCNDDescription
XID

an32

M

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

Key

Format

CND

Description

TransIDans..18MTransactionID which should be unique for each payment

RefNr

ns..30

O

Unique reference number

KeyFormatCNDDescription
Status

a..50

M

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

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription
UserData

ans..1024

O

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

Key

Format

CND

Description

CodeExt

n..10

O

Error code from Riverty, if agreed with Computop Helpdesk

ErrorText

ans..1024

O

Error text from Riverty, if agreed with Computop Helpdesk

AllowedPayMethods

ans..1024

O

Permissible payment methods as JSON string in the Base64 format

(see JSON objects: AllowedPayMethods)

Ergebnis-Parameter für Riverty (AfterPay) SCA


Im zweiten Schritt werden die Kunden- und Bestelldaten sowie die zu verwendende Zahlungsart und evtl. weitere zur Zahlungsart gehörende Informationen übergeben.

Um den zweiten Schritt durchzuführen, verwenden Sie bitte folgende URL:


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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

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

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

KeyFormatCNDDescription

MerchantID

ans..30

M

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

KeyFormatCNDDescription
PayID

an32

M

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

Key

Format

CND

Description

TransIDans..18MTransactionID which should be unique for each payment

RefNr

ns..30

O

Unique reference number

KeyFormatCNDDescription
Amountn..10M

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

KeyFormatCNDDescription
Currency

a3

M

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

KeyFormatCNDDescription

MAC

an64

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

KeyFormatCNDDescription
URLSuccess

ans..256

M

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

(info) Common notes:

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

KeyFormatCNDDescription
URLFailure

ans..256

M

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

(info) Common notes:

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

KeyFormatCNDDescription
Response

a7

O

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

KeyFormatCNDDescription
URLNotify

ans..256

M

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

(info) Common notes:

  • Before follow-up actions (capture / credit / reversal) are carried out on an existing transaction, the first Notify must have been answered by the shop.
  • Fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Key

Format

CND

Description

PayTypea..19M

Payment method:

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

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

bdCompanyOrPerson

a..7

M

Customer category:

„Company“

„Person“ (default value)

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. This parameter is linked to the parameter bdCompanyOrPerson.

LegalFormans..50O

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

Possible values:

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

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

For Switzerland: AG, eG, e.V.

AddrCountryCodea2O

Country code:

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

AddrZipans..10MPostcode
AddrStreet

ans..80

M

Street name or packstation

AddrStreetNr

a..50

O

Street number or packstation number

AddrStreetNr2

ans..10

O

Street number addition

AddrCityans..100MCity
careOfans..50O

Care of.

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

FirstNameans..50MFirst name
LastNameans..50MLast name
CustomerIDans..20OUnique customer number
Salutationa..4O

Salutation:

„Mr“

„Mrs“

„Miss“

bdEmail

ans..100

M

E-mail address

bdPhone

ns..20

O

Telephone number

bdMobileNo

ns..20

M

Mobile number

DateOfBirth

an10

M

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

bdCompanyans..255C

Purchasing company name.

Required if bdCompanyOrPerson is 'Company'.

VatIDans..50C

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

The field is mandatory for processing B2B transactions for Germany. 

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.

Language

a2

O

Language: "NO", "SE", "FI", "DK”, "EN”, "DE”, "NL”, "FR” permitted
CompanyOrPersona..7C

Customer category for delivery address:

„Company“

„Person“ (default value)

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

sdCountryCodea2OCountry code of the delivery address: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”
sdZip

ans..10

O

Postcode in the delivery address

sdStreet

ans..80

O

Street name or packstation of the delivery address

sdStreetNr

a..50

O

Street number or packstation number of the delivery address

sdStreetNr2

ans..10

O

Street number addition of the delivery address

sdCity

ans..100

O

Town/city of the delivery address

sdcareOfans..50O

Care of.

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

ShippingMethodans..50O

Address type.

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

sdFirstName

ans..50

O

First name in the delivery address

sdLastName

ans..50

O

Last name in the delivery address

sdSalutation

a..4

O

Salutation in the delivery address

„Mr“

„Mrs“

„Miss“

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

Email

ans..100

O

E-mail address of the delivery address
Phone

ns..50

C

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

MobileNo

ns..50

C

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

sdCompanyans..50C

Delivery company name.

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

BIC

ans..11

O

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

IBAN

ans..34

C

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

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

ProductNr

n..8

C

Profile number

Obligatory for PayType = "Account" or "Installment"

InvoiceDatean10O

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

Only for PayType = "ConsolidatedInvoice"

Parameter für Riverty


Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate an Ihre URLSuccess, URLFailure und URLNotify übergibt. Wenn Sie den Parameter Response=encrypt angegeben haben, werden die folgenden Parameter mit Blowfish verschlüsselt an Ihr System übergeben:

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

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

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

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

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

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

KeyFormatCNDDescription
XID

an32

M

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

Key

Format

CND

Description

TransIDans..18MTransactionID which should be unique for each payment

RefNr

ns..30

O

Unique reference number

Statusa..50MAUTHORIZE_REQUEST or FAILED

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription
UserData

ans..1024

O

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

Key

Format

CND

Description

CodeExt

n..10

O

Error code from Riverty, if agreed with Computop Helpdesk

ErrorText

ans..1024

O

Error text from Riverty, if agreed with Computop Helpdesk

BillingAddressans..1024O

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

(see JSON objects: Address)

ShippingAddressans..1024O

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

(see JSON objects: Address)

Ergebnis-Parameter für Riverty


Aufruf der Schnittstelle für Ein-Schritt-Autorisierung

Um eine Ein-Schritt-Autorisierung mit Riverty abzuwickeln, verwenden Sie bitte folgende URL:


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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

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

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

KeyFormatCNDDescription

MerchantID

ans..30

M

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

Key

Format

CND

Description

TransIDans..18MTransactionID which should be unique for each payment

RefNr

ns..30

O

Unique reference number

KeyFormatCNDDescription
Amountn..10M

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

KeyFormatCNDDescription
Currency

a3

M

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

KeyFormatCNDDescription

MAC

an64

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

KeyFormatCNDDescription
URLSuccess

ans..256

M

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

(info) Common notes:

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

KeyFormatCNDDescription
URLFailure

ans..256

M

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

(info) Common notes:

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

KeyFormatCNDDescription
Response

a7

O

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

KeyFormatCNDDescription
URLNotify

ans..256

M

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

(info) Common notes:

  • Before follow-up actions (capture / credit / reversal) are carried out on an existing transaction, the first Notify must have been answered by the shop.
  • Fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Key

Format

CND

Description

PayTypea..19M

Payment method:

"Invoice" for Invoice

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

BIC

ans..11

O

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

IBAN

ans..34

C

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

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

bdCompanyOrPerson

a..7

O

Customer category:

„Company“

„Person“ (default value)

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. This parameter is linked to the parameter bdCompanyOrPerson.

LegalFormans..50O

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

Possible values:

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

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

For Switzerland: AG, eG, e.V.

AddrCountryCodea2O

Country code:

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

AddrZipans..10MPostcode
AddrStreet

ans..80

M

Street name or packstation

AddrStreetNr

a..50

O

Street number or packstation number

AddrStreetNr2

ans..10

O

Street number addition

AddrCityans..100MCity
careOfans..50O

Care of.

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

FirstNameans..50MFirst name
LastNameans..50MLast name
CustomerIDans..20OUnique customer number
Salutationa..4O

Salutation:

„Mr“

„Mrs“

„Miss“

bdEmail

ans..100

M

E-mail address

bdPhone

ns..20

O

Telephone number

bdMobileNo

ns..20

M

Mobile number

DateOfBirth

an10

M

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

bdCompanyans..50C

Purchasing company name.

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

VatIDans..50C

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

The field is mandatory for processing B2B transactions for Germany. 

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.

Language

a2

O

Language: "NO", "SE", "FI", "DK”, "EN”, "DE”, "NL”, "FR” permitted
CompanyOrPersona..7C

Customer category for delivery address:

„Company“

„Person“ (default value)

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

sdCountryCodea2OCountry code of the delivery address: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”
sdZip

ans..10

O

Postcode in the delivery address

sdStreet

ans..80

O

Street name or packstation of the delivery address

sdStreetNr

a..50

O

Street number or packstation number of the delivery address

sdStreetNr2

ans..10

O

Street number addition of the delivery address

sdCity

ans..100

O

Town/city of the delivery address

sdcareOfans..50O

Care of.

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

ShippingMethodans..50O

Address type.

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

sdFirstName

ans..50

O

First name in the delivery address

sdLastName

ans..50

O

Last name in the delivery address

sdSalutation

a..4

O

Salutation in the delivery address

„Mr“

„Mrs“

„Miss“

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

Email

ans..100

O

E-mail address of the delivery address
Phone

ns..50

O

Phone number in the delivery address

MobileNo

ns..50

O

Mobile number of the delivery address

sdCompanyans..50C

Delivery company name.

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

Orderans..1024M

Order information as JSON string in Base64 format.

See JSON object: Order

Parameter für Zahlungen mit Riverty


Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate an Ihre URLSuccess, URLFailure und URLNotify übergibt. Wenn Sie den Parameter Response=encrypt angegeben haben, werden die folgenden Parameter mit Blowfish verschlüsselt an Ihr System übergeben:

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

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

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

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

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

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

KeyFormatCNDDescription
XID

an32

M

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

Key

Format

CND

Description

TransIDans..18MTransactionID which should be unique for each payment

RefNr

ns..30

O

Unique reference number

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription
UserData

ans..1024

O

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

Key

Format

CND

Description

CodeExt

n..10

O

Error code from Riverty, if agreed with Computop Helpdesk

ErrorText

ans..1024

O

Error text from Riverty, if agreed with Computop Helpdesk

BillingAddressans..1024O

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

(see JSON objects: Address)

ShippingAddressans..1024O

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

(see JSON objects: Address)

Ergebnis-Parameter für Riverty


Buchung

Buchungen sind über eine Server-zu-Server-Kommunikation möglich. Um eine Buchung (Capture) für Riverty über eine Server-zu-Server-Verbindung auszuführen, verwenden Sie bitte folgende URL:


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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

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

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

KeyFormatCNDDescription

MerchantID

ans..30

M

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

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for the payment to be captured

Key

Format

CND

Description

TransIDans..18MTransactionID which should be unique for each payment

RefNr

ns..30

O

Unique reference number

KeyFormatCNDDescription
Amountn..10M

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

KeyFormatCNDDescription
Currency

a3

M

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

KeyFormatCNDDescription

MAC

an64

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

Key

Format

CND

Description

OrderDescans..768ODescription of purchased goods, unit prices, merchant’s comment etc.

KeyFormatCNDDescription
ReqId

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.

KeyFormatCNDDescription
UserData

ans..1024

O

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

Key

Format

CND

Description

Orderans..1024C

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

Order information as JSON string in Base64 format.

See JSON object: Order

InvoiceNrans..30O

Is considered only if Order is also transferred.

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

ShippingDataans..1024O

Is considered only if Order is also transferred.

Shipping information as JSON string in Base64 format.

(see JSON objects: ShippingData)

Parameter für Riverty-Buchungen


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

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

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

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

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

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

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

KeyFormatCNDDescription
XID

an32

M

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

Key

Format

CND

Description

TransIDans..18MTransactionID which should be unique for each payment

RefNr

ns..30

O

Unique reference number

Statusa..50MOK, CAPTURE_REQUEST or FAILED

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription
UserData

ans..1024

O

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

Key

Format

CND

Description

InvoiceNumberans..30OBooking number: generated by merchant or, if not available, by Riverty. Is necessary for partial credits.
CodeExt

n..10

O

Error code from Riverty, if agreed with Computop Helpdesk

ErrorText

ans..1024

O

Error text from Riverty, if agreed with Computop Helpdesk

Ergebnis-Parameter für Riverty-Buchungen


Gutschrift mit Referenz

Gutschriften sind über eine Server-zu-Server-Kommunikation möglich. Bei einer Gutschrift mit Bezug auf eine Buchung ist die Höhe der Gutschrift auf die Höhe der vorangegangen Buchung beschränkt. Um eine Gutschrift (Credit) mit Referenztransaktion auszuführen, verwenden Sie bitte folgende URL:


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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

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

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

KeyFormatCNDDescription

MerchantID

ans..30

M

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

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for the payment to be credited

Key

Format

CND

Description

TransIDans..18MTransactionID which should be unique for each payment

RefNr

ns..30

O

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

KeyFormatCNDDescription
Amountn..10M

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

KeyFormatCNDDescription
Currency

a3

M

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

KeyFormatCNDDescription

MAC

an64

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

Key

Format

CND

Description

OrderDescans..768ODescription of purchased goods, unit prices, merchant’s comment etc.

KeyFormatCNDDescription
UserData

ans..1024

O

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

KeyFormatCNDDescription
ReqId

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.

Key

Format

CND

Description

Orderans..1024C

Mandatory for partial credits

Order information as JSON string in Base64 format.

See JSON object: RefundOrder

InvoiceNrans..30C

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

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

RefundTypeenumO

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

Is necessary only for a full credit.

Parameter für Gutschrift von Riverty-Zahlungen


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

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

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

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

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

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

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

KeyFormatCNDDescription
XID

an32

M

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

Key

Format

CND

Description

TransIDans..18MTransactionID which should be unique for each payment

RefNr

ns..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription
UserData

ans..1024

O

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

Key

Format

CND

Description

CodeExt

n..10

O

Error code from Riverty, if agreed with Computop Helpdesk

ErrorText

ans..1024

O

Error text from Riverty, if agreed with Computop Helpdesk

Ergebnis-Parameter für Gutschrift von Riverty-Zahlungen


Storno

Stornierungen sind über eine Server-zu-Server-Kommunikation möglich. Um eine Transaktion bei Riverty zu stornieren, verwenden Sie bitte folgende URL:


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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

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

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

KeyFormatCNDDescription

MerchantID

ans..30

M

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

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for the payment to be reversed

Key

Format

CND

Description

TransIDans..18MTransactionID which should be unique for each payment

KeyFormatCNDDescription
Amountn..10M

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

KeyFormatCNDDescription
Currency

a3

M

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

KeyFormatCNDDescription

MAC

an64

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

KeyFormatCNDDescription
UserData

ans..1024

O

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

KeyFormatCNDDescription
ReqId

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.

Key

Format

CND

Description

Orderans..1024C

Mandatory for partial reversals

Order information as JSON string in Base64 format.

See JSON object: Order

Parameter für Storno von Riverty-Zahlungen


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

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

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

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

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

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

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

KeyFormatCNDDescription
XID

an32

M

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

Key

Format

CND

Description

TransIDans..18MTransactionID which should be unique for each payment

KeyFormatCNDDescription
Amountn..10M

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

KeyFormatCNDDescription
Currency

a3

M

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

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription
UserData

ans..1024

O

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

Key

Format

CND

Description

CodeExt

n..10

O

Error code from Riverty, if agreed with Computop Helpdesk

ErrorText

ans..1024

O

Error text from Riverty, if agreed with Computop Helpdesk

Ergebnis-Parameter für Storno von Riverty-Zahlungen


Batch-Nutzung der Schnittstelle

Grundsätzliche Informationen zur Arbeit mit Batch-Dateien sowie zu deren Aufbau erfahren Sie im separaten Handbuch zum Batchmanager. Im Batch-Verfahren sind nicht alle Funktionen verfügbar, die für die Online-Schnittstelle verfügbar sind.

Dieses Kapitel beschreibt die Parameter, die Sie im Datensatz (Record) für die Ausführung einer Riverty-Zahlung übergeben müssen und welche Informationen Sie der Antwort-Datei über den Status des Zahlungsvorgangs entnehmen können.

Hinweis: Beachten Sie bitte, dass keine Teil-Stornierungen, -Buchungen oder -Gutschriften über Batch für Riverty möglich sind.

Folgende Tabelle gibt eine Übersicht der pro Aktion jeweils möglichen Batch-Versionen und ihrer Besonderheiten:

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

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

Action

Version

Description

Capture

1.0 / 2.0

Standard version without return of parameter Code


1.x / 2.x

with RefNr (valid for all versions other than 1.0)

Credit

1.0 / 2.0

Standard version without return of parameter Code


1.x / 2.x

with RefNr (valid for all versions other than 1.0)

Reverse

1.0 / 2.0

Standard version without return of parameter Code


1.x / 2.x

with RefNr (valid for all versions other than 1.0)

Beschreibung der möglichen Batch-Versionen


Der Aufbau für eine Riverty-Zahlung in einer einzureichenden Batch-Datei sieht folgendermaßen aus:

HEAD,<MerchantID>,<Date>,<Version>
AFTERPAY,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>
AFTERPAY,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>
AFTERPAY,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>
FOOT,<CountRecords>,<SumAmount>


Beispiel für Master-MID-Funktion:

HEAD,[Master]MerchantID,Date,2.x
Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action)
FOOT,CountRecords,SumAmount


Die folgende Tabelle beschreibt die einzelnen Felder und Werte, die im Datensatz (Record) innerhalb der Batch-Datei verwendet werden:

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

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

Key

Format

CND

Description

Type

a..11

M

HEAD for Header, FOOT for Footer, AFTERPAY for Riverty

Action

a..20

M

The parameter Action defines the type of transaction:

Capture

Credit

Reverse (cancellation)

KeyFormatCNDDescription
Amountn..10M

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

KeyFormatCNDDescription
Currency

a3

M

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

Key

Format

CND

Description

TransIDans..18MTransactionID which should be unique for each payment

RefNr

ns..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for this transaction

Beschreibung der Felder im Datensatz von Batch-Dateien


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

HEAD,<MerchantID>,<Date>,<Version>
AFTERPAY,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>
AFTERPAY,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>
AFTERPAY,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>
FOOT,<CountRecords>,<SumAmount>


Die folgende Tabelle beschreibt die Antwort-Parameter, die der Batch-Manager im Record-Bereich zu jeder Transaktion speichert (hier nicht erklärte Standardparameter wie etwa <TransID> oder <RefNR> und Aufrufparameter werden unverändert zum Aufruf wieder zurückgegeben und sind vorstehend beschrieben):

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

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

Key

Format

CND

Description

Action

a..20

M

The parameter Action defines the type of transaction:

Capture

Credit

Reverse (cancellation)

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for this transaction

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
Code

an8

M

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

Beschreibung der Ergebnis-Parameter im Datensatz von Batch-Dateien


JSON-Objekte

Die JavaScript Object Notation, kurz JSON, ist ein kompaktes Datenformat in einer einfach lesbaren Textform zum Zweck des Datenaustauschs zwischen Anwendungen. JSON ist unabhängig von der Programmiersprache. Parser existieren in praktisch allen verbreiteten Sprachen. Einige Informationen über JSON sind unter diesem Link zu finden:


Im Folgenden werden die JSON-Objekte beschrieben, die für Requests benötigt oder aber in der Response zurückgeliefert werden.

Hinweis: Da der JSON-String Sonderzeichen enthalten kann, muss er zusätzlich Base64-codiert werden. Anderenfalls kann es zu Problemen bei der Übertragung kommen.


CustomerRisk

Risikorelevante Daten zum Kunden. Händler können externe Risikoprüfungen durchführen und Riverty diese Informationen zusenden.

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

existingCustomerboolOIndicates whether the customer is an existing customer of the merchant
verifiedCustomerIdentification

bool

O

Indicates whether the customer has been verified

marketingOptIn

bool

O

Indicates whether marketing material is requested

customerSince

dttm

O

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

customerClassification

ans..32

O

Customer classification

acquisitionChannel

enum

O

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

hasCustomerCard

bool

O

Indicates whether the customer has a loyalty card

customerCardSince

dttm

O

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

customerCardClassification

ans..32

O

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

profileTrackingId

ans..64

O

Unique TrackingID

ipAddress

ans..15

M

Customer´s IP address

numberOfTransactions

n..5

O

Number of successful transactions already completed by the customer

customerIndividualScore

n..5

O

Individual score for the customer supplied by the merchant

userAgentans..32OUserAgent of this specific consumer 
amountOfTransactionsn..5OAmount of paid orders last 12 months 
otherPaymentMethodsboolOOther payment method than MI in wallet

Beispiel CustomerRisk als JSON-String

{
      "existingCustomer" : true,
      "verifiedCustomerIdentification" : "true",
      "marketingOptIn" : "false",
      "customerSince" : "2015-11-20",
      "customerClassification" : "Classification",
      "acquisitionChannel" : “SearchEngine”,
      "hasCustomerCard" : true,
      "customerCardSince" : "2016-01-23",
      "customerCardClassification" : "Gold Member",
      "profileTrackingId" : "TrackingID123456",
      "ipAddress" : "201.18.14.2",
      "numberOfTransactions" : 27,
      "customerIndividualScore" : 98,
      "userAgent" : "",
      "amountOfTransactions" : 1,
      "otherPaymentMethods" : true
}



Order

Hier werden die Informationen zu einer Bestellung definiert.

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

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

Key

Format

CND

Description

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.

currency

enum

O

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

risk

ans..1024

O

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

items

Array

M

Array of OrderItems (see JSON object: OrderItem)

totalNetAmount

ans..16

M

Net order amount

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

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.

OrderRisk

Hier werden die Informationen zum Risiko der Bestellung definiert.

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

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

Key

Format

CND

Description

channelType

ans..64

O

Order channel type. Possible values:

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

deliveryType

ans..64

O

Order delivery type. Possible values:

"Normal", "Express".

ticketDeliveryMethodans..64O

Name of the tickets' method. Possible values:

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

OrderItem

Hier werden die Informationen zu einem Artikel definiert.

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

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

Key

Format

CND

Description

productId

ans..64

MArticle number
description

ans..128

M

Article description

typeans..64O

Order item type. Possible values:

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

quantity

n..8

M

Article quantity

Decimal values, if agreed with Computop and Riverty.

grossUnitPrice

ans..16

M

Gross price per article

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

grouId

ans..64

O

GroupID

netUnitPrice

ans..16

M

Net price per article

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

unitCode

ans..16

O

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

vatCategory

enum

O

VAT category

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

vatPercent

n..2

M

VAT in percent

vatAmount

ans..16

M

VAT as amount per item

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

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.

googleProductCategoryId

n..16

O

Google Product Category ID

googleProductCategory

ans..64

O

Google Product Category

merchantProductType

ans..64

O

Merchant category in addition to Google classification

lineNumber

n.3

O

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

discountAmount

ans..16

O

Discount amount (only for statistical purposes)

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

productUrl

ans..256

O

Article URL

marketPlaceSellerId

ans..64

O

ID of a specific market place

Beispiel Order als JSON-String

{
       "totalGrossAmount" : 12.40,
       "totalNetAmount" : 10.43,
       "currency" : "EUR",
       "risk" : {
                    "channelType" : "Catalog",
                    "deliveryType" : "Normal",
                    "ticketDeliveryMethod" : "NotSet"                    
             },
       "items" : [{
                    "productId" : "1",
                    "description" : "Tablet Black",
                    "type" : "PhysicalArticle",
                    "grossUnitPrice" : 4.10,
                    "netUnitPrice" : 3.45,
                    "quantity" : 2.0,
                    "vatAmount" : 0.65,
                    "vatPercent" : 19.0                             
             }, {
                    "productId" : "2",
                    "description" : "MusicPlayer Black",
                    "type" : "PhysicalArticle",
                    "grossUnitPrice" : 4.20,
                    "netUnitPrice" : 3.53,
                    "quantity" : 1.0,
                    "vatAmount" : 0.67,
                    "vatPercent" : 19.0
             }
       ]
}



AllowedPayMethods

Hier werden die Informationen zu den erlaubten Zahlungsarten in einem Array definiert.

PaymentMethod

Hier werden die Informationen zu einem Artikel definiert.

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

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

Key

Format

CND

Description

type

ans..32

O

Available payment method

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

account

AccountProduct

O

Account information (see JSON object: AccountProduct)

directDebit

DirectDebitInfo

O

Direct-Debit information (see JSON object: DirectDebitInfo)

campaigns

Array

O

Array of campaign information (see JSON object: CampaignInfo)

Installment

InstallmentInfo

O

Instalment payment information (see JSON object: InstallmentInfo)

legalInfolegalInfoOLegal info containing Terms and Conditions, Privacy statement, etc. (see JSON object: LegalInfo)

AccountProduct

Hier werden die Informationen zu einem AccountProduct definiert.

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

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

Key

Format

CND

Description

profileNon..32MAccount profile number

DirectDebitInfo

Hier werden die Informationen zu DirectDebitInfo definiert.

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

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

Key

Format

CND

Description

AvailableboolOIndicates whether DirectDebit is available

CampaignInfo

Hier werden die Informationen zu CampaignInfo definiert.

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

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

Key

Format

CND

Description

campaignNo

n..32

O

Campaign number

description

ans..128

O

Campaign description

InstallmentInfo

Hier werden die Informationen zu InstallmentInfo definiert.

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

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

Key

Format

CND

Description

basketAmountenumO

Available payment method

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

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

numberOfInstallments

n..2

O

Number of installments

installmentAmount

ans..16

O

Installment amount for each month

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

firstInstallmentAmount

ans..16

O

First installment amount

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

lastInstallmentAmount

ans..16

O

Final installment amount

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

interestRate

ans..16

O

Interest rate

effectiveInterestRate

ans..16

O

Effective interest rate

effectiveAnnualPercentageRate

ans..16

O

Effective annual percentage

totalInterestAmount

ans..16

O

Total interest rate

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

startupFee

ans..16

O

Starting fee

monthlyFee

ans..16

O

Monthly fee

totalAmount

ans..16

O

Total amount

installmentProfileNumber

ans..16

O

Installment profile number

readMore

ans..128

O

Further information about the installment process

LegalInfo

Hier werden die Informationen zu LegalInfo definiert.

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

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

Key

Format

CND

Description

requiresCustomerConsentboolO"true", if customer consent is required

termsAndConditionsUrl

ans..250

O

URL to Terms and Conditions

privacyStatementUrl

ans..250

O

URL to Privacy Statement

bgb507Url

ans..250

O

URL to § 507 BGB

text

ans..2500

O

Legal text

Beispiel AllowedPaymentMethods als JSON-String

"paymentMethods": [{
	"type": "string",
        "title": "string",
        "tag": "string",
        "consumerFeeAmount": 1.00,
        "logo": "string",
	"account": { ... } ,
	"directDebit": {"available": true},
	"campaigns": { ... },
	"installment": {
		"basketAmount": 1.00,
		"numberOfInstallments": 1,
		"installmentAmount": 1.00,
		"firstInstallmentAmount": 1.00,
		"lastInstallmentAmount": 1.00,
		"interestRate": 1.00,
		"effectiveInterestRate": 1.00,
		"effectiveAnnualPercentageRate": 1.00,
		"totalInterestAmount": 1.00,
		"startupFee": 1.00,
		"monthlyFee": 1.00,
		"totalAmount": 1.00,
		"installmentProfileNumber": 1,
		"readMore": "string"
	},
	"legalInfo": {
		"requiresCustomerConsent": true,
		"termsAndConditionsUrl": "string",
		"privacyStatementUrl": "string",
		"bgb507Url": "string",
		"text": "string"
	},
}]



Address

Hier werden die Informationen zu ggfls. korrigierten Rechnungsdaten in einem Array definiert.

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

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

Key

Format

CND

Description

countryCode

enum

M

Country code

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

postalCode

ans..10

M

Postal code

postalPlace

ans..100

M

City

Street

ans..100

M

Street or packstation

streetNumber

ans..10

M

Street number or packstation number

streetNumberAdditional

ans..10

O

Street number addition

careOf

ans..50

O

Responsible person for dispatch of shipment

Beispiel Address als JSON-String

{
       [{
             "countryCode" : "DE",
             "postalCode" : "10405",
             "street" : "Prenzlauer Allee",
             "streetNumber" : 20
             "streetNumberAdditional" : "3. Stock",
             "postalPlace" : "Berlin",
             "addressType" : null,
             "careOf" : null
       }
      ]
}



OrderSummary

Hier werden die Informationen zu einer OrderSummary definiert.

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

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

Key

Format

CND

Description

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.

currency

enum

O

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

items

Array

O

Array of OrderItems (see JSON object: OrderItem)

totalNetAmount

ans..16

O

Net order amount

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

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.

googleAnalyticsUserId

ans..64

O

Google Analytics UserID

googleAnalyticsClientId

ans..64

O

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.

Beispiel OrderSummary als JSON-String

{
      "totalGrossAmount" : 8.30,
      "currency" : "EUR",
      "items" : [{
                  "productId" : "1",
                  "description" : "Tablet Black",
                  "grossUnitPrice" : 4.10,
                  "quantity" : 1.0
            }, {
                  "productId" : "2",
                  "description" : "MusicPlayer Black",
                  "grossUnitPrice" : 4.20,
                  "quantity" : 1.0
            }
      ]
}



ShippingData

Hier werden die Informationen zum Versand in einem Array definiert.

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

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

Key

Format

CND

Description

shippingDetailsArrayMArray of shipping information (see JSON object: ShippingDetails)

ShippingDetails

Hier werden die Informationen zu ShippingDetails definiert.

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

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

Key

Format

CND

Description

type

enum

M

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

shippingCompany

ans..64

M

Shipping company

trackingId

ans..64

M

Unique TrackingID

Beispiel ShippingData als JSON-String

{
      "shippingDetails" : [{
                  "type" : "Shipment",
                  "shippingCompany" : "DHL",
                  "trackingId" : "234324234"
            }, {
                  "type" : "Shipment",
                  "shippingCompany" : "Hermes",
                  "trackingId" : "687654"
            }
      ]
}



RefundOrder

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

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

orderItemsArrayMArray of articles to be credited (see JSON object: RefundOrderItem)

RefundOrderItem

Hier werden die Informationen zu einem RefundOrderItem definiert.

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

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

Key

Format

CND

Description

refundType

ans..32

C

Credit type: Possible values are "Refund“, "Return"

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

productId

ans..64

M

Article number

description

ans..128

M

Article description

quantity

n..8

M

Article quantity

Decimal values, if agreed with Computop and Riverty.

grossUnitPrice

ans..16

M

Gross price per article

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

groupId

ans..64

O

GroupID

netUnitPrice

ans..16

M

Net price per article

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

unitCode

ans..16

O

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

vatCategory

ans..32

O

VAT category

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

vatPercent

n..2

M

VAT in percent

vatAmount

ans..16

M

VAT as amount per item

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

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.

googleProductCategoryId

n..16

O

Google Product Category ID

googleProductCategory

ans..64

O

Google Product Category

merchantProductType

ans..64

O

Merchant category in addition to Google classification

lineNumber

n.3

O

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

discountAmount

ans..16

O

Discount amount (only for statistical purposes)

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

productUrl

ans..256

O

Article URL

marketPlaceSellerId

ans..64

O

ID of a specific market place

Beispiel RefundOrder als JSON-String

[
           {
                  "refundType" : "Return",
                  "productId" : "1",
                  "description" : "Tablet Black",
                  "quantity" : 1.0,
                  "grossUnitPrice" : 4.10,
                  "netUnitPrice" : 3.45,
                  "vatPercent" : 19.0,
                  "vatAmount" : 0.65
            }
           , {
                  "refundType" : "Return",
                  "productId" : "2",
                  "description" : "MusicPlayer Black",
                  "quantity" : 1.0,
                  "grossUnitPrice" : 4.20,
                  "netUnitPrice" : 3.53,
                  "vatPercent" : 19.0,
                  "vatAmount" : 0.67
            }
]


  • No labels