About Riverty Debtor Management (Accounting as Service)

General information about Riverty Debtor Management

Computop Paygate offers together with a partner/third party service provider a complete debtor management system to merchants. Via Computop the merchant can maintain debtor accounts and provide information about payment status of all payment methods to the service provider to ensure account checking and traceability.


Logo

Info

Paygate offers individually scalable solutions for financial and debtor accountings – including the downstream processes such as logistics, dunnings or debt collection.

TypeDebtors Management

Further information can be found on the webpage of Riverty Debtor Management (https://www.riverty.com/de/business/produkte/accounting-as-a-service/).

 

Process flow chart






Paygate interface

Definitions

Data formats

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)


Abbreviations

Abbreviation

Description

Comment

CND

condition


M

mandatory

If a parameter is mandatory, then it must be present

O

optional

If a parameter is optional, then it can be present, but it is not required

C

conditional

If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional


Notice: Please note that the names of parameters can be returned in upper or lower case.


Create Order

In order to carry out a create order for Riverty via a server-to-server connection, please use the following URL:


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

KeyFormatCNDDescriptionBeschreibung

MerchantID

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.

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Amount

n..10

M

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

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

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

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

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

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

M

Unique reference number for the enquiry, for example the order number

Eindeutige Referenznummer zur Anfrage, zum Beispiel Bestellnummer

OrderDescans..768ODescription of the goods purchasedBeschreibung der gekauften Waren
CustomerIDn..10MCustomer numberKundennummer
Eventtokena2M

Abbreviation of the action to be done:

<OC> for Order creation

Abkürzung der durchzuführenden Aktion:

<OC> für Auftragserstellung

PaytypeansM
PaymentMethodNameComputop PayType (Allowed Values)
AfterPayDirectDebitAPDD
AfterPayInstallmentsDirectDebitAPIDD
AfterPayInstallmentsOpenInvoiceAPIOI
AfterPayOpenInvoiceAPOI
AmazonPayAP
AmericanExpressAMEX
ApplePayExpressCheckoutAPEC
ArvatoDirectDebitSepaADDS
BancontactBC
BlikBlik
BlikCodeOnlyBlikCO
CashOnDeliveryCOD
DinersClubDINERS
DiscoverDISC
EpsEPS
GiftcardGC
GiropayGP
GooglePayGPay
IdealID
InAppAmazonIAAM
InAppAppleIAAP
InAppGoogleIAGO
InStoreOpenInvoiceISPOI
InStorePickupISPWP
InStorePrepaymentISPP
PaymentMethodNameComputop PayType (Zulässige Werte)
AfterPayDirectDebitAPDD
AfterPayInstallmentsDirectDebitAPIDD
AfterPayInstallmentsOpenInvoiceAPIOI
AfterPayOpenInvoiceAPOI
AmazonPayAP
AmericanExpressAMEX
ApplePayExpressCheckoutAPEC
ArvatoDirectDebitSepaADDS
BancontactBC
BlikBlik
BlikCodeOnlyBlikCO
CashOnDeliveryCOD
DinersClubDINERS
DiscoverDISC
EpsEPS
GiftcardGC
GiropayGP
GooglePayGPay
IdealID
InAppAmazonIAAM
InAppAppleIAAP
InAppGoogleIAGO
InStoreOpenInvoiceISPOI
InStorePickupISPWP
InStorePrepaymentISPP



Billing DetailsRechnungs-Details
bdSalutationans..10OSalutation ‘Mr’, ‘Ms’, ‘Company’ or ‘Unknown’. ‘Unknown’ applies if not specified or if wrong.Anrede „Herr“, „Frau“, „Firma“ oder „Unbekannt“. Wenn nicht angegeben oder falsch, gilt „Unbekannt“.
bdFirstNameans..24MFirst name of the customerVorname des Kunden
bdLastNameans..30MLast name or company nameNachname oder Firmenname
bdDateOfBirthans..10ODate of birth in the format YYYY-MM-DDGeburtsdatum im Format JJJJ-MM-TT
bdStreetans..30MStreet nameStraßenname
bdstreetNrans..30Mhouse numberHausnummer
bdZipans..5MPostcodePostleitzahl
bdDistrictans..30ODistrictDistrict-Name
bdCityans..30MCityOrt
bdCountryCodea2MCountry code, 2 characters according to ISO 3166, DE=GermanyLändercode zweistellig gemäß ISO 3166, DE=Deutschland



Shipping DetailsLiefer-Details

sdSalutation

ans..10

O

Salutation ‘Mr’, ‘Ms’, ‘Company’ or ‘Unknown’. ‘Unknown’ applies if not specified or if wrong

Anrede „Herr“, „Frau“, „Firma“ oder „Unbekannt“. Wenn nicht angegeben oder falsch, gilt „Unbekannt“.

sdFirstName

ans..24

M

First name of the customer

Vorname des Kunden

sdLastName

ans..30

M

Last name or company name

Nachname oder Firmenname

sdStreet

ans..30

M

Street name and house number

Straßenname und Hausnummer
sdstreetNrans..30Mhouse numberHausnummer

sdDistrict

ans..30

O

Address addition, e.g. town district

Adresszusatz wie z.B. Ortsteil

sdZip

ans..5

M

Postcode

Postleitzahl

sdCity

ans..30

M

City

Ort

sdCountryCode

a2

M

Country code, 2 characters according to ISO 3166, DE=Germany

Ländercode zweistellig gemäß ISO 3166, DE=Deutschland
Phoneans..20OCustomer’s phone numberTelefonnummer des Kunden
Emailans..100OEmail address of the customerE-Mail-Adresse des Kunden
MobileNoans..20OCustomer’s mobile telephone numberMobiltelefonnummer des Kunden
ArticlelistStringMBase64 encoded valueBase64-codierter Wert
itemsarrayMArray of items, e.g.: {"items": [{items1 ...}{item2...}]}Array von Elementen, z. B.: {"items": [{items1 ...}{item2...}]}
items.itemReferenceans..30MPosition of the line item in the orderPosition der Werbebuchung in der Bestellung
items.idans..30MArticle NumberArtikelnummer
items.descriptionans..30MName / Title of the ArticleName / Titel des Artikels
items.quantityans..30MTotal number of itemsGesamtzahl der Artikel
items.amountn..10MGross unit price (incl. VAT) in CentBrutto-Stückpreis (inkl. MwSt.) in Cent
items.vatAmountn..10MTax Amount in centsSteuerbetrag in Cent
items.vatPercentn..10MTax rate of country tax in % as number 19% = 19Steuersatz der Landessteuer in % als nummer 19% = 19
items.vatTypeStringM

TAXLESS = taxless

NORMAL = normal

REDUCED = reduced

TAXLESS = taxless

NORMAL = normal

REDUCED = reduced

items.positionTypeStringM

    SALES_ARTICLE = Sales Article 

    IBAN_VERIFICATION = IBAN verification

    LOYALTY_CARD = Loyalty Card

    SHIPPING_COSTS_EXPRESS = Shipping costs (express)

    FREE_ARTICLE = Free article

    GIFT_CARD_VOUCHER_PAYMENT = Gift Card Voucher Payment

    GIFT_CARD_VOUCHER_SALE = Gift Card Voucher Sale

    SERVICE_CHARGE = Service Charge

    CASH_ON_DELIVERY = Cash on delivery

    MARKETPLACE_PROVISION = Marketplace-Provision

    SUBSCRIPTION_ORDER = Subscription Order

    DISCOUNT = Discount

    SHIPPING_COSTS = Shipping costs

    DISCOUNT_FOR_SUBSCRIPTION_ORDER = Discount for Subscription Order

    SALES_ARTICLE = Sales Article 

    IBAN_VERIFICATION = IBAN verification

    LOYALTY_CARD = Loyalty Card

    SHIPPING_COSTS_EXPRESS = Shipping costs (express)

    FREE_ARTICLE = Free article

    GIFT_CARD_VOUCHER_PAYMENT = Gift Card Voucher Payment

    GIFT_CARD_VOUCHER_SALE = Gift Card Voucher Sale

    SERVICE_CHARGE = Service Charge

    CASH_ON_DELIVERY = Cash on delivery

    MARKETPLACE_PROVISION = Marketplace-Provision

    SUBSCRIPTION_ORDER = Subscription Order

    DISCOUNT = Discount

    SHIPPING_COSTS = Shipping costs

    DISCOUNT_FOR_SUBSCRIPTION_ORDER = Discount for Subscription Order

AmountAuth

a3

O

Authroization amount in cents

Autorisierungsbetrag in Cent
cardholderName

String

C

Name of the cardholder as printed on the card.

Notice: Alphanumeric special characters, listed in EMV Book 4, “Appendix B”. Special characters have been added with EMV 3DS Version 2.3, but not all participants (banks) already support that standard.

Name des Karteninhabers wie auf der Karte aufgedruckt.

Hinweis: Alphanumerische Sonderzeichen, aufgeführt in EMV Buch 4, „Anhang B“. Mit EMV 3DS Version 2.3 wurden Sonderzeichen hinzugefügt, aber nicht alle Teilnehmer (Banken) unterstützen diesen Standard bereits.

expiryDate

String

C

Card expiry in format YYYYMM

Kartenablaufdatum im Format JJJJMM
AccOwnerans..30OAccount holder. Structure: Salutation;FirstName;LastName.Kontoinhaber. Aufbau: Anrede;Vorname;Nachname.
AccBankans..40OName of the bankName der Bank
IBANans..34C

IBAN is mandatory in case of :

AfterPayDirectDebitAPDD
AfterPayInstallmentsDirectDebitAPIDD
ArvatoDirectDebitSepaADDS

Die IBAN ist Pflicht im Fall von:

AfterPayDirectDebitAPDD
AfterPayInstallmentsDirectDebitAPIDD
ArvatoDirectDebitSepaADDS
BICans..11C

BIC is Mandatory in case of:

AfterPayDirectDebitAPDD
AfterPayInstallmentsDirectDebitAPIDD
ArvatoDirectDebitSepaADDS

Die  BIC ist Pflicht im Fall von:

AfterPayDirectDebitAPDD
AfterPayInstallmentsDirectDebitAPIDD
ArvatoDirectDebitSepaADDS
MandateIdans..35CReference of the SEPA Mandate. Mandatory for SEPA Payments.Referenz des SEPA-Mandats. Obligatorisch für SEPA-Zahlungen.

Parameters for creating an order

Articlelist

Articlelist should be sent as a base64 encoded value. Please find the example below.

{
    "items": [
        {
            "itemReference": "1",
            "id": "123457",
            "description": "Test product",
            "quantity": 3,
            "amount": 5500,
            "vatAmount": 500, 
            "vatPercent": 19,
			"vatType": "NORMAL",
			"positionType":"SALES_ARTICLE"
		},
		{
            "itemReference": "2",
			"id": "654327",
			"description": "Test product2",
			"quantity": 1,
			"amount": 500,
			"vatAmount": 100, 
            "vatPercent": 7,
			"vatType": "NORMAL",
			"positionType":"SALES_ARTICLE"
		}
	]
}  Articlelist=ewogICAgIml0ZW1zIjogWwogICAgICAgIHsKICAgICAgICAgICAgIml0ZW1SZWZlcmVuY2UiOiAiMSIsCiAgICAgICAgICAgICJpZCI6ICIxMjM0NTYiLAogICAgICAgICAgICAiZGVzY3JpcHRpb24iOiAiVGVzdCBwcm9kdWN0IiwKICAgICAgICAgICAgInF1YW50aXR5IjogMywKICAgICAgICAgICAgImdyb3NzUHJpY2UiOiA1MDAwLAogICAgICAgICAgICAidmF0QW1vdW50IjogMCwgCiAgICAgICAgICAgICJ2YXRQZXJjZW50IjogMCwKCQkJInZhdFR5cGUiOiJUQVhMRVNTIiwKCQkJInBvc2l0aW9uVHlwZSI6IlNBTEVTX0FSVElDTEUiCgkJfSwKCQl7CiAgICAgICAgICAgICJpdGVtUmVmZXJlbmNlIjogIjIiLAoJCQkiaWQiOiAiNjU0MzIxIiwKCQkJImRlc2NyaXB0aW9uIjogIlRlc3QgcHJvZHVjdDIiLAoJCQkicXVhbnRpdHkiOiAxLAoJCQkiZ3Jvc3NQcmljZSI6IDUwMDAsCgkJCSJ2YXRBbW91bnQiOiAwLCAKICAgICAgICAgICAgInZhdFBlcmNlbnQiOiAwLAoJCQkidmF0VHlwZSI6IlRBWExFU1MiLAoJCQkicG9zaXRpb25UeXBlIjoiU0FMRVNfQVJUSUNMRSIKCQl9CgldCn0=

The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

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

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

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

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

KeyFormatCNDDescriptionBeschreibung
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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

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

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

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

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

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Reference number is returned, if it was previously submitted

Wenn zuvor übergeben, wird die Referenznummer zurückgegeben

CodeExtn..10OError code from RivertyFehlercode von Riverty
ErrorTextans..256OError text from RivertyFehlertext von Riverty
ReferenzIDn..50OUnique ID within information/response from RivertyEindeutige ID der Auskunft/Antwort von Riverty

Response parameters for creating an order


Create an Invoice

In order to create an invoice for Riverty via a server-to-server connection, please use the following URL:


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

KeyFormatCNDDescriptionBeschreibung

MerchantID

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.

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Key

Format

CND

Description

Beschreibung

PayIDans..32M

ID issued by Paygate for order creation

Vom Paygate vergebene ID für die Bonitätsprüfung

InvoiceNrns..30MInvoice NumberRechnung Nummer

RefNr

ns..30

M

Unique reference number, e.g. order number

Eindeutige Referenznummer, z.B. Bestellnummer

DateDateMDate of Invoice (YYYY-MM-DD)Datum der Rechnung (JJJJ-MM-TT)
TrackingIDns..30OShipment Tracking Id from delivery companySendungsverfolgungs-ID des Lieferunternehmens
TrackingNummerns..30OShipment reference of the shopVersandreferenz des Shops
ParcelServiceStringMDelivery Company Eg: DHL Lieferunternehmen z. B.: DHL
DueDateDateMDate on which the invoice is dueDatum, an dem die Rechnung fällig ist
InvoiceDateDateMInvoice Creation DateRechnungserstellungsdatum
DeliveryDateDateMDate of DeliveryDatum der Lieferung
ArticlelistStringMBase64 encoded valueBase64-codierter Wertitems
itemsarrayMArray of items, e.g.: {"items": [{items1 ...}{item2...}]}Array von Elementen, z. B.: {"items": [{items1 ...}{item2...}]}
items.itemReferenceans..30MPosition of the line item in the orderPosition der Werbebuchung in der Bestellung
items.idans..30MArticle NumberArtikelnummer
items.descriptionans..30MName / Title of the ArticleName / Titel des Artikels
items.quantityans..30MTotal number of itemsGesamtzahl der Artikel
items.amountn..10MGross unit price (incl. VAT) in CentBrutto-Stückpreis (inkl. MwSt.) in Cent
items.vatAmountn..10MTax Amount in centsSteuerbetrag in Cent
items.vatPercentn..10MTax rate of country tax in % as number 19% = 19Steuersatz der Landessteuer in % als nummer 19% = 19
items.vatTypeStringM

TAXLESS = taxless

NORMAL = normal

REDUCED = reduced

TAXLESS = taxless

NORMAL = normal

REDUCED = reduced

items.positionTypeStringM

    SALES_ARTICLE = Sales Article 

    IBAN_VERIFICATION = IBAN verification

    LOYALTY_CARD = Loyalty Card

    SHIPPING_COSTS_EXPRESS = Shipping costs (express)

    FREE_ARTICLE = Free article

    GIFT_CARD_VOUCHER_PAYMENT = Gift Card Voucher Payment

    GIFT_CARD_VOUCHER_SALE = Gift Card Voucher Sale

    SERVICE_CHARGE = Service Charge

    CASH_ON_DELIVERY = Cash on delivery

    MARKETPLACE_PROVISION = Marketplace-Provision

    SUBSCRIPTION_ORDER = Subscription Order

    DISCOUNT = Discount

    SHIPPING_COSTS = Shipping costs

    DISCOUNT_FOR_SUBSCRIPTION_ORDER = Discount for Subscription Order

    SALES_ARTICLE = Sales Article 

    IBAN_VERIFICATION = IBAN verification

    LOYALTY_CARD = Loyalty Card

    SHIPPING_COSTS_EXPRESS = Shipping costs (express)

    FREE_ARTICLE = Free article

    GIFT_CARD_VOUCHER_PAYMENT = Gift Card Voucher Payment

    GIFT_CARD_VOUCHER_SALE = Gift Card Voucher Sale

    SERVICE_CHARGE = Service Charge

    CASH_ON_DELIVERY = Cash on delivery

    MARKETPLACE_PROVISION = Marketplace-Provision

    SUBSCRIPTION_ORDER = Subscription Order

    DISCOUNT = Discount

    SHIPPING_COSTS = Shipping costs

    DISCOUNT_FOR_SUBSCRIPTION_ORDER = Discount for Subscription Order

KeyFormatCNDDescriptionBeschreibung
Amount

n..10

M

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

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

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

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

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

Key

Format

CND

Description

Beschreibung

EventTokena2M

Abbreviation of the action to be done: <BT> for Invoice Creation

Abkürzung der auszuführenden Aktion: <BT> für Invoice Creation

Parameters for creating invoices

Articlelist

{
    "items": [
        {
            "itemReference": "1",
            "id": "123457",
            "description": "Test product",
            "quantity": 3,
            "amount": 5500,
            "vatAmount": 500, 
            "vatPercent": 19,
			"vatType": "NORMAL",
			"positionType":"SALES_ARTICLE"
		},
		{
            "itemReference": "2",
			"id": "654327",
			"description": "Test product2",
			"quantity": 1,
			"amount": 500,
			"vatAmount": 100, 
            "vatPercent": 7,
			"vatType": "NORMAL",
			"positionType":"SALES_ARTICLE"
		}
	]
}  Articlelist=ewogICAgIml0ZW1zIjogWwogICAgICAgIHsKICAgICAgICAgICAgIml0ZW1SZWZlcmVuY2UiOiAiMSIsCiAgICAgICAgICAgICJpZCI6ICIxMjM0NTYiLAogICAgICAgICAgICAiZGVzY3JpcHRpb24iOiAiVGVzdCBwcm9kdWN0IiwKICAgICAgICAgICAgInF1YW50aXR5IjogMywKICAgICAgICAgICAgImdyb3NzUHJpY2UiOiA1MDAwLAogICAgICAgICAgICAidmF0QW1vdW50IjogMCwgCiAgICAgICAgICAgICJ2YXRQZXJjZW50IjogMCwKCQkJInZhdFR5cGUiOiJUQVhMRVNTIiwKCQkJInBvc2l0aW9uVHlwZSI6IlNBTEVTX0FSVElDTEUiCgkJfSwKCQl7CiAgICAgICAgICAgICJpdGVtUmVmZXJlbmNlIjogIjIiLAoJCQkiaWQiOiAiNjU0MzIxIiwKCQkJImRlc2NyaXB0aW9uIjogIlRlc3QgcHJvZHVjdDIiLAoJCQkicXVhbnRpdHkiOiAxLAoJCQkiZ3Jvc3NQcmljZSI6IDUwMDAsCgkJCSJ2YXRBbW91bnQiOiAwLCAKICAgICAgICAgICAgInZhdFBlcmNlbnQiOiAwLAoJCQkidmF0VHlwZSI6IlRBWExFU1MiLAoJCQkicG9zaXRpb25UeXBlIjoiU0FMRVNfQVJUSUNMRSIKCQl9CgldCn0=

The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

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

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

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

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

KeyFormatCNDDescriptionBeschreibung
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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

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

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

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

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

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Reference number is returned, if it was previously submitted

Wenn zuvor übergeben, wird die Referenznummer zurückgegeben

CodeExtn..10OError code from RivertyFehlercode von Riverty
ErrorTextans..256OError text from RivertyFehlertext von Riverty
ReferenzIDn..50OUnique ID within information/response from RivertyEindeutige ID der Auskunft/Antwort von Riverty

Response parameters for creating invoices


Cancel Order and Credit Invoice

With reference to a previously set up order and invoice, you can cancel the order and credit the invoice. For that purpose, please use the following URL:


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

KeyFormatCNDDescriptionBeschreibung

MerchantID

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.

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Amount

n..10

M

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

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

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

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

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

Key

Format

CND

Description

Beschreibung

InvoiceNr

ns..30

M

Unique reference number for the enquiry, for example the order number

Eindeutige Referenznummer zur Anfrage, zum Beispiel Bestellnummer

EventTokena2M

Abbreviation of the action to be done:

<OS> for canceling the order

<CR> for Credit

Abkürzung der auszuführenden Aktion:

<OS> zum Stornieren der Bestellung

<CR> für Gutschrift

Reasona2M

Cancelation:

"OUT_OF_STOCK",

"CUSTOMER_CANCELLATION",

"NO_PAYMENT",

"CUSTOMER_SERVICE"

Credit:

CARRIER_RETURN = carrier return

CUSTOMER_RETURN = customer return - use this one if not provided by merchant

Stornieren:

"OUT_OF_STOCK",

"CUSTOMER_CANCELLATION",

"NO_PAYMENT",

"CUSTOMER_SERVICE"

Gutschrift:

CARRIER_RETURN = Rücksendung durch den Spediteur

CUSTOMER_RETURN = Kundenretoure – verwenden Sie diese, wenn nicht vom Händler bereitgestellt
DateDateMYYYY-MM-DDYYYY-MM-DD
referenceans..32MMandatory for credit, Reference for returnObligatorisch für Gutschrift, Referenz für Rücksendung
ReturnDateDateMMandatory for credit, Date of returnObligatorisch für Gutschrift, Rückgabedatum
ArticleListStringMBase64 encoded valueBase64-codierter Wertitems
itemsarrayMArray of items, e.g.: {"items": [{items1 ...}{item2...}]}Array von Elementen, z. B.: {"items": [{items1 ...}{item2...}]}
items.itemReferenceans..30MPosition of the line item in the orderPosition der Werbebuchung in der Bestellung
items.idans..30MArticle NumberArtikelnummer
items.descriptionans..30MName / Title of the ArticleName / Titel des Artikels
items.quantityans..30MTotal number of itemsGesamtzahl der Artikel
items.amountn..10MGross unit price (incl. VAT) in CentBrutto-Stückpreis (inkl. MwSt.) in Cent
items.vatAmountn..10MTax Amount in centsSteuerbetrag in Cent
items.vatPercentn..10MTax rate of country tax in % as number 19% = 19Steuersatz der Landessteuer in % als nummer 19% = 19
items.vatTypeStringM

TAXLESS = taxless

NORMAL = normal

REDUCED = reduced

TAXLESS = taxless

NORMAL = normal

REDUCED = reduced

items.positionTypeStringM

    SALES_ARTICLE = Sales Article 

    IBAN_VERIFICATION = IBAN verification

    LOYALTY_CARD = Loyalty Card

    SHIPPING_COSTS_EXPRESS = Shipping costs (express)

    FREE_ARTICLE = Free article

    GIFT_CARD_VOUCHER_PAYMENT = Gift Card Voucher Payment

    GIFT_CARD_VOUCHER_SALE = Gift Card Voucher Sale

    SERVICE_CHARGE = Service Charge

    CASH_ON_DELIVERY = Cash on delivery

    MARKETPLACE_PROVISION = Marketplace-Provision

    SUBSCRIPTION_ORDER = Subscription Order

    DISCOUNT = Discount

    SHIPPING_COSTS = Shipping costs

    DISCOUNT_FOR_SUBSCRIPTION_ORDER = Discount for Subscription Order

    SALES_ARTICLE = Sales Article 

    IBAN_VERIFICATION = IBAN verification

    LOYALTY_CARD = Loyalty Card

    SHIPPING_COSTS_EXPRESS = Shipping costs (express)

    FREE_ARTICLE = Free article

    GIFT_CARD_VOUCHER_PAYMENT = Gift Card Voucher Payment

    GIFT_CARD_VOUCHER_SALE = Gift Card Voucher Sale

    SERVICE_CHARGE = Service Charge

    CASH_ON_DELIVERY = Cash on delivery

    MARKETPLACE_PROVISION = Marketplace-Provision

    SUBSCRIPTION_ORDER = Subscription Order

    DISCOUNT = Discount

    SHIPPING_COSTS = Shipping costs

    DISCOUNT_FOR_SUBSCRIPTION_ORDER = Discount for Subscription Order

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

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

Parameters for credit of invoices


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

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

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

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

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

KeyFormatCNDDescriptionBeschreibung
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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

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

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

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

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

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Reference number is returned, if it was previously submitted

Wenn zuvor übergeben, wird die Referenznummer zurückgegeben

CodeExtn..10OError code from RivertyFehlercode von Riverty
ErrorTextans..256OError text from RivertyFehlertext von Riverty
ReferenzIDn..50OUnique ID within information/response from RivertyEindeutige ID der Auskunft/Antwort von Riverty

Response parameters for credit of invoices