Ü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

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.

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

Diagramm zum Prozessablauf

Image Removed

Ratepay Prozessablauf

Multiexcerpt include
SpaceWithExcerpt DE MultiExcerptName

Platform-Kurz PageWithExcerpt

Wording

-Schnittstelle

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

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

Zahlung anlegen

(Authorize Schritt 1)

PAYMENT_REQUEST

Initialisiert einen Raten- bzw. Rechnungskauf

EventToken = R

Verify

(Authorize Schritt 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

Auftragsänderung

(vor Capture)

PAYMENT_CHANGE

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

-          Vollstornierung / EventToken = FC

-          Teilstornierung / EventToken = PC

-          Auftragsänderung / EventToken = CO

Capture

CONFIRMATION_DELIVERY

Aktiviert bzw. führt die Zahlung durch.

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

EventToken = C

Auftragsänderung

(nach 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, rufen Sie folgende URL auf:

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

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

Die folgende Tabelle beschreibt die zu verschlüsselnden Übergabeparameter:

Parameter

Format

CND

Beschreibung

MerchantID

ans..30

M

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

TransID

ans..64

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

ns..30

M

eindeutige Referenznummer

Amount

n..10

M

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent).

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a3

M

Währung, drei Zeichen DIN / ISO 4217

MAC

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus

OrderDesc

ans..768

O

Beschreibung der gekauften Waren

E-mail

ans..255

M

E-Mail-Adresse des Karteninhabers

CustomerID

an..30

O

Eindeutige ID des Kunden im Händlersystem oder die E-Mail-Adresse des Kunden

CustomerClassification

ans..8

O

Anweisung an das Risikomanagement um welchen Kundentyp es sich handelt: negative, neutral, positive, vip

Title

ans..45

O

Titel

Salutation

ans..45

O

Anrede

Gender

a1

M

Geschlecht: M=male, F=female, U=unknown

DateOfBirth

dttm8

C

Geburtsdatum im Format YYYYMMDD
Optional bei B2B (CompanyName angegeben), sonst Pflicht.

PhoneAreaCode

ans..30

C

Telefonvorwahl. Pflicht, wenn kein MobileAreaCode übergeben ist.

Phone

ans..30

C

Rufnummer. Pflicht, wenn kein Mobile übergeben ist.

FaxAreaCode

ans..30

O

Fax-Vorwahl

Fax

ans..30

O

Faxnummer

MobileAreaCode

ans..30

C

Mobil-Vorwahl. Pflicht, wenn kein PhoneAreaCode übergeben ist.

Mobile

ans..30

C

Mobiltelefonnummer. Pflicht, wenn kein Phone übergeben ist.

AccOwner

ans..55

C

Name des Kontoinhabers. Pflicht bei DirectDebit.

IBAN

ans..34

C

International Bank Account Number. Pflicht bei DirectDebit.

BIC

ans11

O

Bank Identifier Code. Pflicht bei DirectDebit.

AccBank

ans..27

O

Name des Kreditinstituts

Nationality

a2

M

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

AllowCredInq

a..3

M

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

ShopSystem

ans..127

O

Name des Shop-Systems

ShopSystemVersion

ans..127

O

Versionsnummer des Shop-Systems

ShoppingBasket

ans..1024

M

Aktueller Warenkorb (Aufbau siehe Tabelle Shopping-Basket)

ShoppingBasketAmount

n..10

M

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

Discount

ans..100

O

Warenkorbübergreifender Rabatt.

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Rabatt;1000;1900

Shipping

ans..100

O

Versandkosten

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Versand;500;1900

Account

ans..10

O

Account-Kennung, um gesonderte (SubShops) Logins zu nutzen.

EventToken

a..2

M

„A“ für Autorisierung

Firmendaten (B2B)

CompanyName

ans..100

C

Firmenname, Pflicht bei B2B

VatID

ans..25

C

Umsatzsteuer-ID, Pflicht bei B2B

CompanyID

ans..50

O

Handelsregisternummer

LegalForm

ans..100

O

Rechtsform. Zu übergebender Wert muss mit Ratepay abgestimmt werden!

RegistryLocation

ans..255

O

Firmensitz

Homepage

ans..255

O

Homepage 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

sdZIP

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

bdCountry­Code

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

IPAddr

ans..15

M

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

DeviceToken

ans..100

O

Geräte-Token, siehe externe Dokumentation von Ratepay

Parameter für Ratepay-Zahlungen

Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate an Ihr System zurückgibt:

Parameter

Format

CND

Beschreibung

MID

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

an32

M

Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien

XID

an32

M

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

TransID

ans..64

M

Transaktionsnummer des Händlers

Status

a..50

M

INIT oder FAILED

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!

Code

n8

M

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

RefNr

ans..30

O

eindeutige Referenznummer des Händlers

InfoText

ans..1024

O

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

ExternalMessage

ans..256

O

Fehlertext von Ratepay, wenn mit Computop Support abgesprochen

ExternalCode

ans..64

O

Fehlercode von Ratepay, wenn mit Computop Support abgesprochen

Installment

a..5

O

Bei IBS: True / False, ob installment erlaubt ist

Prepayment

a..5

O

Bei IBS: True / False, ob prepayment erlaubt ist

Invoice

a..5

O

Bei IBS: True / False, ob invoice erlaubt ist

ELV

a..5

O

Bei IBS: True / False, ob ELV erlaubt ist

RPTransID

ans..50

M

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

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

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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter

Format

CND

Beschreibung

MerchantID

ans..30

M

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

PayID

an32

M

Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien

TransID

ans..64

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

Amount

n..10

M

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent).

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a3

M

Währung, drei Zeichen DIN / ISO 4217

MAC

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus

Month

ans..255

C

Laufzeit in Monaten. Pflicht bei EventToken RT

Rate

n..8

C

Monatliche Rate in kleinster Währungseinheit. Pflicht bei EventToken RR

FirstDay

n..2

O

Kalendertag der ersten Zahlung.

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

StartDate

dttm8

O

Startdatum der Ratenzahlung im Format YYYYMMDD

DueDate

dttm8

O

Fälligkeitsdatum im Format YYYYMMDD

InterestRate

n..5

O

Sollzinssatz, zum Beispiel 1370 für 13,70%

EventToken

a..2

M

RT (CalculationbyTime) oder RR (CalculationbyRate)

Account

ans..10

O

Account-Kennung, um gesonderte (SubShops) Logins zu nutzen

Parameter für Ratepay-Ratenrechner

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

Parameter

Format

CND

Beschreibung

MID

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

an32

M

Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien

XID

an32

M

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

TransID

ans..64

M

Transaktionsnummer des Händlers

Status

a..50

M

INIT oder FAILED

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!

Code

n8

M

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

RefNr

ans..30

O

eindeutige Referenznummer des Händlers

InfoText

ans..1024

O

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

ExternalMessage

ans..256

O

Fehlertext von Ratepay, wenn mit Computop Support abgesprochen

ExternalCode

ans..64

O

Fehlercode von Ratepay, wenn mit Computop Support abgesprochen

TotalAmount

n..10

M

Zu finanzierender Gesamtbetrag in der kleinsten Währungseinheit

InterestAmount

n..10

M

Summe aller monatlich gezahlten Raten in der kleinsten Währungseinheit

ServiceCharge

n..10

M

Zusätzliche Finanzierungskosten in der kleinsten Währungseinheit

InterestRate

n..5

M

Sollzinssatz, zum Beispiel 1370 für 13,70%

AnnualPercentageRate

n..5

M

Jahreszins basierend auf ServiceCharge und InterestRate

MonthlyDebitInterest

n..5

M

Monatlicher Zins basierend auf AnnualPercentageRate

InstallmentNumber

n..2

M

Anzahl Monate der Ratenzahlung

InstallmentAmount

n..10

M

Monatlich zu bezahlender Betrag in der kleinsten Währungseinheit

InstallmentLastAmount

n..10

M

Betrag der letzten Rate in der kleinsten Währungseinheit

FirstDay

n..2

O

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:

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

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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter

Format

CND

Beschreibung

MerchantID

ans..30

M

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

PayID

an32

M

Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung von Batch-Dateien

TransID

ans..64

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

MAC

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus

Account

ans..10

O

Account-Kennung, um gesonderte (SubShops) Logins zu nutzen

EventToken

a..2

M

RC für Rateconfiguration

Parameter zur Abfrage der Konfiguration des Ratepay-Ratenrechners

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

Parameter

Format

CND

Beschreibung

MID

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

an32

M

Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien

XID

an32

M

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

TransID

ans..64

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

Status

a..50

M

OK oder FAILED

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!

Code

n8

M

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

MinRate

n..2

O

Mindestanzahl der Raten

DefaultRate

n..12

O

Standardrate in der kleinsten Währungseinheit

MaxInterestRate

n..5

O

Maximaler Zinssatz

MinMonth

n..2

O

Mindestlaufzeit in Monaten

MaxMonth

n..2

O

Maximallaufzeit in Monaten

MonthLongrun

n..2

O

Mindestlaufzeit für eine Langzeitfinanzierung

MonthAllowed

ans..50

O

Kommaseparierte Liste mit erlaubten Laufzeiten in Monaten

FirstDay

ans..20

O

Kommaseparierte Liste mit möglichen Starttagen (1,15,28)

LastRate

n..12

O

Mindestbetrag für die Abschlussrate in der kleinsten Währungseinheit

MinRateNormal

n..12

O

Mindestrate in der kleinsten Währungseinheit

MinRateLongrun

n..12

O

Mindestrate einer Langzeitfinanzierung in der kleinsten Währungseinheit

ServiceCharge

n..12

O

Zusä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)

ExternalMessage

ans..256

O

Fehlertext von Ratepay, wenn mit Computop Support abgesprochen

ExternalCode

ans..64

O

Fehlercode von Ratepay, wenn mit Computop Support abgesprochen

Antwort-Parameter der Konfigurationsabfrage des Ratepay-Ratenrechners

Zahlungsvorgang anlegen

Um einen Zahlungsvorgang mit Ratepay anzulegen, verwenden Sie bitte folgende URL:

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

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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter

Format

CND

Beschreibung

MerchantID

ans..30

M

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

PayID

an32

M

Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien

TransID

ans..64

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

Amount

n..10

M

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent).

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a3

M

Währung, drei Zeichen DIN / ISO 4217

MAC

an64

O

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus

RPMethod

ans..10

M

Zahlungsweise: INVOICE, INSTALLMENT oder ELV

ShoppingBasketAmount

n..10

M

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

TrackingID

ans..100

O

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!

Account

ans..10

O

Account-Kennung, um gesonderte (SubShops) Logins zu nutzen.

DeviceToken

ans..100

O

Geräte-Token, siehe externe Dokumentation von Ratepay

ShopSystem

ans..127

O

Name des Shop-Systems

ShopSystemVersion

ans..127

O

Versionsnummer des Shop-Systems

EventToken

a..2

M

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

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

InstallmentNumber

n..10

C

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

InstallmentAmount

n..10

C

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

InstallmentLastAmount

n..10

C

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

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

Parameter zum Anlegen einer Ratepay-Zahlung

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

Parameter

Format

CND

Beschreibung

MID

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

an32

M

Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien

XID

an32

M

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

TransID

ans..64

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

Status

a..50

M

OK oder FAILED

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!

Code

n8

M

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

InfoText

ans..1024

O

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

ExternalMessage

ans..256

O

Fehlertext von Ratepay, wenn mit Computop Support abgesprochen

ExternalCode

ans..64

O

Fehlercode von Ratepay, wenn mit Computop Support abgesprochen

Antwort-Parameter beim Anlegen einer Ratepay-Zahlung

Zahlungsvorgang bestätigen (Confirm)

Um einen Zahlungsvorgang mit Ratepay zu bestätigen, verwenden Sie bitte folgende URL:

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

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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter

Format

CND

Beschreibung

MerchantID

ans..30

M

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

PayID

an32

M

Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien

TransID

ans..64

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

MAC

an64

O

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus

Account

ans..10

O

Account-Kennung, um gesonderte (SubShops) Logins zu nutzen.

EventToken

a..2

M

V für Verify

Parameter zum Bestätigen einer Ratepay-Zahlung

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

Parameter

Format

CND

Beschreibung

MID

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

an32

M

Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien

XID

an32

M

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

TransID

ans..64

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

Status

a..50

M

OK oder FAILED

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!

Code

n8

M

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

InfoText

ans..1024

O

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

ExternalMessage

ans..256

O

Fehlertext von Ratepay, wenn mit Computop Support abgesprochen

ExternalCode

ans..64

O

Fehlercode von Ratepay, wenn mit Computop Support 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:

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

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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter

Format

CND

Beschreibung

MerchantID

ans..30

M

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

PayID

an32

M

Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien

TransID

ans..64

M

Vom Händler initial vergebene ID für den zu buchenden Zahlungsvorgang

Amount

n..10

M

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent).

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a3

M

Währung, drei Zeichen DIN / ISO 4217

MAC

an64

O

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus

ShoppingBasket

ans..1024

M

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

ShoppingBasketAmount

n..10

M

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

Discount

ans..100

O

Warenkorbübergreifender Rabatt.

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Rabatt;1000;1900

Shipping

ans..100

O

Versandkosten

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Versand;500;1900

Account

ans..10

O

Account-Kennung, um gesonderte (SubShops) Logins zu nutzen.

InvoiceID

ans..50

=

Rechnungsnummer

TrackingID

ans..100

O

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!

ShopSystem

ans..127

O

Name des Shop-Systems

ShopSystemVersion

ans..127

O

Versionsnummer des Shop-Systems

EventToken

a..2

M

C für Capture (Buchung)

Parameter zum Buchen einer Ratepay-Zahlung

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

Parameter

Format

CND

Beschreibung

MID

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

an32

M

Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien

XID

an32

M

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

TransID

ans..64

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

Status

a..50

M

OK oder FAILED

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!

Code

n8

M

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

InfoText

ans..1024

O

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

ExternalMessage

ans..256

O

Fehlertext von Ratepay, wenn mit Computop Support abgesprochen

ExternalCode

ans..64

O

Fehlercode von Ratepay, wenn mit Computop Support 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:

Parameter

Format

CND

Beschreibung

MerchantID

ans..30

M

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

PayID

an32

M

Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien

TransID

ans..64

M

ID des Händlers zur Identifizierung des zu stornierenden Zahlungsvorgangs

Amount

n..10

M

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent).

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a3

M

Währung, drei Zeichen DIN / ISO 4217

MAC

an64

O

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus

RPMethod

ans..10

M

Zahlungsweise: INVOICE, INSTALLMENT oder ELV

ShoppingBasket

ans..1024

M

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

ShoppingBasketAmount

n..10

M

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

Discount

ans..100

O

Warenkorbübergreifender Rabatt.

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Rabatt;1000;1900

Shipping

ans..100

O

Versandkosten

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Versand;500;1900

Account

ans..10

O

Account-Kennung, um gesonderte (SubShops) Logins zu nutzen.

ShopSystem

ans..127

O

Name des Shop-Systems

ShopSystemVersion

ans..127

O

Versionsnummer des Shop-Systems

EventToken

a..2

M

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 Ergebnis-Parameter, die das Paygate als Antwort zurückgibt:

Parameter

Format

CND

Beschreibung

MID

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

an32

M

Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien

XID

an32

M

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

TransID

ans..64

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

Status

a..50

M

OK oder FAILED

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!

Code

n8

M

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

InfoText

ans..1024

O

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

ExternalMessage

ans..256

O

Fehlertext von Ratepay, wenn mit Computop Support abgesprochen

ExternalCode

ans..64

O

Fehlercode von Ratepay, wenn mit Computop Support 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:

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

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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter

Format

CND

Beschreibung

MerchantID

ans..30

M

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

PayID

an32

M

Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien

TransID

ans..64

M

Vom Händler initial vergebene ID für den gutzuschreibenden Zahlungsvorgang

Amount

n..10

M

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent).

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a3

M

Währung, drei Zeichen DIN / ISO 4217

MAC

an64

O

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus

ShoppingBasket

ans..1024

M

Warenkorb mit einem „CREDIT“-Artikel (Aufbau siehe Tabelle ShoppingBasket)

ShoppingBasketAmount

n..10

M

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

Discount

ans..100

O

Warenkorbübergreifender Rabatt.

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Rabatt;1000;1900

Shipping

ans..100

O

Versandkosten

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Versand;500;1900

Account

ans..10

O

Account-Kennung, um gesonderte (SubShops) Logins zu nutzen.

ShopSystem

ans..127

O

Name des Shop-Systems

ShopSystemVersion

ans..127

O

Versionsnummer des Shop-Systems

EventToken

a..2

M

CR für Credit (Gutschrift)

Parameter für Gutschrift einer Ratepay-Zahlung

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

Parameter

Format

CND

Beschreibung

MID

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

an32

M

Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien

XID

an32

M

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

TransID

ans..64

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

Status

a..50

M

OK oder FAILED

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!

Code

n8

M

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

InfoText

ans..1024

O

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

ExternalMessage

ans..256

O

Fehlertext von Ratepay, wenn mit Computop Support abgesprochen

ExternalCode

ans..64

O

Fehlercode von Ratepay, wenn mit Computop Support 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:

Parameter

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:

Aktion

Version

Beschreibung

Capture

1.0 / 2.0

Standardversion ohne Rückgabe von Code

1.x / 2.x

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

1.1.2 / 2.1.2

mit discount und shipping

Change

1.0 / 2.0

Standardversion ohne Rückgabe von Code

1.x / 2x.

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

1.1.2 / 2.1.2

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

Ratepay-Zahlungen initialisieren

Um eine Zahlung mit Ratepay über eine Server-zu-Server-Verbindung zu initialisieren, rufen Sie folgende URL auf:

Parameter für Ratepay-Zahlungen

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:

Parameter für Ratepay-Ratenrechner

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:

Parameter zur Abfrage der Konfiguration des Ratepay-Ratenrechners

Antwort-Parameter der Konfigurationsabfrage des Ratepay-Ratenrechners

Zahlungsvorgang anlegen

Um einen Zahlungsvorgang mit Ratepay anzulegen, verwenden Sie bitte folgende URL:

Parameter zum Anlegen einer Ratepay-Zahlung

Antwort-Parameter beim Anlegen einer Ratepay-Zahlung

Zahlungsvorgang bestätigen (Confirm)

Um einen Zahlungsvorgang mit Ratepay zu bestätigen, verwenden Sie bitte folgende URL:

Parameter zum Bestätigen einer Ratepay-Zahlung

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:

Parameter zum Buchen einer Ratepay-Zahlung

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

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

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

Gutschrift von Ratepay-Zahlungen

Um eine Gutschrift mit Ratepay durchzuführen, verwenden Sie bitte folgende URL:

Parameter für Gutschrift einer Ratepay-Zahlung

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:

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:

Beschreibung der möglichen Batch-Versionen

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

Beispiel für Master-MID-Funktion:

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

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

Parameter

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)

Amount

n..10

M

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent).

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a3

M

Währungskürzel, drei Zeichen DIN / ISO 4217

TransID

ans..64

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

ans..30

O

eindeutige Referenznummer

PayID

an32

M

Vom Paygate vergebene ID für diese Transaktion

ShoppingBasket

ans..1024

M

Warenkorb (Aufbau siehe Tabelle ShoppingBasket)

ShoppingBasketAmount

n..10

M

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

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

Shipping

ans..100

O

Versandkosten

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

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>

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

Parameter

Format

CND

Beschreibung

Action

a..20

M

Der Action-Parameter definiert die Art der Transaktion:

Capture (Buchung)

Change (Gutschrift / Änderung)

PayID

an32

M

Vom Paygate vergebene ID für diese Transaktion

Status

a..50

M

OK oder FAILED

Code

n8

M

Beschreibung der Ergebnis-Parameter im Datensatz von Batch-Dateien