Über Ratepay

Allgemeines zu Ratepay

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.

Typ

Zahlungen per Rechnungs- und Ratenkauf

Ratepay ist ein Whitelabel-Online-Dienstleister, der Händlern ermöglicht, ihren Kunden sichere und gängige Zahlungsmethoden anzubieten. Ratepay unterstützt folgende Zahlungsmethoden:

Rechnung – Mit der Zahlungsmethode Rechnung können Kunden Waren oder Dienstleistungen auf Rechnung kaufen und später bezahlen. Bei Zahlung per Rechnung erhalten Kunden eine Rechnung mit detaillierten Angaben zu Betrag, Zahlungsbedingungen und Fälligkeitsdatum.
Wenn ein Kunde an der Kasse Rechnung wählt, führt Ratepay eine Risikoprüfung in Echtzeit aus. Der Vorteil der Zahlungsmethode Rechnung liegt in der Verbesserung des Cashflows sowohl für Käufer als auch für Händler:
- für Käufer: Sie können Waren oder Dienstleistungen erwerben, ohne sofort bezahlen zu müssen, was sich positiv auf ihre Finanzen auswirkt.
- für Händler: Mit Ratepay profitieren Sie als Händler von einem umfassenden Service für den Rechnungskauf. Sie übermitteln alle Rechnungsdaten während der Bestellung an Ratepay, das die komplette Rechnungsstellung und das Debitorenmanagement übernimmt. Als Händler erhalten Sie eine Zahlungsgarantie.
SEPA-Lastschrift – Ratepay bietet sowohl den klassischen Ratenkauf als auch das SEPA-Lastschriftverfahren an. Das SEPA-Lastschriftverfahren ist eine Zahlungsmethode, die es Händlern ermöglicht, Zahlungen von Käufern, die ihnen die entsprechende Erlaubnis erteilt haben, direkt von deren Bankkonto über deren IBAN einzuziehen.

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

Diagramm zum Prozessablauf

Ratepay Prozessablauf

Erste Schritte

Um Ratepay-Zahlungsmethoden zu akzeptieren, registrieren Sie sich zunächst bei Ratepay.
Nach der Registrierung erhalten Sie von Ratepay die folgenden Informationen:
1. Client-ID: Benutzername für die Verbindung zur Ratepay-API
2. Client-Geheimnis: Passwort für die Verbindung zur Ratepay-API
3. Partner Shop ID: Die Ihnen von Ratepay zugewiesene eindeutige Kennung
Wenden Sie sich an den , um Ratepay als Zahlungsmethode zu aktivieren, und geben Sie die oben genannten Daten sicher an.

-Schnittstelle

Ratepay-Zahlung auslösen

Sobald der Kunde zur Kasse geht, wird eine Liste der verfügbaren Ratepay-Zahlungsmethoden angezeigt. Sobald der Kunde mit der Ratepay-Zahlungsmethode bezahlt, muss Ihr Backend einen Server-zu-Server-Aufruf an die folgende URL senden, um eine Zahlungsanforderung zu stellen:

ratepay.aspx

Key	Format	CND	Beschreibung
OrderDesc	ans..768	O	Beschreibung der gekauften Waren
bdFirstName	ans..100	C	Vorname des Kunden, dem die Rechnung ausgestellt wird. Bei B2B-Transaktionen sollte dies die Kontaktperson im Unternehmen sein. Erforderlich für B2C. Optional für B2B.
bdLastName	ans..100	C	Nachname des Kunden, dem die Rechnung ausgestellt wird. Bei B2B-Transaktionen sollte dies die Kontaktperson im Unternehmen sein. Erforderlich für B2C. Optional für B2B.
bdStreet	ans..100	M	Straßenname der Rechnungsadresse
bdStreetNr	ans..30	O	Hausnummer der Rechnungsadresse
bdStreetAddition	ans..50	O	Zusätzliche Informationen zur Rechnungsadresse
bdCity	ans..100	M	Ort der Rechnungsadresse
bdCountryCode	ans..2	M	Ländercode der Rechnungsadresse
bdZIP	ans..10	M	Postleitzahl der Rechnungsadresse
Title	ans..45	O	Titel des Kunden
DateOfBirth	ans..10	C	Geburtsdatum des Kunden im Format JJJJ-MM-TT. Erforderlich für B2C.
bdCompanyName	ans..100	C	Firmenname. Erforderlich für B2B-Transaktionen.
VatID	ans..25	O	Umsatzsteuer-Identifikationsnummer des Unternehmens. Relevant für B2B-Transaktionen.
Email	ans..100	M	E-Mail-Adresse des Kunden
Phone	ans..60	M	Telefonnummer des Kunden
Language	ans..2	O	Die Sprache, in der der Käufer die Kommunikation bevorzugt. Wird die gewünschte Sprache nicht unterstützt, erfolgt die Kommunikation mit dem Käufer auf Deutsch. Muss ISO 639-1 alpha 2 entsprechen.
CustomerID	an..100	O	Eindeutige Kunden-ID aus Ihrem System
sdFirstName	ans..100	C	Vorname in der Lieferadresse. Bei B2B-Geschäften sollte es der Ansprechpartner im Unternehmen sein.
sdLastName	ans..100	C	Nachname in der Lieferadresse. Bei B2B-Geschäften sollte es der Ansprechpartner im Unternehmen sein.
sdCompanyName	ans..100	C	Firmenname
sdStreet	ans..100	M	Straßenname der Lieferadresse
sdStreetHouseNumber	ans..30	O	Hausnummer der Lieferadresse
sdStreetAddition	ans..50	O	Zusätzliche Informationen zur Lieferadresse
sdCity	ans..100	M	Ort der Lieferadresse
sdCountryCode	ans..2	M	Ländercode der Lieferadresse
sdZIPCode	ans..10	M	Postleitzahl der Lieferadresse
IPAddr	ans..39	O	IP-Adresse des Kundengeräts
DeviceToken	ans..255	O	Geräte-Token
Channel	enum	O	Der Vertriebskanal, aus dem die Transaktion stammt: „WEBSHOP“, „POINT_OF_SALE“, „PHONE_OR_MAIL“
BIC	ans..50	O	Bankleitzahl
IBAN	ans..34	C	Internationale Bankkontonummer. Obligatorisch, wenn DebitPayType SEPA_DIRECT_DEBIT ist.
AccOwner	ans..100	C	Name des Kontoinhabers. Obligatorisch, wenn DebitPayType SEPA_DIRECT_DEBIT ist.
RPMethod	enum	M	Die vom Käufer gewählte Zahlungsoption: „OPEN_INVOICE“, „PAY_NOW“
DebitPayType	enum	M	Die vom Käufer gewählte Überweisungsart: „BANK_TRANSFER“, „SEPA_DIRECT_DEBIT“
shoppingBasket	JSON	M	Warenkorb. Informationen zur Struktur finden Sie weiter unten bei Shopping Basket. Muss Base64-kodiert gesendet werden.

Parameter für Ratepay-Zahlungen

Key	Format	CND	Beschreibung
AuthorizationExpiry	dttm	C	Datum und Uhrzeit der automatischen Stornierung des verbleibenden, nicht stornierten und nicht gebuchten autorisierten Betrags. Zeitstempel mit Offset gemäß ISO 8601. Nur für erfolgreiche HTTP 201-Antworten verfügbar.
BankName	ans..127	C	Bankname des Bankkontos, auf das der Kunde das Geld überweisen muss. Wird nur bereitgestellt, wenn DebitPayType in der Anfrage als BANK_TRANSFER gesendet wird.
BIC	ans..50	C	BIC des Bankkontos, auf das der Kunde das Geld überweisen muss. Wird nur bereitgestellt, wenn DebitPayType in der Anfrage als BANK_TRANSFER gesendet wird.
IBAN	ans..34	C	IBAN des Bankkontos, auf das der Kunde das Geld überweisen muss. Wird nur bereitgestellt, wenn DebitPayType in der Anfrage als BANK_TRANSFER gesendet wird.
AccOwner	ans..100	C	Kontoinhaber des Bankkontos, auf das der Kunde das Geld überweisen muss. Wird nur bereitgestellt, wenn DebitPayType in der Anfrage als BANK_TRANSFER gesendet wird.
RatepayPaymentReference	ans..127	C	Anzugebender Zweck in der Überweisung (von Ratepay generiert). Wird nur bereitgestellt, wenn DebitPayType in der Anfrage als BANK_TRANSFER gesendet wird.
ExternalDeclineCategory	ans..	C	Ablehungskategorie. Details finden Sie unter Decline Categories.
ExternalMessage	ans..256	C	Eine Meldung, die beschreibt, welche Einschränkung verletzt wurde
ExternalCodes	ans..64	C	Liste mit keinem, einem oder mehreren Ablehnungsgründen für die Anfrage. Unter Decline Categories finden Sie Informationen zu möglichen Gründen für jede Ablehnungskategorie.
RPTransID	ans..50	M	ID der von Ratepay während der Autorisierung generierten Transaktion. Sowohl für akzeptierte als auch für abgelehnte Transaktionen wird eine Transaktions-ID generiert.

Antwort-Parameter für Ratepay-Zahlungen

Inkrementelle Autorisierung

Diese Funktion erhöht den Betrag einer zuvor autorisierten Transaktion. Sie können den ursprünglich autorisierten Betrag maximal um 30 % oder um 300 € erhöhen, je nachdem, welcher Betrag niedriger ist. Sie können für die ursprüngliche Transaktion nur eine zusätzliche Autorisierungsanfrage senden. Um eine Zahlungstransaktion mit Ratepay zu erhöhen, verwenden Sie bitte die folgende URL:

increment.aspx

Key	Format	CND	Beschreibung
items	JSON	O	Artikelliste. Die Struktur finden Sie unten bei Shopping Basket, nur der Artikelteil. Muss Base64-kodiert gesendet werden.
vats	JSON	O	MwSt.-Informationen. Die Struktur finden Sie unten bei Shopping Basket, nur der MwSt.-Teil. Muss Base64-kodiert gesendet werden.

Parameter für die Erhöhung von Ratepay-Zahlungen

Key	Format	CND	Beschreibung
ExternalDeclineCategory	ans..	C	Ablehungskategorie. Details finden Sie unter Decline Categories.
ExternalMessage	ans..256	C	Eine Meldung, die beschreibt, welche Einschränkung verletzt wurde
ExternalCodes	ans..64	C	Liste mit keinem, einem oder mehreren Ablehnungsgründen für die Anfrage. Unter Decline Categories finden Sie Informationen zu möglichen Gründen für jede Ablehnungskategorie.
RPTransID	ans..50	M	Von Ratepay generierte ID der bestätigten Autorisierung

Antwort-Parameter für die Erhöhung von Ratepay-Zahlungen

Ratepay-Zahlung buchen

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

capture.aspx

Key	Format	CND	Beschreibung
TransID	ans..64	O	Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Key	Format	CND	Beschreibung
items	JSON	O	Artikelliste. Die Struktur finden Sie unten bei Shopping Basket, nur der Artikelteil. Muss Base64-kodiert gesendet werden.
vats	JSON	O	MwSt.-Informationen. Die Struktur finden Sie unten bei Shopping Basket, nur der MwSt.-Teil. Muss Base64-kodiert gesendet werden.

Parameter zum Buchen einer Ratepay-Zahlung

Key	Format	CND	Beschreibung
TransID	ans..64	O	Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Key	Format	CND	Beschreibung
ExternalDeclineCategory	ans..	C	Ablehungskategorie. Details finden Sie unter Decline Categories.
ExternalMessage	ans..256	C	Eine Meldung, die beschreibt, welche Einschränkung verletzt wurde
ExternalCodes	ans..64	C	Liste mit keinem, einem oder mehreren Ablehnungsgründen für die Anfrage. Unter Decline Categories finden Sie Informationen zu möglichen Gründen für jede Ablehnungskategorie.
RPCaptureID	ans..50	M	ID der von Ratepay zur Buchung generierten Transaktion

Antwort-Parameter beim Buchen einer Ratepay-Zahlung

Storno / Rückgabe von Ratepay-Zahlungen

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

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

Key	Format	CND	Beschreibung
TransID	ans..64	O	Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Key	Format	CND	Beschreibung
items	JSON	O	Artikelliste. Die Struktur finden Sie unten bei Shopping Basket, nur der Artikelteil. Muss Base64-kodiert gesendet werden.
vats	JSON	O	MwSt.-Informationen. Die Struktur finden Sie unten bei Shopping Basket, nur der MwSt.-Teil. Muss Base64-kodiert gesendet werden.

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

Key	Format	CND	Beschreibung
TransID	ans..64	O	Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Key	Format	CND	Beschreibung
ExternalDeclineCategory	ans..	C	Ablehungskategorie. Details finden Sie unter Decline Categories.
ExternalMessage	ans..256	C	Eine Meldung, die beschreibt, welche Einschränkung verletzt wurde
ExternalCodes	ans..64	C	Liste mit keinem, einem oder mehreren Ablehnungsgründen für die Anfrage. Unter Decline Categories finden Sie Informationen zu möglichen Gründen für jede Ablehnungskategorie.
RPCancellationID	ans..50	M	ID der von Ratepay zur Stornierung generierten Transaktion

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

Gutschrift von Ratepay-Zahlungen

Um eine Zahlungstransaktion mit Ratepay gutzuschreiben, verwenden Sie bitte folgende URL:

credit.aspx

Key	Format	CND	Beschreibung
TransID	ans..64	O	Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Key	Format	CND	Beschreibung
items	JSON	O	Artikelliste. Die Struktur finden Sie unten bei Shopping Basket, nur der Artikelteil. Muss Base64-kodiert gesendet werden.
vats	JSON	O	MwSt.-Informationen. Die Struktur finden Sie unten bei Shopping Basket, nur der MwSt.-Teil. Muss Base64-kodiert gesendet werden.

Parameter für Gutschrift einer Ratepay-Zahlung

Key	Format	CND	Beschreibung
TransID	ans..64	O	Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Key	Format	CND	Beschreibung
ExternalDeclineCategory	ans..	C	Ablehungskategorie. Details finden Sie unter Decline Categories.
ExternalMessage	ans..256	C	Eine Meldung, die beschreibt, welche Einschränkung verletzt wurde
ExternalCodes	ans..64	C	Liste mit keinem, einem oder mehreren Ablehnungsgründen für die Anfrage. Unter Decline Categories finden Sie Informationen zu möglichen Gründen für jede Ablehnungskategorie.
RPRefundID	ans..50	M	ID der von Ratepay zur Gutschrift generierten Transaktion

Antwort-Parameter bei Gutschrift einer Ratepay-Zahlung

Erläuterung zum Parameter ShoppingBasket

Folgende Tabelle beschreibt die einzelnen Werte innerhalb des ShoppingBasket:

Key	Format	CND	Beschreibung
shoppingBasketAmount	n..10	M	Der Warenkorbbetrag inklusive Mehrwertsteuer in der Währung der Transaktion. shoppingBasketAmount = Summe aller Artikel für ((unitPriceGross+discount) * quantity). Hinweis: Da der Rabatt ein negativer Betrag ist, wird durch die obige Addition der Rabatt tatsächlich vom unitPriceGross abgezogen.
items.artNr	ans..255	O	Artikelnummer des Artikels, z. B. SKU. Sie darf nicht ausschließlich Leerzeichen enthalten.
items.category	ans..511	O	Kategorie für den Artikel
items.descriptionAddition	ans	O	Beschreibung des Artikels
items.discount	ans	O	Bruttorabatt auf einen Artikel nach Steuern. Das muss ein negativer Wert sein. Beispiel: Für einen Rabatt von 20,55 geben Sie -2055 ein.
items.name	string	M	Name des Artikels
items.unitPriceGross	n..10	M	Bruttowert eines Artikels nach Steuern. Für einem Wert von 100,00 € geben Sie 10000 ein.
items.quantity	n..	M	Bestellte Menge des Artikels
items.taxRate	decimal	M	Für den Artikel geltender Steuersatz in Prozent. Geben Sie diesen Wert mit maximal zwei Dezimalstellen an. Zum Beispiel sollte 15,55 % als 15,55 angegeben werden.
items.unit	ans..255	O	Beliebige Maßeinheit des Artikels, z.B. kg, Liter, Stück
vats.netAmount	n..10	M	Betrag vor Steuern für alle Artikel
vats.taxAmount	n..10	M	Gesamtsteuerbetrag für alle Artikel zum angegebenen Steuersatz. Für einen Wert von 100,00 geben Sie 10000 ein.
vats.taxRate	decimal	M	Steuersatz als Prozentsatz auf den Nettobetrag. Geben Sie diesen Wert mit maximal zwei Dezimalstellen an. Beispielsweise sollte 15,55 % als 15,55 gesendet werden.

Parameter innerhalb des Warenkorbes