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

TypZahlungen 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

  1. Um Ratepay-Zahlungsmethoden zu akzeptieren, registrieren Sie sich zunächst bei Ratepay.
  2. 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
  3. Wenden Sie sich an den Computop Helpdesk, um Ratepay als Zahlungsmethode zu aktivieren, und geben Sie die oben genannten Daten sicher an.


Paygate-Schnittstelle

Definitionen

Datenformate

FormatBeschreibung

a

alphabetisch

as

alphabetisch mit Sonderzeichen

n

numerisch

an

alphanumerisch

ans

alphanumerisch mit Sonderzeichen

ns

numerisch mit Sonderzeichen

bool

Bool’scher Ausdruck (true oder false)

3

feste Länge mit 3 Stellen/Zeichen

..3

variable Länge mit maximal 3 Stellen/Zeichen

enum

Aufzählung erlaubter Werte

dttm

ISODateTime (JJJJ-MM-TTThh:mm:ss)


Abkürzungen

AbkürzungBeschreibungKommentar

CND

Bedingung (condition)


M

Pflicht (mandatory)

Wenn ein Parameter Pflicht ist, dann muss er vorhanden sein

O

optional

Wenn ein Parameter optional ist, dann kann er vorhanden sein, ist aber nicht erforderlich

C

bedingt (conditional)

Wenn ein Parameter bedingt ist, dann gibt es eine Bedingungsregel, die angibt, ob er Pflicht oder optional ist


Hinweis: Bitte beachten Sie, dass die Bezeichnungen der Parameter in Groß- oder Kleinbuchstaben zurückgegeben werden können.


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

 

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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

KeyFormatCNDBeschreibung

MerchantID

ans..30

M

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

KeyFormatCNDBeschreibung
TransID

ans..64

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

KeyFormatCNDBeschreibung
refnr

ans..30

O

Eindeutige Referenznummer des Händlers

KeyFormatCNDBeschreibung
Amount

n..10

M

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

KeyFormatCNDBeschreibung
Currency

a3

M

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

KeyFormatCNDBeschreibung
ReqId

ans..32

O

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

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

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

Key

Format

CND

Beschreibung

OrderDescans..768OBeschreibung der gekauften Waren
bdFirstNameans..100CVorname 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.
bdLastNameans..100CNachname 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.
bdStreetans..100MStraßenname der Rechnungsadresse
bdStreetNrans..30OHausnummer der Rechnungsadresse
bdStreetAdditionans..50OZusätzliche Informationen zur Rechnungsadresse
bdCityans..100MOrt der Rechnungsadresse
bdCountryCodeans..2MLändercode der Rechnungsadresse
bdZIPans..10MPostleitzahl der Rechnungsadresse
Titleans..45OTitel des Kunden
DateOfBirthans..10CGeburtsdatum des Kunden im Format JJJJ-MM-TT. Erforderlich für B2C.
bdCompanyNameans..100CFirmenname. Erforderlich für B2B-Transaktionen.
VatIDans..25OUmsatzsteuer-Identifikationsnummer des Unternehmens. Relevant für B2B-Transaktionen.
Emailans..100ME-Mail-Adresse des Kunden
Phoneans..60MTelefonnummer des Kunden
Languageans..2ODie 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.
CustomerIDan..100OEindeutige Kunden-ID aus Ihrem System
sdFirstNameans..100CVorname in der Lieferadresse. Bei B2B-Geschäften sollte es der Ansprechpartner im Unternehmen sein.
sdLastNameans..100CNachname in der Lieferadresse. Bei B2B-Geschäften sollte es der Ansprechpartner im Unternehmen sein.
sdCompanyNameans..100CFirmenname
sdStreetans..100MStraßenname der Lieferadresse
sdStreetHouseNumberans..30OHausnummer der Lieferadresse
sdStreetAdditionans..50OZusätzliche Informationen zur Lieferadresse
sdCityans..100MOrt der Lieferadresse
sdCountryCodeans..2MLändercode der Lieferadresse
sdZIPCodeans..10MPostleitzahl der Lieferadresse
IPAddrans..39OIP-Adresse des Kundengeräts
DeviceTokenans..255OGeräte-Token
ChannelenumODer Vertriebskanal, aus dem die Transaktion stammt: „WEBSHOP“, „POINT_OF_SALE“, „PHONE_OR_MAIL“
BICans..50OBankleitzahl
IBANans..34CInternationale Bankkontonummer. Obligatorisch, wenn DebitPayType SEPA_DIRECT_DEBIT ist.
AccOwnerans..100CName des Kontoinhabers. Obligatorisch, wenn DebitPayType SEPA_DIRECT_DEBIT ist.
RPMethodenumMDie vom Käufer gewählte Zahlungsoption: „OPEN_INVOICE“, „PAY_NOW“
DebitPayTypeenumMDie vom Käufer gewählte Überweisungsart: „BANK_TRANSFER“, „SEPA_DIRECT_DEBIT“
shoppingBasket JSONMWarenkorb. Informationen zur Struktur finden Sie weiter unten bei Shopping Basket. Muss Base64-kodiert gesendet werden.

Parameter für Ratepay-Zahlungen


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

(info) es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

(info) die Parameter (z.B. mid, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

KeyFormatCNDBeschreibung

mid

ans..30

M

HändlerID, die von Computop vergeben wird

KeyFormatCNDBeschreibung
PayID

an32

M

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

KeyFormatCNDBeschreibung
XID

an32

M

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

KeyFormatCNDBeschreibung
TransID

ans..64

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

KeyFormatCNDBeschreibung
Status

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDBeschreibung
refnr

ans..30

O

Eindeutige Referenznummer des Händlers

Key

Format

CND

Beschreibung

AuthorizationExpirydttmCDatum 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.
BankNameans..127CBankname des Bankkontos, auf das der Kunde das Geld überweisen muss. Wird nur bereitgestellt, wenn DebitPayType in der Anfrage als BANK_TRANSFER gesendet wird.
BICans..50CBIC des Bankkontos, auf das der Kunde das Geld überweisen muss. Wird nur bereitgestellt, wenn DebitPayType in der Anfrage als BANK_TRANSFER gesendet wird.
IBANans..34CIBAN des Bankkontos, auf das der Kunde das Geld überweisen muss. Wird nur bereitgestellt, wenn DebitPayType in der Anfrage als BANK_TRANSFER gesendet wird.
AccOwnerans..100CKontoinhaber des Bankkontos, auf das der Kunde das Geld überweisen muss. Wird nur bereitgestellt, wenn DebitPayType in der Anfrage als BANK_TRANSFER gesendet wird.
RatepayPaymentReferenceans..127CAnzugebender 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.
ExternalMessageans..256C

Eine Meldung, die beschreibt, welche Einschränkung verletzt wurde

ExternalCodesans..64C

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.

RPTransIDans..50M

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:

 

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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

KeyFormatCNDBeschreibung

MerchantID

ans..30

M

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

KeyFormatCNDBeschreibung
PayID

an32

M

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

KeyFormatCNDBeschreibung
TransID

ans..64

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

KeyFormatCNDBeschreibung
refnr

ans..30

O

Eindeutige Referenznummer des Händlers

KeyFormatCNDBeschreibung
Amount

n..10

M

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

KeyFormatCNDBeschreibung
Currency

a3

M

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

Key

Format

CND

Beschreibung

itemsJSONOArtikelliste. Die Struktur finden Sie unten bei Shopping Basket, nur der Artikelteil. Muss Base64-kodiert gesendet werden.
vatsJSONOMwSt.-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


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

(info) es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

(info) die Parameter (z.B. mid, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

KeyFormatCNDBeschreibung

mid

ans..30

M

HändlerID, die von Computop vergeben wird

KeyFormatCNDBeschreibung
PayID

an32

M

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

KeyFormatCNDBeschreibung
XID

an32

M

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

KeyFormatCNDBeschreibung
TransID

ans..64

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

KeyFormatCNDBeschreibung
Status

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDBeschreibung
refnr

ans..30

O

Eindeutige Referenznummer des Händlers

Key

Format

CND

Beschreibung

ExternalDeclineCategory

ans..

C

Ablehungskategorie. Details finden Sie unter Decline Categories.
ExternalMessageans..256C

Eine Meldung, die beschreibt, welche Einschränkung verletzt wurde

ExternalCodesans..64C

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.

RPTransIDans..50M

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:

 

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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

KeyFormatCNDBeschreibung

MerchantID

ans..30

M

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

KeyFormatCNDBeschreibung
PayID

an32

M

Vom Paygate vergebene ID für die zu buchende Zahlung

Key

Format

CND

Beschreibung

TransIDans..64OIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDBeschreibung
refnr

ans..30

O

Eindeutige Referenznummer des Händlers

KeyFormatCNDBeschreibung
Amount

n..10

M

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

KeyFormatCNDBeschreibung
Currency

a3

M

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

Key

Format

CND

Beschreibung

itemsJSONOArtikelliste. Die Struktur finden Sie unten bei Shopping Basket, nur der Artikelteil. Muss Base64-kodiert gesendet werden.
vatsJSONOMwSt.-Informationen. Die Struktur finden Sie unten bei Shopping Basket, nur der MwSt.-Teil. Muss Base64-kodiert gesendet werden.

Parameter zum Buchen einer Ratepay-Zahlung


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

(info) es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

(info) die Parameter (z.B. mid, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

KeyFormatCNDBeschreibung

mid

ans..30

M

HändlerID, die von Computop vergeben wird

KeyFormatCNDBeschreibung
PayID

an32

M

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

KeyFormatCNDBeschreibung
XID

an32

M

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

Key

Format

CND

Beschreibung

TransIDans..64OIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDBeschreibung
Status

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDBeschreibung
refnr

ans..30

O

Eindeutige Referenznummer des Händlers

Key

Format

CND

Beschreibung

ExternalDeclineCategory

ans..

C

Ablehungskategorie. Details finden Sie unter Decline Categories.
ExternalMessageans..256C

Eine Meldung, die beschreibt, welche Einschränkung verletzt wurde

ExternalCodesans..64C

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.

RPCaptureIDans..50M

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:

 

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

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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

KeyFormatCNDBeschreibung

MerchantID

ans..30

M

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

KeyFormatCNDBeschreibung
PayID

an32

M

Vom Paygate vergebene ID für die zu stornierende Zahlung

Key

Format

CND

Beschreibung

TransIDans..64OIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDBeschreibung
refnr

ans..30

O

Eindeutige Referenznummer des Händlers

KeyFormatCNDBeschreibung
Amount

n..10

M

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

KeyFormatCNDBeschreibung
Currency

a3

M

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

Key

Format

CND

Beschreibung

itemsJSONOArtikelliste. Die Struktur finden Sie unten bei Shopping Basket, nur der Artikelteil. Muss Base64-kodiert gesendet werden.
vatsJSONOMwSt.-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


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

(info) es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

(info) die Parameter (z.B. mid, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

KeyFormatCNDBeschreibung

mid

ans..30

M

HändlerID, die von Computop vergeben wird

KeyFormatCNDBeschreibung
PayID

an32

M

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

KeyFormatCNDBeschreibung
XID

an32

M

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

Key

Format

CND

Beschreibung

TransIDans..64OIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDBeschreibung
Status

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDBeschreibung
refnr

ans..30

O

Eindeutige Referenznummer des Händlers

Key

Format

CND

Beschreibung

ExternalDeclineCategory

ans..

C

Ablehungskategorie. Details finden Sie unter Decline Categories.
ExternalMessageans..256C

Eine Meldung, die beschreibt, welche Einschränkung verletzt wurde

ExternalCodesans..64C

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.

RPCancellationIDans..50M

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:

 

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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

KeyFormatCNDBeschreibung

MerchantID

ans..30

M

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

KeyFormatCNDBeschreibung
PayID

an32

M

Vom Paygate vergebene ID für die gutzuschreibende Zahlung

Key

Format

CND

Beschreibung

TransIDans..64OIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDBeschreibung
refnr

ans..30

O

Eindeutige Referenznummer des Händlers

KeyFormatCNDBeschreibung
Amount

n..10

M

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

KeyFormatCNDBeschreibung
Currency

a3

M

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

Key

Format

CND

Beschreibung

itemsJSONOArtikelliste. Die Struktur finden Sie unten bei Shopping Basket, nur der Artikelteil. Muss Base64-kodiert gesendet werden.
vatsJSONOMwSt.-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


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

(info) es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

(info) die Parameter (z.B. mid, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

KeyFormatCNDBeschreibung

mid

ans..30

M

HändlerID, die von Computop vergeben wird

KeyFormatCNDBeschreibung
PayID

an32

M

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

KeyFormatCNDBeschreibung
XID

an32

M

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

Key

Format

CND

Beschreibung

TransIDans..64OIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDBeschreibung
Status

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDBeschreibung
refnr

ans..30

O

Eindeutige Referenznummer des Händlers

Key

Format

CND

Beschreibung

ExternalDeclineCategory

ans..

C

Ablehungskategorie. Details finden Sie unter Decline Categories.
ExternalMessageans..256C

Eine Meldung, die beschreibt, welche Einschränkung verletzt wurde

ExternalCodesans..64C

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.

RPRefundIDans..50M

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

shoppingBasketAmountn..10MDer 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.artNrans..255OArtikelnummer des Artikels, z. B. SKU. Sie darf nicht ausschließlich Leerzeichen enthalten.
items.categoryans..511OKategorie für den Artikel
items.descriptionAdditionansOBeschreibung des Artikels
items.discountansOBruttorabatt auf einen Artikel nach Steuern. Das muss ein negativer Wert sein. Beispiel: Für einen Rabatt von 20,55 geben Sie -2055 ein.
items.namestringMName des Artikels
items.unitPriceGrossn..10MBruttowert eines Artikels nach Steuern. Für einem Wert von 100,00 € geben Sie 10000 ein.
items.quantityn..MBestellte Menge des Artikels
items.taxRatedecimalMFü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.unitans..255OBeliebige Maßeinheit des Artikels, z.B. kg, Liter, Stück
vats.netAmountn..10MBetrag vor Steuern für alle Artikel
vats.taxAmountn..10MGesamtsteuerbetrag für alle Artikel zum angegebenen Steuersatz. Für einen Wert von 100,00 geben Sie 10000 ein.
vats.taxRatedecimalM

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


[
    {
        "shoppingBasketAmount": 7350,
        "items": [
            {
                "artNr": 37,
                "category": "Electronics",
                "descriptionAddition": "desc 1",
                "discount": -50,
                "name": "High-performance laptop",
                "unitPriceGross": 2500,
                "quantity": 1,
                "taxRate": 0.04,
                "unit": "pcs"
            },
            {
                "artNr": 38,
                "category": "Accessories",
                "descriptionAddition": "desc 1",
                "discount": -50,
                "name": "Wireless gaming mouse",
                "unitPriceGross": 2500,
                "quantity": 2,
                "taxRate": 0.04,
                "unit": "pcs"
            }
        ],
        "vats": [
            {
                "netAmount": 7200,
                "taxAmount": 300,
                "taxRate": 0.04
            }
        ]
    }
]