Über Ratepay

Allgemeines zu Ratepay

Mit Rechnungskauf reduzieren Sie als Händler die Bestellabbrüche in Ihrem Online-Shop um bis zu 81 Prozent. Dadurch erhöhen sich Ihre Konversionsrate und Ihr Umsatz. Deshalb ermöglicht das Computop Paygate in mehreren europäischen Ländern den Rechnungskauf mit Zahlungsgarantie. Der Ratenkauf im Online-Shop motiviert Ihre Kunden, hochwertige Warenkörbe zu bestellen. So erhöht sich auch Ihr Umsatz. Das Computop Paygate bietet deshalb Ratenkauf mit Zahlungsgarantie in mehreren europäischen Ländern an.

Bei Ratepay profitieren Sie als Händler von einem Fullservice für den Rechnungs- und Ratenkauf. Dafür übergeben Sie während der Bestellung nur alle Rechnungsdaten an den Dienstleister. Der übernimmt dann den gesamten Aufwand für Rechnungsstellung und Debitorenmanagement. Als Händler bekommen Sie eine Zahlungsgarantie. Außerdem bietet Ratepay klassische Ratenzahlung und SEPA-Lastschriftverfahren an.

Ratepay gewährt im Bestellprozess sekundenschnell eine Online-Zusage für den Ratenkauf. Ein PostIdent-Verfahren ist nicht nötig. Ratepay zahlt den Rechnungsbetrag kurzfristig an den Händler aus und trägt das Ausfallrisiko selbst.


Logo

Info

Ratepay bietet Payment-Lösungen für Rechnungskauf, Ratenzahlung und Lastschriftverfahren, übernimmt dabei die gesamte Ab-wicklung sowie das komplette Risiko von Zahlungsausfällen.

TypZahlungen per Rechnungs- und Ratenkauf

Weitere Informationen finden Sie auch auf der Webseite von Ratepay (http://www.ratepay.com).


Diagramm zum Prozessablauf

Ratepay Prozessablauf


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.


Ratepay Rechnungs- und Ratenkauf

Ein Zahlungsvorgang mit Ratepay besteht aus mehreren Transaktionsschritten. Zu Anfang ist eine Initialisierung erforderlich, die als Ergebnis die zulässigen Zahlarten für den Kunden zurückliefert: Rechnungskauf, Ratenzahlung oder Lastschrift. Sofern der Kunde Ratenkauf wünscht, muss der Ratenrechner angezeigt werden. Anschließend wird die Zahlung angelegt, bestätigt, bei Bedarf geändert und schließlich gebucht. Gutschriften sind ebenfalls möglich.

Bei der Computop Ratepay-Anbindung gibt es 5 verschiedene Requests, welche je nach Situation und Fortschritt im Bezahlprozess durchgeführt werden müssen. Computop setzt diese Requests in die entsprechenden Ratepay-Requests um. Hierfür gilt folgendes Mapping:


Computop request

Ratepay request

Beschreibung

INIT / Authorize

PAYMENT_INIT

(PAYMENT_QUERY)

Computop führt automatisiert den Request PAYMENT_INIT durch. Wenn ein Händler die integrierte Bezahlsteuerung (IBS) nutzt, wird der Request PAYMENT_QUERY ausgeführt.

EventToken = A

Create payment

(Authorize step 1)

PAYMENT_REQUEST

Initialisiert einen Raten- bzw. Rechnungskauf

EventToken = R

Verify

(Authorize step 2)

PAYMENT_CONFIRM

Bestätigt die Initialisierung erneut.

Computop kann diesen Request auch automatisieren. Dann lassen sie diesen Request bitte aus (Wenden sie sich hierfür an unseren Support).

EventToken = V

Order change

(before capture)

PAYMENT_CHANGE

Optional: Hiermit kann die Zahlung bearbeitet werden. Möglich sind:

-          Vollstornierung / EventToken = FC

-          Teilstornierung / EventToken = PC

-          Auftragsänderung / EventToken = CO

CaptureCONFIRMATION_DELIVERY

Aktiviert bzw. führt die Zahlung durch.

Aus Haftungs- und Fälligkeitsgründen muss dieser Request beim Versand der Ware erfolgen!

EventToken = C

Order change

(after capture)

PAYMENT_CHANGE

Optional: Hiermit kann die Zahlung bearbeitet werden. Möglich sind:

-          Vollrückgabe / EventToken = FR

-          Teilrückgabe / EventToken = PR

-          Gutschrift / EventToken = CR


Ratepay-Zahlungen initialisieren

Um eine Zahlung mit Ratepay über eine Server-zu-Server-Verbindung zu initialisieren, 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:

KeyFormatCNDBeschreibung

MerchantID

ans..30

M

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

KeyFormatCNDBeschreibung
TransID

ans..64

MIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDBeschreibung
refnr

ans..30

O

Eindeutige Referenznummer des Händlers

KeyFormatCNDBeschreibung
Amount

n..10

M

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.

KeyFormatCNDBeschreibung
Currency

a3

M

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

KeyFormatCNDBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

Format

CND

Beschreibung

OrderDescans..768OBeschreibung der gekauften Waren
E-mailans..255ME-Mail-Adresse des Karteninhabers
CustomerIDan..30OEindeutige ID des Kunden im Händlersystem oder die E-Mail-Adresse des Kunden
CustomerClassificationans..8OAnweisung an das Risikomanagement, um welchen Kundentyp es sich handelt: negative, neutral, positive, vip
Titleans..45OTitel
Salutationans..45OAnrede
Gendera1MGeschlecht: M=male, F=female, U=unknown
DateOfBirthdttm8C

Geburtsdatum im Format JJJJMMTT.

Optional bei B2B (CompanyName angegeben), sonst Pflicht.

PhoneAreaCodeans..30CTelefonvorwahl. Pflicht, wenn kein MobileAreaCode übergeben ist.
Phoneans..30CRufnummer. Pflicht, wenn kein Mobile übergeben ist.
FaxAreaCodeans..30OFax-Vorwahl
Faxans..30OFaxnummer
MobileAreaCodeans..30CMobil-Vorwahl. Pflicht, wenn kein PhoneAreaCode übergeben ist.
Mobileans..30CMobiltelefonnummer. Pflicht, wenn kein Phone übergeben ist.
AccOwner

ans..55

CName des Kontoinhabers. Pflicht bei DirectDebit.
IBAN

ans..34

CInternational Bank Account Number. Pflicht bei DirectDebit.
BIC

ans11

CBank Identifier Code. Pflicht für IBANs außerhalb Deutschlands.
AccBank

ans..27

OName des Kreditinstituts
Nationality

a2

MLändercode des Herkunftslandes des Kunden gemäß ISO-3166 alpha 2
AllowCredInq

a..3

MKunde stimmt der Weitergabe seiner Daten für Kreditangebote zu (yes/no)
ShopSystem

ans..127

OName des Shop-Systems
ShopSystemVersion

ans..127

OVersionsname des Shop-Systems
ShoppingBasket

ans..1024

MAktueller Warenkorb (Aufbau siehe Tabelle Shopping-Basket)
ShoppingBasketAmount

n..10

MGesamtwert des Warenkorbs in kleinster Währungseinheit (abzüglich Rabatte, inkl. Versand u.a.)
Discountans..100O

Warenkorbübergreifender Rabatt.

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Rabatt;1000;1900

ShippingProfileans..100O

Versandkosten

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Versand;500;1900

Accountans..10OAccount-Kennung, um gesonderte (SubShops) Logins zu nutzen
EventTokena..2M„A“ für Autorisierung



Firmendaten (B2B)
CompanyName

ans..100

CFirmenname, Pflicht bei B2B
VatID

ans..25

CUmsatzsteuer-ID, Pflicht bei B2B
CompanyID

ans..50

OHandelsregisternummer
LegalForm

ans..100

ORechtsform. Zu übergebender Wert muss mit Ratepay abgestimmt werden!
RegistryLocation

ans..255

OFirmensitz
Homepage

ans..255

OHomepage des Unternehmens



Lieferdaten
sdFirstName

ans..100

O

Vorname des Kunden
sdLastName

ans..100

O

Nachname des Kunden
sdStreet

ans..100

O

Straßenname und Hausnummer
sdStreetHouseNumber

ans..10

O

Hausnummer
sdStreetAddition

ans..50

O

Zusatz in der Lieferadresse
sdZIPCode

ans..10

O

Postleitzahl
sdCity

ans..255

O

Ort
sdCountryCode

a2

O

Ländercode zweistellig gemäß ISO 3166
sdPhone

ns..32

O

Telefonnummer des Kunden



Rechnungsdaten (Prüfadresse)
bdFirstName

ans..100

M

Vorname des Kunden
bdLastName

ans..100

M

Nachname des Kunden
bdCompanyName

ans..100

O

Firmenname
bdStreet

ans..50

M

Straßenname der Rechnungsadresse
bdStreetNr

ans..10

M

Hausnummer der Rechnungsadresse
bdStreetAddition

ans..50

O

Adresszusatz der Rechnungsadresse
bdZIP

ans..10

M

Postleitzahl der Rechnungsadresse
bdCity

ans..255

M

Ort der Rechnungsadresse
bdCountryCode

a2

M

Ländercode der Rechnungsadresse zweistellig gemäß ISO 3166
bdPhone

ns..32

M

Telefonnummer des Kunden



Registrierungsadresse (B2B)
FirstName

ans..100

O

Vorname
LastName

ans..100

O

Nachname
AddrStreet

ans..50

C

Straße. Pflicht wenn B2B (CompanyName angegeben).
AddrStreetNr

ans..10

C

Hausnummer. Pflicht wenn B2B (CompanyName angegeben).
AddressAddition

ans..50

O

Adresszusatz
AddrZip

ans..10

C

Postleitzahl. Pflicht wenn B2B (CompanyName angegeben).
AddrCity

ans..32

C

Ort. Pflicht wenn B2B (CompanyName angegeben).
AddrCountryCode

a2

C

Ländercode zweistellig gemäß ISO 3166. Pflicht wenn B2B (CompanyName angegeben).



Betrugsprävention
IPAddrans..39M

Durch die übergebene IP-Adresse kann das Paygate ermitteln, in welchem Land und in welcher Stadt Ihr Kunde mit dem Internet verbunden ist (vgl. IPZone). Format: 123.456.789.012

DeviceTokenans..100OGeräte-Token, siehe externe Dokumentation von Ratepay

Parameter für Ratepay-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

KeyFormatCNDBeschreibung

mid

ans..30

M

HändlerID, die von Computop vergeben wird

KeyFormatCNDBeschreibung
PayID

an32

M

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

KeyFormatCNDBeschreibung
XID

an32

M

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

KeyFormatCNDBeschreibung
TransID

ans..64

MIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Key

Format

CND

Beschreibung

Status

a..50

M

INIT oder FAILED

KeyFormatCNDBeschreibung
Description

ans..1024

M
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDBeschreibung
Code

an8

M

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

KeyFormatCNDBeschreibung
refnr

ans..30

O

Eindeutige Referenznummer des Händlers

Key

Format

CND

Beschreibung

InfoText

ans..1024

O

Enthält einen Info-Text, der dem Kunden weitergegeben werden kann (z.B. bei Ablehnung)
ExternalMessageans..256O

Fehlertext von Ratepay, wenn mit Computop Helpdesk abgesprochen

ExternalCodeans..64O

Fehlercode von Ratepay, wenn mit Computop Helpdesk abgesprochen

Installmenta..5OBei IBS: True / False, ob installment erlaubt ist
Prepaymenta..5OBei IBS: True / False, ob prepayment erlaubt ist
Invoicea..5OBei IBS: True / False, ob invoice erlaubt ist
ELVa..5OBei IBS: True / False, ob ELV erlaubt ist
RPTransIDans..50OEindeutige Referenznummer von Ratepay

Antwort-Parameter für Ratepay-Zahlungen


Ratepay-Ratenrechner

Für einen beabsichtigen Ratenkauf des Endkunden muss der Ratepay-Ratenrechner (vom Händler implementierte Oberfläche) angezeigt werden. Hier kann anhand des Betrages + z.B. der Dauer die Höhe der Raten (oder auch anhand der Raten die Laufzeit) ermittelt werden.

Um den Ratenrechner für Ratepay anzuzeigen, rufen Sie folgende URL auf:

 

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:

KeyFormatCNDBeschreibung

MerchantID

ans..30

M

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

KeyFormatCNDBeschreibung
PayID

an32

M

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

KeyFormatCNDBeschreibung
TransID

ans..64

MIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDBeschreibung
Amount

n..10

M

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.

KeyFormatCNDBeschreibung
Currency

a3

M

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

KeyFormatCNDBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

Format

CND

Beschreibung

Month

ans.255

C

Laufzeit in Monaten. Pflicht bei EventToken RT.
Raten..8CMonatliche Rate in kleinster Währungseinheit. Pflicht bei EventToken RR.
FirstDayn..2O

Kalendertag der ersten Zahlung.

Mögliche Werte sind: 1, 15, 28. Standardwert = 28.

StartDatedttm8OStartdatum der Ratenzahlung im Format JJJJMMTT
DueDatedttm8OFälligkeitsdatum im Format JJJJMMTT
InterestRaten..5OSollzinssatz, zum Beispiel 1370 für 13,70%
EventTokena..2MRT (CalculationbyTime) oder RR (CalculationbyRate)
Accountans..10OAccount-Kennung, um gesonderte (SubShops) Logins zu nutzen

Parameter für Ratepay-Ratenrechner


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

KeyFormatCNDBeschreibung

mid

ans..30

M

HändlerID, die von Computop vergeben wird

KeyFormatCNDBeschreibung
PayID

an32

M

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

KeyFormatCNDBeschreibung
XID

an32

M

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

KeyFormatCNDBeschreibung
TransID

ans..64

MIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Key

Format

CND

Beschreibung

Status

a..50

M

INIT oder FAILED

KeyFormatCNDBeschreibung
Description

ans..1024

M
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDBeschreibung
Code

an8

M

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

KeyFormatCNDBeschreibung
refnr

ans..30

O

Eindeutige Referenznummer des Händlers

Key

Format

CND

Beschreibung

InfoText

ans..1024

O

Enthält einen Info-Text, der dem Kunden weitergegeben werden kann (z.B. bei Ablehnung)
ExternalMessageans..256O

Fehlertext von Ratepay, wenn mit Computop Helpdesk abgesprochen

ExternalCodeans..64O

Fehlercode von Ratepay, wenn mit Computop Helpdesk abgesprochen

TotalAmountn..10MZu finanzierender Gesamtbetrag in der kleinsten Währungseinheit
InterestAmountn..10MSumme aller monatlich gezahlten Raten in der kleinsten Währungseinheit
ServiceChargen..10MZusätzliche Finanzierungskosten in der kleinsten Währungseinheit
InterestRaten..5MSollzinssatz, zum Beispiel 1370 für 13,70%
AnnualPercentageRaten..5MJahreszins basierend auf ServiceCharge und InterestRate
MonthlyDebitInterestn..5MMonatlicher Zins basierend auf AnnualPercentageRate
InstallmentNumbern..2MAnzahl Monate der Ratenzahlung
InstallmentAmountn..10MMonatlich zu bezahlender Betrag in der kleinsten Währungseinheit
InstallmentLastAmountn..10MBetrag der letzten Rate in der kleinsten Währungseinheit
FirstDayn..2O

Kalendertag der ersten Zahlung.

Mögliche Werte sind 1, 15, 28. Standardwert = 28.

Antwort-Parameter für Ratepay-Ratenrechner


Die Konfiguration des Ratenrechners ist zwar von Ratepay fest vorgegeben, dennoch kann es zur Vermeidung von Folgefehlern hilfreich sein, diese Konfiguration vor der weiteren Verarbeitung abzufragen. Dazu rufen Sie folgende URL auf:

 

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:

KeyFormatCNDBeschreibung

MerchantID

ans..30

M

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

KeyFormatCNDBeschreibung
PayID

an32

M

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

KeyFormatCNDBeschreibung
TransID

ans..64

MIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

Format

CND

Beschreibung

EventTokena..2MRC für Rateconfiguration
Accountans..10OAccount-Kennung, um gesonderte (SubShops) Logins zu nutzen

Parameter zur Abfrage der Konfiguration des Ratepay-Ratenrechners


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

KeyFormatCNDBeschreibung

mid

ans..30

M

HändlerID, die von Computop vergeben wird

KeyFormatCNDBeschreibung
PayID

an32

M

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

KeyFormatCNDBeschreibung
XID

an32

M

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

KeyFormatCNDBeschreibung
TransID

ans..64

MIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDBeschreibung
Status

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDBeschreibung
Description

ans..1024

M
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDBeschreibung
Code

an8

M

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

Key

Format

CND

Beschreibung

MinRaten..2OMindestanzahl der Raten
DefaultRaten..12OStandardrate in der kleinsten Währungseinheit
MaxInterestRaten..5OMaximaler Zinssatz
MinMonthn..2OMindestlaufzeit in Monaten
MaxMonthn..2OMaximallaufzeit in Monaten
MonthLongrunn..2OMindestlaufzeit für eine Langzeitfinanzierung
MonthAllowedans..50OKommaseparierte Liste mit erlaubten Laufzeiten in Monaten
FirstDayans..20OKommaseparierte Liste mit möglichen Starttagen (1, 15, 28)
LastRaten..10OMindestbetrag für die Abschlussrate in der kleinsten Währungseinheit
MinRateNormaln..10OMindestrate in der kleinsten Währungseinheit
MinRateLongrunn..10OMindestrate einer Langzeitfinanzierung in der kleinsten Währungseinheit
ServiceChargen..10OZusätzliche Finanzierungskosten in der kleinsten Währungseinheit

InfoText

ans..1024

O

Enthält einen Info-Text, der dem Kunden weitergegeben werden kann (z.B. bei Ablehnung)
ExternalMessageans..256O

Fehlertext von Ratepay, wenn mit Computop Helpdesk abgesprochen

ExternalCodeans..64O

Fehlercode von Ratepay, wenn mit Computop Helpdesk abgesprochen

Antwort-Parameter der Konfigurationsabfrage des Ratepay-Ratenrechners


Zahlungsvorgang anlegen

Um einen Zahlungsvorgang mit Ratepay anzulegen, 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:

KeyFormatCNDBeschreibung

MerchantID

ans..30

M

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

KeyFormatCNDBeschreibung
PayID

an32

M

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

KeyFormatCNDBeschreibung
TransID

ans..64

MIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDBeschreibung
Amount

n..10

M

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.

KeyFormatCNDBeschreibung
Currency

a3

M

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

KeyFormatCNDBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

Format

CND

Beschreibung

RPMethodans..10MZahlungsweise: INVOICE, INSTALLMENT oder ELV
ShoppingBasketAmountn..10MGesamtwert des Warenkorbs in kleinster Währungseinheit (abzüglich Rabatte, inkl. Versand u.a.)
Accountans..10OAccount-Kennung, um gesonderte (SubShops) Logins zu nutzen
DeviceTokenans..100OGeräte-Token, siehe externe Dokumentation von Ratepay
ShopSystemans..127OName des Shop-Systems
ShopSystemVersionans..127OVersionsname des Shop-Systems
EventTokena..2MR für RateInit



SEPA (ELV)
AccOwner

ans..55

C

Name des Kontoinhabers. Pflicht bei DirectDebit.
IBAN

ans..34

C

International Bank Account Number. Pflicht bei DirectDebit.
BIC

ans11

C

Bank Identifier Code. Pflicht bei DirectDebit. Pflicht für IBANs außerhalb Deutschlands.
AccBank

ans..27

O

Name des Kreditinstituts
DebitPayType

a2

C

Zahlungsweise. Pflicht bei DirectDebit.

BT = BankTransfer ; DD = DirectDebit




Ratenzahlung (INSTALLMENT)
InterestRate

n..5

C

Sollzinssatz (Wert ist dem Ratenrechner zu entnehmen). Pflicht bei Ratenzahlung.
InstallmentNumber

n..12

C

Anzahl Monate der Ratenzahlung (Wert ist dem Ratenrechner zu entnehmen). Pflicht bei Ratenzahlung.
InstallmentAmount

n..10

C

Monatlich zu bezahlender Betrag (Wert ist dem Ratenrechner zu entnehmen). Pflicht bei Ratenzahlung.
InstallmentLastAmount

n..10

C

Betrag der letzten Rate (Wert ist dem Ratenrechner zu entnehmen). Pflicht bei Ratenzahlung.
FirstDay

n..2

O

Kalendertag der ersten Zahlung.

Mögliche Werte sind 1, 15, 28. Standardwert = 28.

TotalAmount

n..10

C

Zu finanzierender Gesamtbetrag. Pflicht bei Ratenzahlung.

Parameter zum Anlegen einer Ratepay-Zahlung


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

KeyFormatCNDBeschreibung

mid

ans..30

M

HändlerID, die von Computop vergeben wird

KeyFormatCNDBeschreibung
PayID

an32

M

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

KeyFormatCNDBeschreibung
XID

an32

M

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

KeyFormatCNDBeschreibung
TransID

ans..64

MIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDBeschreibung
Status

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDBeschreibung
Description

ans..1024

M
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDBeschreibung
Code

an8

M

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

Key

Format

CND

Beschreibung

InfoText

ans..1024

O

Enthält einen Info-Text, der dem Kunden weitergegeben werden kann (z.B. bei Ablehnung)
ExternalMessageans..256O

Fehlertext von Ratepay, wenn mit Computop Helpdesk abgesprochen

ExternalCodeans..64O

Fehlercode von Ratepay, wenn mit Computop Helpdesk abgesprochen

rptransidans..50M

Eindeutige Referenznummer von Ratepay

descriptorans..255M

Deskriptor (Beschreibung) zur Identifizierung der Transaktion in Dokumenten und Banküberweisungen.

Antwort-Parameter beim Anlegen einer Ratepay-Zahlung


Zahlungsvorgang bestätigen (Confirm)

Um einen Zahlungsvorgang mit Ratepay zu bestätigen, 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:

KeyFormatCNDBeschreibung

MerchantID

ans..30

M

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

KeyFormatCNDBeschreibung
PayID

an32

M

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

KeyFormatCNDBeschreibung
TransID

ans..64

MIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

Format

CND

Beschreibung

Accountans..10OAccount-Kennung, um gesonderte (SubShops) Logins zu nutzen
EventTokena..2MV für verify

Parameter zum Bestätigen einer Ratepay-Zahlung


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

KeyFormatCNDBeschreibung

mid

ans..30

M

HändlerID, die von Computop vergeben wird

KeyFormatCNDBeschreibung
PayID

an32

M

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

KeyFormatCNDBeschreibung
XID

an32

M

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

KeyFormatCNDBeschreibung
TransID

ans..64

MIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDBeschreibung
Status

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDBeschreibung
Description

ans..1024

M
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDBeschreibung
Code

an8

M

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

Key

Format

CND

Beschreibung

InfoText

ans..1024

O

Enthält einen Info-Text, der dem Kunden weitergegeben werden kann (z.B. bei Ablehnung)
ExternalMessageans..256O

Fehlertext von Ratepay, wenn mit Computop Helpdesk abgesprochen

ExternalCodeans..64O

Fehlercode von Ratepay, wenn mit Computop Helpdesk abgesprochen

Antwort-Parameter beim Bestätigen einer Ratepay-Zahlung


Ratepay-Zahlungsvorgang buchen (Komplett- / Teilbuchung)

Um einen Zahlungsvorgang mit Ratepay zu buchen, 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:

KeyFormatCNDBeschreibung

MerchantID

ans..30

M

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

KeyFormatCNDBeschreibung
PayID

an32

M

Vom Paygate vergebene ID für die zu buchende Zahlung

KeyFormatCNDBeschreibung
TransID

ans..64

MIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDBeschreibung
Amount

n..10

M

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.

KeyFormatCNDBeschreibung
Currency

a3

M

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

KeyFormatCNDBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyFormatCNDBeschreibung
ReqId

ans..32

O

Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück.

Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

Key

Format

CND

Beschreibung

ShoppingBasketans..1024MWarenkorb mit den zu buchenden Artikeln (Aufbau siehe Tabelle ShoppingBasket)
ShoppingBasketAmountn..10MGesamtwert des aktuellen Warenkorbs in kleinster Währungseinheit (abzüglich Rabatte, inkl. Versand u.a.)
Discountans..100O

Warenkorbübergreifender Rabatt.

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Rabatt;1000;1900

ShippingProfileans..100O

Versandkosten

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Versand;500;1900

Accountans..10OAccount-Kennung, um gesonderte (SubShops) Logins zu nutzen
InvoiceIDans..50ORechnungsnummer
TrackingIDans..100O

Liste der Versanddienstleister mit zugehöriger Paketnummer.


Format: DIENSTLEISTER;PAKETNUMMER

Beispiel: DHL;Paket1


Weitere Dienstleister/Versandnummern werden jeweils mit einem „+“ abgegrenzt.

Beispiel: DHL;Paket1+DHL;Paket2+GLS;Paket9


Achtung: Die Kürzel für die Provider sind mit Ratepay abzustimmen!

ShopSystemans..127OName des Shop-Systems
ShopSystemVersionans..127OVersionsname des Shop-Systems
EventTokena..2MC für Capture (Buchung)

Parameter zum Buchen einer Ratepay-Zahlung


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

KeyFormatCNDBeschreibung

mid

ans..30

M

HändlerID, die von Computop vergeben wird

KeyFormatCNDBeschreibung
PayID

an32

M

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

KeyFormatCNDBeschreibung
XID

an32

M

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

KeyFormatCNDBeschreibung
TransID

ans..64

MIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDBeschreibung
Status

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDBeschreibung
Description

ans..1024

M
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDBeschreibung
Code

an8

M

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

Key

Format

CND

Beschreibung

InfoText

ans..1024

O

Enthält einen Info-Text, der dem Kunden weitergegeben werden kann (z.B. bei Ablehnung)
ExternalMessageans..256O

Fehlertext von Ratepay, wenn mit Computop Helpdesk abgesprochen

ExternalCodeans..64O

Fehlercode von Ratepay, wenn mit Computop Helpdesk abgesprochen

Antwort-Parameter beim Buchen einer Ratepay-Zahlung


Storno / Rückgabe von Ratepay-Zahlungen

Um einen Zahlungsvorgang mit Ratepay teilweise oder vollständig zu stornieren oder Änderungen daran durchzuführen, verwenden Sie bitte folgende URL:

 

Hinweis: Für die verschiedenen Aktionen  (Eventtoken) gibt es Einschränkungen, wann welche Aktion durchgeführt werden darf. Nur vor der Buchung erlaubt sind: FC (Voll-Stornierung), PC (Teil-Stornierung), CO (Änderung). Nur nach der Buchung erlaubt sind FR (Voll-Rückgabe) und PR (Teil-Rückgabe).

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:

KeyFormatCNDBeschreibung

MerchantID

ans..30

M

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

KeyFormatCNDBeschreibung
PayID

an32

M

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

KeyFormatCNDBeschreibung
TransID

ans..64

MIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDBeschreibung
Amount

n..10

M

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.

KeyFormatCNDBeschreibung
Currency

a3

M

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

KeyFormatCNDBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyFormatCNDBeschreibung
ReqId

ans..32

O

Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück.

Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

Key

Format

CND

Beschreibung

RPMethodans..10MZahlungsweise: INVOICE, INSTALLMENT oder ELV
ShoppingBasketans..1024C

Warenkorb mit den zu stornierenden Artikeln (Aufbau siehe Tabelle ShoppingBasket)

  • für EventToken FC / FR ist entweder ShoppingBasket oder ShoppingBasketAmount erforderlich
ShoppingBasketAmountn..10C

Gesamtwert des aktuellen Warenkorbs in kleinster Währungseinheit (abzüglich Rabatte, inkl. Versand u.a.)

  • für EventToken FC / FR ist entweder ShoppingBasket oder ShoppingBasketAmount erforderlich
Discountans..100O

Warenkorbübergreifender Rabatt.

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Rabatt;1000;1900

ShippingProfileans..100O

Versandkosten

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Versand;500;1900

Accountans..10OAccount-Kennung, um gesonderte (SubShops) Logins zu nutzen
ShopSystemans..127OName des Shop-Systems
ShopSystemVersionans..127OVersionsname des Shop-Systems
EventTokena..2M

FC für full-cancellation

PC für partial-cancellation

CO für change-order

FR für full-return

PR für partial-return

Parameter für Storno / Änderung einer Ratepay-Zahlung


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

KeyFormatCNDBeschreibung

mid

ans..30

M

HändlerID, die von Computop vergeben wird

KeyFormatCNDBeschreibung
PayID

an32

M

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

KeyFormatCNDBeschreibung
XID

an32

M

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

KeyFormatCNDBeschreibung
TransID

ans..64

MIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDBeschreibung
Status

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDBeschreibung
Description

ans..1024

M
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDBeschreibung
Code

an8

M

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

Key

Format

CND

Beschreibung

InfoText

ans..1024

O

Enthält einen Info-Text, der dem Kunden weitergegeben werden kann (z.B. bei Ablehnung)
ExternalMessageans..256O

Fehlertext von Ratepay, wenn mit Computop Helpdesk abgesprochen

ExternalCodeans..64O

Fehlercode von Ratepay, wenn mit Computop Helpdesk abgesprochen

Antwort-Parameter bei Storno / Änderung einer Ratepay-Zahlung


Gutschrift von Ratepay-Zahlungen

Um eine Gutschrift mit Ratepay 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:

KeyFormatCNDBeschreibung

MerchantID

ans..30

M

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

KeyFormatCNDBeschreibung
PayID

an32

M

Vom Paygate vergebene ID für die gutzuschreibende Zahlung

KeyFormatCNDBeschreibung
TransID

ans..64

MIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDBeschreibung
Amount

n..10

M

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.

KeyFormatCNDBeschreibung
Currency

a3

M

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

KeyFormatCNDBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyFormatCNDBeschreibung
ReqId

ans..32

O

Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück.

Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

Key

Format

CND

Beschreibung

ShoppingBasketans..1024MWarenkorb mit einem „CREDIT“-Artikel (Aufbau siehe Tabelle ShoppingBasket)
ShoppingBasketAmountn..10MGesamtwert des aktuellen Warenkorbs in kleinster Währungseinheit (abzüglich Rabatte, inkl. Versand u.a.)
Discountans..100O

Warenkorbübergreifender Rabatt.

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Rabatt;1000;1900

ShippingProfileans..100O

Versandkosten

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Versand;500;1900

Accountans..10OAccount-Kennung, um gesonderte (SubShops) Logins zu nutzen
ShopSystemans..127OName des Shop-Systems
ShopSystemVersionans..127OVersionsname des Shop-Systems
EventTokena..2MCR für Credit (Gutschrift)

Parameter für Gutschrift einer Ratepay-Zahlung


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

KeyFormatCNDBeschreibung

mid

ans..30

M

HändlerID, die von Computop vergeben wird

KeyFormatCNDBeschreibung
PayID

an32

M

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

KeyFormatCNDBeschreibung
XID

an32

M

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

KeyFormatCNDBeschreibung
TransID

ans..64

MIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDBeschreibung
Status

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDBeschreibung
Description

ans..1024

M
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDBeschreibung
Code

an8

M

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

Key

Format

CND

Beschreibung

InfoText

ans..1024

O

Enthält einen Info-Text, der dem Kunden weitergegeben werden kann (z.B. bei Ablehnung)
ExternalMessageans..256O

Fehlertext von Ratepay, wenn mit Computop Helpdesk abgesprochen

ExternalCodeans..64O

Fehlercode von Ratepay, wenn mit Computop Helpdesk abgesprochen

Antwort-Parameter bei Gutschrift einer Ratepay-Zahlung


Erläuterung zum Parameter ShoppingBasket

Der Parameter ShoppingBasket erklärt die betreffenden Artikel der Transaktion und setzt sich aus mehreren Werten zusammen. Die einzelnen Parameter innerhalb eines Warenkorbs werden mit „;“ getrennt. Es sind nur die Werte einzutragen, nicht der zugehörige Parametername. Ungenutzte optionale Parameter sind als leeres Feld zu übergeben. Jeder weitere Artikel wird durch ein „+“ vom vorherigen abgegrenzt. Beispiel siehe unterhalb der Tabelle.

Folgende Tabelle beschreibt die einzelnen Werte innerhalb des ShoppingBasket:

Key

Format

CND

Beschreibung

ArtNr

ans..255

C

Eindeutige Artikelnummer. Jeder Artikel im Warenkorb muss eindeutig identifizierbar sein. Entweder über ArtNr oder eine Kombination aus ArtNr und UniqueArticleNumber.
Quantity

n..12

M

Anzahl
Category

n..2

O

Artikelkategorie (nach Absprache mit Ratepay)
Item

ans..255

M

Artikelbeschreibung
UnitPriceGross

n..12

M

Stückpreis brutto in kleinster Währungseinheit
TaxRate

n..5

M

Steuersatz mit 2 Nachkommastellen, z.B. 1900 für 19%
UniqueArticleNumber

ans..50

C

Eindeutige Artikelnummer. Jeder Artikel im Warenkorb muss eindeutig identifizierbar sein. Entweder über ArtNr oder eine Kombination aus ArtNr und UniqueArticleNumber.
Discount

n..12

O

Artikelbezogener Nachlass in kleinster Währungseinheit
DescriptionAddition

ans..511

O

Zusatztext für weitere Beschreibung. Kann in der Kommunikation zwischen Ratepay und dem Endkunden genutzt werden.

Parameter innerhalb des Warenkorbes


Beispiel eines Warenkorbs mit 3 Artikeln:

ShoppingBasket=A;1;1;Bett;10000;1900;01233;1000;Blau+B;2;1;Handtuch;3000;1900;0234;;180x200+C;5;1;Kissen;1000;1900;;;


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 Buchung oder Änderung bei Ratepay übergeben müssen und welche Informationen Sie der Antwort-Datei über den Status des Zahlungsvorgangs entnehmen können.

Bei den Batch-Aufrufen ist die verwendete Batch-Version zu unterscheiden, wovon die optionalen Parameter abhängen. Alle mit „2.“ beginnen Versionsbezeichnungen betreffen Aufrufe für einen Konzern. Das bedeutet, innerhalb einer Batch-Datei mit einer bestimmten MerchantID können auch Transaktionen anderer Händler mit einer abweichenden Sub-MID übertragen werden.

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

Action

Version

Beschreibung

Capture

1.0 / 2.0

Standardversion ohne Rückgabe von Parameter Code


1.x / 2.x

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

1.1.2 / 2.1.2mit discount und shipping
Change

1.0 / 2.0

Standardversion ohne Rückgabe von Parameter Code

1.x / 2.x

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

1.1.2 / 2.1.2mit discount und shipping

Beschreibung der möglichen Batch-Versionen


Der Aufbau für eine Buchung oder Gutschrift in einer einzureichenden Batch-Datei sieht folgendermaßen aus:

HEAD,<MerchantID>,<Date>,<Version>
Ratepay,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<ShoppingBasket>,<ShoppingBasketAmount>,<EventToken>,<RPMethod>(,<Discount>,<Shipping>)
Ratepay,Change,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<ShoppingBasket>,<ShoppingBasketAmount>,<EventToken>,<RPMethod>(,<Discount>,<Shipping>)
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:

Key

Format

CND

Beschreibung

Type

a..11

M

HEAD für Header, FOOT für Footer, Ratepay für Transaktionen

Action

a..20

M

Der Action-Parameter definiert die Art der Transaktion:

Capture (Buchung)

Change (Gutschrift / Änderung)

KeyFormatCNDBeschreibung
Amount

n..10

M

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.

KeyFormatCNDBeschreibung
Currency

a3

M

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

KeyFormatCNDBeschreibung
TransID

ans..64

MIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDBeschreibung
refnr

ans..30

O

Eindeutige Referenznummer des Händlers

KeyFormatCNDBeschreibung
PayID

an32

M

Vom Paygate vergebene ID für diese Transaktion

Key

Format

CND

Beschreibung

ShoppingBasket

ans..1024

M

Warenkorb mit den zu stornierenden Artikeln (Aufbau siehe Tabelle ShoppingBasket)

  • für EventToken FC / FR ist entweder ShoppingBasket oder ShoppingBasketAmount erforderlich
ShoppingBasketAmount

n..12

M

Gesamtwert des aktuellen Warenkorbs in kleinster Währungseinheit (abzüglich Rabatte, inkl. Versand u.a.)

  • für EventToken FC / FR ist entweder ShoppingBasket oder ShoppingBasketAmount erforderlich
EventToken

a..2

M

R für RateInit (Initialisierung)

CR für Credit (Gutschrift)

FC für full-cancellation (Vollstornierung)

PC für partial-cancellation (Teilstornierung)

CO für change-order (Änderung)

FR für full-return (Vollrücksendung)

PR für partial-return (Teilrücksendung)

RPMethod

ans..10

C

Zahlungsweise: INVOICE, INSTALLMENT oder ELV. Wird bei Buchung (Capture) nicht benötigt!
Discount

ans..100

O

Warenkorbübergreifender Rabatt

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Rabatt;1000;1900

ShippingProfile

ans..100

O

Versandkosten

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Versand;500;1900

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>
Ratepay,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<ShoppingBasket>,<ShoppingBasketAmount>,<EventToken>,<RPMethod>(,<Discount>,<Shipping>),<Status>,<Code>
Ratepay,Change,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<ShoppingBasket>,<ShoppingBasketAmount>,<EventToken>,<RPMethod>(,<Discount>,<Shipping>),<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):

Key

Format

CND

Beschreibung

Action

a..20

M

Der Action-Parameter definiert die Art der Transaktion:

Capture (Buchung)

Change (Gutschrift / Änderung)

KeyFormatCNDBeschreibung
PayID

an32

M

Vom Paygate vergebene ID für diese Transaktion

KeyFormatCNDBeschreibung
Status

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDBeschreibung
Code

an8

M

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

Beschreibung der Ergebnis-Parameter im Datensatz von Batch-Dateien