1 Über RatePAY

1.1 Allgemeines zu RatePAY

Logo

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

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 1cs Online Bezahlsystem 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 1cs Online Bezahlsystem 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.

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

1.2 Diagramm zum Prozessablauf

 

RatePAY Prozessablauf

2 1cs Online Bezahlsystem Schnittstelle

2.1 Definitionen

2.1.1 Datenformate

FormatBeschreibung
aalphabetisch
asalphabetisch mit Sonderzeichen
nnumerisch
analphanumerisch
ansalphanumerisch mit Sonderzeichen
nsnumerisch mit Sonderzeichen
boolBool’scher Ausdruck (true oder false)
3feste Länge mit 3 Stellen/Zeichen
..3variable Länge mit maximal 3 Stellen/Zeichen
enumAufzählung erlaubter Werte
dttmISODateTime (JJJJ-MM-TTThh:mm:ss)

2.1.2 Abkürzungen

AbkürzungBeschreibungKommentar
CNDBedingung (condition) 
MPflicht (mandatory)Wenn ein Parameter Pflicht ist, dann muss er vorhanden sein
OoptionalWenn ein Parameter optional ist, dann kann er vorhanden sein, ist aber nicht erforderlich
Cbedingt (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.

2.2 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 First Cash Solution RatePAY-Anbindung gibt es 5 verschiedene Requests, welche je nach Situation und Fortschritt im Bezahlprozess durchgeführt werden müssen. Die First Cash Solution setzt diese Requests in die entsprechenden RatePAY-Requests um. Hierfür gilt folgendes Mapping:

RequestRatePAY-RequestBeschreibung
INIT / AuthorizePAYMENT_INIT (PAYMENT_QUERY)Die First Cash Solution 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_REQUESTInitialisiert einen Raten- bzw. Rechnungskauf EventToken = R
Verify (Authorize Schritt 2)PAYMENT_CONFIRMBestätigt die Initialisierung erneut. Die First Cash Solution 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_CHANGEOptional: Hiermit kann die Zahlung bearbeitet werden. Möglich sind: –          Vollstornierung / EventToken = FC –          Teilstornierung / EventToken = PC –          Auftragsänderung / EventToken = CO
CaptureCONFIRMATION_DELIVERYAktiviert 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_CHANGEOptional: Hiermit kann die Zahlung bearbeitet werden. Möglich sind: –          Vollrückgabe / EventToken = FR –          Teilrückgabe / EventToken = PR –          Gutschrift / EventToken = CR

2.3 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 1cs Online Bezahlsystem alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.

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

KeyFormatCNDBeschreibung
MerchantIDans..30MHändlerID, die von der First Cash Solution vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.
TransIDans..64MTransaktionsID, die für jede Zahlung eindeutig sein muss
RefNrns..30Meindeutige Referenznummer Es sind ausschließlich ASCII-Zeichen erlaubt. Sonderzeichen wie („Umlaute“, …) sind nicht erlaubt und müssen ggf. durch ASCII-Zeichen ersetzt werden (z.B. ü → ue, é → e, …).
Amountn..10MBetrag 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.
Currencya3MWährung, drei Zeichen DIN / ISO 4217 Hier eine Übersicht: A1 Währungstabelle
MACan64MHash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: HMAC-Authentisierung (Anfrage) HMAC-Authentisierung (Notify)
OrderDescans..768MBeschreibung der gekauften Waren
Emailans..255ME-Mail-Adresse des Karteninhabers
CustomerIDan..30MEindeutige ID des Kunden im Händlersystem oder die E-Mail-Adresse des Kunden
CustomerClassificationans..8MAnweisung an das Risikomanagement um welchen Kundentyp es sich handelt: negative, neutral, positive, vip
Titleans..45OTitel
Salutationans..45OAnrede
Gendera1MGeschlecht: M=male, F=female, U=unknown
DateOfBirthdttm8CGeburtsdatum im Format YYYYMMDD
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.
AccOwnerans..55CName des Kontoinhabers. Pflicht bei DirectDebit.
AccIBANans..34CInternational Bank Account Number. Pflicht bei DirectDebit.
BICans11CBank Identifier Code. Pflicht bei DirectDebit.
AccBankans..27OName des Kreditinstituts
Nationalitya2MLändercode des Herkunftslandes des Kunden gemäß ISO-3166 alpha 2
AllowMarketinga..3MKunde stimmt der Weitergabe seiner Daten zu Marketingzwecken zu (yes / no)
AllowCredInqa..3MKunde stimmt der Weitergabe seiner Daten für Kreditangebote zu (yes/no)
ShopSystemans..127MName des Shop-Systems
ShopSystemVersionans..127MVersionsnummer des Shop-Systems
ShoppingBasketans..1024MAktueller Warenkorb (Aufbau siehe Tabelle Shopping-Basket)
ShoppingBasketAmountn..10MGesamtwert des Warenkorbs in kleinster Währungseinheit (Abzüglich Rabatte, inkl. Versand u.a.)
Discountans..100OWarenkorbübergreifender Rabatt. Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ Beispiel: Rabatt;1000;1900
Shippingans..100OVersandkosten Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ Beispiel: Versand;500;1900
TrackingIdans..100OListe 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!
Accountans..10OAccount-Kennung, um gesonderte (SubShops) Logins zu nutzen.
EventTokena..2M„A“ für Autorisierung
Firmendaten (B2B)
CompanyNameans..100CFirmenname, Pflicht bei B2B
VatIDans..25CUmsatzsteuer-ID, Pflicht bei B2B
CompanyIDans..50OHandelsregisternummer
LegalFormans..100ORechtsform. Zu übergebender Wert muss mit RatePAY abgestimmt werden!
RegistryLocationans..255OFirmensitz
Homepageans..255OHomepage des Unternehmens
Lieferdaten
sdFirstNameans..100OVorname des Kunden
sdLastNameans..100ONachname des Kunden
sdStreetans..100OStraßenname und Hausnummer
sdStreetHouseNumberans..10OHausnummer
sdStreetAdditionans..50OZusatz in der Lieferadresse
sdZIPans..10OPostleitzahl
sdCityans..255OOrt
sdCountryCodea2OLändercode zweistellig gemäß ISO 3166
sdPhonens..32OTelefonnummer des Kunden
Rechnungsdaten (Prüfadresse)
bdFirstNameans..100MVorname des Kunden
bdLastNameans..100MNachname des Kunden
bdCompanyNameans..100OFirmenname
bdStreetans..50MStraßenname der Rechnungsadresse
bdStreetNrans..10MHausnummer der Rechnungsadresse
bdStreetAdditionans..50OAdresszusatz der Rechnungsadresse
bdZIPans..10MPostleitzahl der Rechnungsadresse
bdCityans..255MOrt der Rechnungsadresse
bdCountry­Codea2MLändercode der Rechnungsadresse zweistellig gemäß ISO 3166
bdPhonens..32MTelefonnummer des Kunden
Registrierungsadresse (B2B)
FirstNameans..100OVorname
LastNameans..100ONachname
AddrStreetans..50CStraße. Pflicht wenn B2B (CompanyName angegeben)
AddrStreetNrans..10CHausnummer. Pflicht wenn B2B (CompanyName angegeben)
AddressAdditionans..50OAdresszusatz
AddrZipans..10CPostleitzahl. Pflicht wenn B2B (CompanyName angegeben)
AddrCityans..32COrt. Pflicht wenn B2B (CompanyName angegeben)
AddrCountryCodea2CLändercode zweistellig gemäß ISO 3166. Pflicht wenn B2B (CompanyName angegeben)
Betrugsprävention
IPAddrans..15MDurch die übergebene IP-Adresse kann das 1cs Online Bezahlsystem 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

Folgende Tabelle beschreibt die Parameter, die das 1cs Online Bezahlsystem als Antwort zurückgibt:

  • es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden
  • die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden 
ParameterFormatCNDBeschreibung
MIDans..30MHändlerID, die von der First Cash Solution vergeben wird
PayIDan32MVom 1cs Online Bezahlsystem vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien
XIDan32MVom 1cs Online Bezahlsystem vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden
TransIDans..64MTransaktionsnummer des Händlers
Statusa..50MINIT oder FAILED
Descriptionans..1024MNähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus!
Coden8MFehlercode gemäß Excel-Datei 1cs Online Bezahlsystem Antwort Codes 
RefNrans..30Oeindeutige Referenznummer des Händlers Es sind ausschließlich ASCII-Zeichen erlaubt. Sonderzeichen wie („Umlaute“, …) sind nicht erlaubt und müssen ggf. durch ASCII-Zeichen ersetzt werden (z.B. ü → ue, é → e, …).
InfoTextans..1024OEnthält einen Info-Text, der dem Kunden weitergegeben werden kann (z.B. bei Ablehnung)
ExternalMessageans..256OFehlertext von RatePAY, wenn mit dem First Cash Solution Support abgesprochen
ExternalCodeans..64OFehlercode von RatePAY, wenn mit dem First Cash Solution Support 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..50MEindeutige Referenznummer von RatePAY

Antwort-Parameter für RatePAY-Zahlungen

2.4 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 1cs Online Bezahlsystem alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

ParameterFormatCNDBeschreibung
MerchantIDans..30MHändlerID, die von der First Cash Solution vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.
PayIDan32MVom 1cs Online Bezahlsystem vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien
TransIDans..64MTransaktionsID, die für jede Zahlung eindeutig sein muss
Amountn..10MBetrag 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.
Currencya3MWährung, drei Zeichen DIN / ISO 4217
MACan64MHash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: HMAC-Authentisierung (Anfrage) HMAC-Authentisierung (Notify)
Monthans..255CLaufzeit in Monaten. Pflicht bei EventToken RT
Raten..8CMonatliche Rate in kleinster Währungseinheit. Pflicht bei EventToken RR
FirstDayn..2OKalendertag der ersten Zahlung. Mögliche Werte sind 1,15,28. Standardwert = 28.
StartDatedttm8OStartdatum der Ratenzahlung im Format YYYYMMDD
DueDatedttm8OFälligkeitsdatum im Format YYYYMMDD
InterestRaten..5OSollzinssatz, zum Beispiel 1370 für 13,70%
EventTokena..2MA für Autorisierung
Accountans..10OAccount-Kennung, um gesonderte (SubShops) Logins zu nutzen

Parameter für RatePAY-Ratenrechner

Folgende Tabelle beschreibt die Parameter, die das 1cs Online Bezahlsystem als Antwort zurückgibt:

  • es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden
  • die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden 
ParameterFormatCNDBeschreibung
MIDans..30MHändlerID, die von der First Cash Solution vergeben wird
PayIDan32MVom 1cs Online Bezahlsystem vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien
XIDan32MVom 1cs Online Bezahlsystem vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden
TransIDans..64MTransaktionsnummer des Händlers
Statusa..50MINIT oder FAILED
Descriptionans..1024MNähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus!
Coden8MFehlercode gemäß Excel-Datei 1cs Online Bezahlsystem Antwort Codes 
MACan64MHash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: HMAC-Authentisierung (Anfrage) HMAC-Authentisierung (Notify)
RefNrans..30Oeindeutige Referenznummer des Händlers Es sind ausschließlich ASCII-Zeichen erlaubt. Sonderzeichen wie („Umlaute“, …) sind nicht erlaubt und müssen ggf. durch ASCII-Zeichen ersetzt werden (z.B. ü → ue, é → e, …).
InfoTextans..1024OEnthält einen Info-Text, der dem Kunden weitergegeben werden kann (z.B. bei Ablehnung)
ExternalMessageans..256OFehlertext von RatePAY, wenn mit dem First Cash Solution Support abgesprochen
ExternalCodeans..64OFehlercode von RatePAY, wenn mit dem First Cash Solution Support 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..2OKalendertag 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 1cs Online Bezahlsystem alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

ParameterFormatCNDBeschreibung
MerchantIDans..30MHändlerID, die von der First Cash Solution vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.
PayIDan32MVom 1cs Online Bezahlsystem vergebene ID für die Zahlung, z.B. zur Referenzierung von Batch-Dateien
TransIDans..64MTransaktionsID, die für jede Zahlung eindeutig sein muss
MACan64MHash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: HMAC-Authentisierung (Anfrage) HMAC-Authentisierung (Notify)
Accountans..10OAccount-Kennung, um gesonderte (SubShops) Logins zu nutzen
EventTokena..2MRC für Rateconfiguration

Parameter zur Abfrage der Konfiguration des RatePAY-Ratenrechners

Folgende Tabelle beschreibt die Parameter, die das 1cs Online Bezahlsystem als Antwort zurückgibt:

  • es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden
  • die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden 
ParameterFormatCNDBeschreibung
MIDans..30MHändlerID, die von der First Cash Solution vergeben wird
PayIDan32MVom 1cs Online Bezahlsystem vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien
XIDan32MVom 1cs Online Bezahlsystem vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden
TransIDans..64MTransaktionsID, die für jede Zahlung eindeutig sein muss
Statusa..50MOK oder FAILED
Descriptionans..1024MNähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus!
Coden8MFehlercode gemäß Excel-Datei 1cs Online Bezahlsystem Antwort Codes 
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..12OMindestbetrag für die Abschlussrate in der kleinsten Währungseinheit
MinRateNormaln..12OMindestrate in der kleinsten Währungseinheit
MinRateLongrunn..12OMindestrate einer Langzeitfinanzierung in der kleinsten Währungseinheit
ServiceChargen..12OZusätzliche Finanzierungskosten in der kleinsten Währungseinheit
InfoTextans..1024OEnthält einen Info-Text, der dem Kunden weitergegeben werden kann (z.B. bei Ablehnung)
ExternalMessageans..256OFehlertext von RatePAY, wenn mit dem First Cash Solution Support abgesprochen
ExternalCodeans..64OFehlercode von RatePAY, wenn mit dem First Cash Solution Support abgesprochen

Antwort-Parameter der Konfigurationsabfrage des RatePAY-Ratenrechners

2.5 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 1cs Online Bezahlsystem alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

ParameterFormatCNDBeschreibung
MerchantIDans..30MHändlerID, die von der First Cash Solution vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.
PayIDan32MVom 1cs Online Bezahlsystem vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien
TransIDans..64MTransaktionsID, die für jede Zahlung eindeutig sein muss
Amountn..10MBetrag 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.
Currencya3MWährung, drei Zeichen DIN / ISO 4217
MACan64OHash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: HMAC-Authentisierung (Anfrage) HMAC-Authentisierung (Notify)
RPMethodans..10MZahlungsweise: INVOICE, INSTALLMENT oder ELV
ShoppingBasketAmountn..10MGesamtwert des Warenkorbs in kleinster Währungseinheit (abzüglich Rabatte, inkl. Versand u.a.)
TrackingIDans..100OListe 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!
MaxRiskn..2OMaximal erlaubte Risikoklasse (1-10)
Accountans..10OAccount-Kennung, um gesonderte (SubShops) Logins zu nutzen.
DeviceTokenans..100OGeräte-Token, siehe externe Dokumentation von RatePAY
DeliveryDatedttm8OLieferdatum im Format YYYYMMDD
ShopSystemans..127OName des Shop-Systems
ShopSystemVersionans..127OVersionsnummer des Shop-Systems
EventTokena..2MR für RateInit
SEPA (ELV)
AccOwnerans..55CName des Kontoinhabers. Pflicht bei DirectDebit.
AccIBANans..34CInternational Bank Account Number. Pflicht bei DirectDebit.
BICans11CBank Identifier Code. Pflicht bei DirectDebit.
AccBankans..27OName des Kreditinstituts
DebitPayTypea2CZahlungsweise. Pflicht bei DirectDebit. BT = BankTransfer ; DD = DirectDebit
Rechnung
InvoiceIDans..50CRechnungsnummer. Pflicht bei Invoice.
InvoiceDatedttm8CRechnungsdatum. Pflicht bei Invoice.
DueDatedttm8CFälligkeitsdatum. Pflicht bei Invoice.
Ratenzahlung (INSTALLMENT)
InterestRaten..5CSollzinssatz (Wert ist dem Ratenrechner zu entnehmen). Pflicht bei Installment.
InstallmentNumbern..10CAnzahl Monate der Ratenzahlung (Wert ist dem Ratenrechner zu entnehmen). Pflicht bei Installment.
InstallmentAmountn..10CMonatlich zu bezahlender Betrag (Wert ist dem Ratenrechner zu entnehmen). Pflicht bei Installment.
InstallmentLastAmountn..10CBetrag der letzten Rate (Wert ist dem Ratenrechner zu entnehmen). Pflicht bei Installment.
FirstDayn..2OKalendertag der ersten Zahlung. Mögliche Werte sind 1,15,28. Standardwert = 28.
TotalAmountn..10CZu finanzierender Gesamtbetrag. Pflicht bei Installment.

Parameter zum Anlegen einer RatePAY-Zahlung

Folgende Tabelle beschreibt die Parameter, die das 1cs Online Bezahlsystem als Antwort zurückgibt:

  • es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden
  • die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden 
ParameterFormatCNDBeschreibung
MIDans..30MHändlerID, die von der First Cash Solution vergeben wird
PayIDan32MVom 1cs Online Bezahlsystem vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien
XIDan32MVom 1cs Online Bezahlsystem vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden
TransIDans..64MTransaktionsID, die für jede Zahlung eindeutig sein muss
Statusa..50MOK oder FAILED
Descriptionans..1024MNähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus!
Coden8MFehlercode gemäß Excel-Datei 1cs Online Bezahlsystem Antwort Codes
MACan64MHash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: HMAC-Authentisierung (Anfrage) HMAC-Authentisierung (Notify)
InfoTextans..1024OEnthält einen Info-Text, der dem Kunden weitergegeben werden kann (z.B. bei Ablehnung)
ExternalMessageans..256OFehlertext von RatePAY, wenn mit dem First Cash Solution Support abgesprochen
ExternalCodeans..64OFehlercode von RatePAY, wenn mit dem First Cash Solution Support abgesprochen

Antwort-Parameter beim Anlegen einer RatePAY-Zahlung

2.6 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 1cs Online Bezahlsystem alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

ParameterFormatCNDBeschreibung
MerchantIDans..30MHändlerID, die von der First Cash Solution vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.
PayIDan32MVom 1cs Online Bezahlsystem vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien
TransIDans..64MTransaktionsID, die für jede Zahlung eindeutig sein muss
MACan64OHash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: HMAC-Authentisierung (Anfrage) HMAC-Authentisierung (Notify)
Accountans..10OAccount-Kennung, um gesonderte (SubShops) Logins zu nutzen.
EventTokena..2MV für Verify

Parameter zum Bestätigen einer RatePAY-Zahlung

Folgende Tabelle beschreibt die Parameter, die das 1cs Online Bezahlsystem als Antwort zurückgibt:

  • es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden
  • die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden 
ParameterFormatCNDBeschreibung
MIDans..30MHändlerID, die von der First Cash Solution vergeben wird
PayIDan32MVom 1cs Online Bezahlsystem vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien
XIDan32MVom 1cs Online Bezahlsystem vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden
TransIDans..64MTransaktionsID, die für jede Zahlung eindeutig sein muss
Statusa..50MOK oder FAILED
Descriptionans..1024MNähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus!
Coden8MFehlercode gemäß Excel-Datei 1cs Online Bezahlsystem Antwort Codes
MACan64MHash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: HMAC-Authentisierung (Anfrage) HMAC-Authentisierung (Notify)
InfoTextans..1024OEnthält einen Info-Text, der dem Kunden weitergegeben werden kann (z.B. bei Ablehnung)
ExternalMessageans..256OFehlertext von RatePAY, wenn mit dem First Cash Solution Support abgesprochen
ExternalCodeans..64OFehlercode von RatePAY, wenn mit dem First Cash Solution Support abgesprochen

Parameter zum Bestätigen einer RatePAY-Zahlung

2.7 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 1cs Online Bezahlsystem alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

ParameterFormatCNDBeschreibung
MerchantIDans..30MHändlerID, die von der First Cash Solution vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.
PayIDan32MVom 1cs Online Bezahlsystem vergebene ID für die Zahlung
TransIDans..64MTransaktionsID, die für jede Zahlung eindeutig sein muss
Amountn..10MBetrag 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.
Currencya3MWährung, drei Zeichen DIN / ISO 4217
MACan64OHash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: HMAC-Authentisierung (Anfrage) HMAC-Authentisierung (Notify)
ReqIDans..32OUm Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion mit derselben ReqID erneut eingereicht wird, führt das 1cs OBS keine Zahlung aus sondern gibt nur den Status der ursprünglichen Transaktion zurück. Bitte beachten Sie, dass das 1cs OBS für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.
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..100OWarenkorbübergreifender Rabatt. Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ Beispiel: Rabatt;1000;1900
Shippingans..100OVersandkosten Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ Beispiel: Versand;500;1900
Accountans..10OAccount-Kennung, um gesonderte (SubShops) Logins zu nutzen.
InvoiceIDans..50ORechnungsnummer
TrackingIDans..100OListe 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..127OVersionsnummer des Shop-Systems
EventTokena..2MC für Capture (Buchung)

Parameter zum Buchen einer RatePAY-Zahlung

Folgende Tabelle beschreibt die Parameter, die das 1cs Online Bezahlsystem als Antwort zurückgibt:

  • es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden
  • die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden 
ParameterFormatCNDBeschreibung
MIDans..30MHändlerID, die von der First Cash Solution vergeben wird
PayIDan32MVom 1cs Online Bezahlsystem vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien
XIDan32MVom 1cs Online Bezahlsystem vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden
TransIDans..64MTransaktionsID, die für jede Zahlung eindeutig sein muss
Statusa..50MOK oder FAILED
Descriptionans..1024MNähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus!
Coden8MFehlercode gemäß Excel-Datei 1cs Online Bezahlsystem Antwort Codes 
InfoTextans..1024OEnthält einen Info-Text, der dem Kunden weitergegeben werden kann (z.B. bei Ablehnung)
ExternalMessageans..256OFehlertext von RatePAY, wenn mit dem First Cash Solution Support abgesprochen
ExternalCodeans..64OFehlercode von RatePAY, wenn mit dem First Cash Solution Support abgesprochen

Antwort-Parameter beim Buchen einer RatePAY-Zahlung

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

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

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 1cs Online Bezahlsystem alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

ParameterFormatCNDBeschreibung
MerchantIDans..30MHändlerID, die von der First Cash Solution vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.
PayIDan32MVom 1cs Online Bezahlsystem vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien
TransIDans..64MID des Händlers zur Identifizierung des zu stornierenden Zahlungsvorgangs
Amountn..10MBetrag 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.
Currencya3MWährung, drei Zeichen DIN / ISO 4217
MACan64OHash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: HMAC-Authentisierung (Anfrage) HMAC-Authentisierung (Notify)
ReqIDans..32OUm Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion mit derselben ReqID erneut eingereicht wird, führt das 1cs OBS keine Zahlung aus sondern gibt nur den Status der ursprünglichen Transaktion zurück. Bitte beachten Sie, dass das 1cs OBS für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.
ShoppingBasketans..1024MWarenkorb mit den zu stornierenden Artikeln (Aufbau siehe Tabelle ShoppingBasket)
ShoppingBasketAmountn..10MGesamtwert des aktuellen Warenkorbs in kleinster Währungseinheit (abzüglich Rabatte, inkl. Versand u.a.)
Discountans..100OWarenkorbübergreifender Rabatt. Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ Beispiel: Rabatt;1000;1900
Shippingans..100OVersandkosten Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ Beispiel: Versand;500;1900
Accountans..10OAccount-Kennung, um gesonderte (SubShops) Logins zu nutzen.
ShopSystemans..127OName des Shop-Systems
ShopSystemVersionans..127OVersionsnummer des Shop-Systems
EventTokena..2MFC 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

Folgende Tabelle beschreibt die Parameter, die das 1cs Online Bezahlsystem als Antwort zurückgibt:

  • es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden
  • die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden 
ParameterFormatCNDBeschreibung
MIDans..30MHändlerID, die von der First Cash Solution vergeben wird
PayIDan32MVom 1cs Online Bezahlsystem vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien
XIDan32MVom 1cs Online Bezahlsystem vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden
TransIDans..64MTransaktionsID, die für jede Zahlung eindeutig sein muss
Statusa..50MOK oder FAILED
Descriptionans..1024MNähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus!
Coden8MFehlercode gemäß Excel-Datei 1cs Online Bezahlsystem Antwort Codes
InfoTextans..1024OEnthält einen Info-Text, der dem Kunden weitergegeben werden kann (z.B. bei Ablehnung)
ExternalMessageans..256OFehlertext von RatePAY, wenn mit dem First Cash Solution Support abgesprochen
ExternalCodeans..64OFehlercode von RatePAY, wenn mit dem First Cash Solution Support abgesprochen

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

2.9 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 1cs Online Bezahlsystem alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

ParameterFormatCNDBeschreibung
MerchantIDans..30MHändlerID, die von der First Cash Solution vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.
PayIDan32MVom 1cs Online Bezahlsystem vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien
TransIDans..64MVom Händler initial vergebene ID für den gutzuschreibenden Zahlungsvorgang
Amountn..10MBetrag 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.
Currencya3MWährung, drei Zeichen DIN / ISO 4217
MACan64OHash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: HMAC-Authentisierung (Anfrage) HMAC-Authentisierung (Notify)
ReqIDans..32OUm Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion mit derselben ReqID erneut eingereicht wird, führt das 1cs OBS keine Zahlung aus sondern gibt nur den Status der ursprünglichen Transaktion zurück. Bitte beachten Sie, dass das 1cs OBS für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.
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..100OWarenkorbübergreifender Rabatt. Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ Beispiel: Rabatt;1000;1900
Shippingans..100OVersandkosten Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ Beispiel: Versand;500;1900
Accountans..10OAccount-Kennung, um gesonderte (SubShops) Logins zu nutzen.
ShopSystemans..127OName des Shop-Systems
ShopSystemVersionans..127OVersionsnummer des Shop-Systems
EventTokena..2MCR für Credit (Gutschrift)

Parameter für Gutschrift einer RatePAY-Zahlung

Folgende Tabelle beschreibt die Parameter, die das 1cs Online Bezahlsystem als Antwort zurückgibt:

  • es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden
  • die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden 
ParameterFormatCNDBeschreibung
MIDans..30MHändlerID, die von der First Cash Solution vergeben wird
PayIDan32MVom 1cs Online Bezahlsystem vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien
XIDan32MVom 1cs Online Bezahlsystem vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden
TransIDans..64MTransaktionsID, die für jede Zahlung eindeutig sein muss
Statusa..50MOK oder FAILED
Descriptionans..1024MNähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus!
Coden8MFehlercode gemäß Excel-Datei 1cs Online Bezahlsystem Antwort Codes
InfoTextans..1024OEnthält einen Info-Text, der dem Kunden weitergegeben werden kann (z.B. bei Ablehnung)
ExternalMessageans..256OFehlertext von RatePAY, wenn mit dem First Cash Solution Support abgesprochen
ExternalCodeans..64OFehlercode von RatePAY, wenn mit dem First Cash Solution Support abgesprochen

Antwort-Parameter bei Gutschrift einer RatePAY-Zahlung

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

ParameterFormatCNDBeschreibung
ArtNrans..255CEindeutige Artikelnummer. Jeder Artikel im Warenkorb muss eindeutig identifizierbar sein. Entweder über ArtNr oder eine Kombination aus ArtNr und UniqueArticleNumber.
Quantityn..12MAnzahl
Categoryn..2OArtikelkategorie (nach Absprache mit RatePAY)
Itemans..255MArtikelbeschreibung
UnitPriceGrossn..12MStückpreis brutto in kleinster Währungseinheit
TaxRaten..5MSteuersatz mit 2 Nachkommastellen, z.B. 1900 für 19%
UniqueArticleNumberans..50CEindeutige Artikelnummer. Jeder Artikel im Warenkorb muss eindeutig identifizierbar sein. Entweder über ArtNr oder eine Kombination aus ArtNr und UniqueArticleNumber.
Discountn..12OArtikelbezogener Nachlass in kleinster Währungseinheit
DescriptionAdditionans..511OZusatztext für weitere Beschreibung. Kann in der Kommunikation zwischen RatePAY und dem Endkunden genutzt wer-den.

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;;180×200+C;5;1;Kissen;1000;1900;;;

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

AktionVersionBeschreibung
Capture1.0 / 2.0Standardversion ohne Rückgabe von Code
1.x / 2.xmit RefNr (gilt für alle Versionen außer 1.0)
1.1.2 / 2.1.2mit discount und shipping
Change1.0 / 2.0Standardversion ohne Rückgabe von Code
1.x / 2x.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:

ParameterFormatCNDBeschreibung
Typea..11MHEAD für Header, FOOT für Footer, RatePay für Transaktionen
Actiona..20MDer Action-Parameter definiert die Art der Transaktion: Capture (Buchung) Change (Gutschrift / Änderung)
Amountn..10MBetrag 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.
Currencya3MWährungskürzel, drei Zeichen DIN / ISO 4217
TransIDans..64MTransaktionsID, die für jede Zahlung eindeutig sein muss
RefNrans..30Oeindeutige Referenznummer Es sind ausschließlich ASCII-Zeichen erlaubt. Sonderzeichen wie („Umlaute“, …) sind nicht erlaubt und müssen ggf. durch ASCII-Zeichen ersetzt werden (z.B. ü → ue, é → e, …).
PayIDan32MVom 1cs Online Bezahlsystem vergebene ID für diese Transaktion
ShoppingBasketans..1024MWarenkorb (Aufbau siehe Tabelle ShoppingBasket)
ShoppingBasketAmountn..10MGesamtwert des aktuellen Warenkorbs in kleinster Währungseinheit (abzüglich Rabatte, inkl. Versand u.a.)
EventTokena..2MR 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)
RPMethodans..10CZahlungsweise: INVOICE, INSTALLMENT oder ELV. Wird bei Buchung (Capture) nicht benötigt!
Discountans..100OWarenkorbübergreifender Rabatt Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ Beispiel: Rabatt;1000;1900
Shippingans..100OVersandkosten 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):

ParameterFormatCNDBeschreibung
Actiona..20MDer Action-Parameter definiert die Art der Transaktion: Capture (Buchung) Change (Gutschrift / Änderung)
PayIDan32MVom 1cs Online Bezahlsystem vergebene ID für diese Transaktion
Statusa..50MOK oder FAILED
Coden8MFehlercode gemäß 1cs Online Bezahlsystem Antwort Codes (Fehlercodes)

Beschreibung der Ergebnis-Parameter im Datensatz von Batch-Dateien