Ratepay

Logo

Info

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

Typ

Zahlungen per Rechnungs- und Ratenkauf

Format

Beschreibung

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ürzung

Beschreibung

Kommentar

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

Computop request

Ratepay request

Beschreibung

INIT / Authorize

PAYMENT_INIT

(PAYMENT_QUERY)

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

EventToken = A

Create payment

(Authorize step 1)

PAYMENT_REQUEST

Initialisiert einen Raten- bzw. Rechnungskauf

EventToken = R

Verify

(Authorize step 2)

PAYMENT_CONFIRM

Bestätigt die Initialisierung erneut.

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

EventToken = V

Order change

(before capture)

PAYMENT_CHANGE

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

- Vollstornierung / EventToken = FC

-Teilstornierung / EventToken = PC

-Auftragsänderung / EventToken = CO

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

Order change

(after capture)

PAYMENT_CHANGE

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

-Vollrückgabe / EventToken = FR

-Teilrückgabe / EventToken = PR

-Gutschrift / EventToken = CR

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

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

refnr

ans..30

O

Eindeutige Referenznummer des Händlers

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.

Currency

a3

M

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

MAC

an64

M

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

• HMAC-Authentisierung (Anfrage)

• HMAC-Authentisierung (Notify)

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

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

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

Versionsname 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

ShippingProfile

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

sdZIPCode

ans..10

O

Postleitzahl

sdCity

ans..255

O

Ort

sdCountryCode

a2

O

Ländercode zweistellig gemäß ISO 3166

sdPhone

ns..32

O

Telefonnummer des Kunden

Rechnungsdaten (Prüfadresse)

bdFirstName

ans..100

M

Vorname des Kunden

bdLastName

ans..100

M

Nachname des Kunden

bdCompanyName

ans..100

O

Firmenname

bdStreet

ans..50

M

Straßenname der Rechnungsadresse

bdStreetNr

ans..10

M

Hausnummer der Rechnungsadresse

bdStreetAddition

ans..50

O

Adresszusatz der Rechnungsadresse

bdZIP

ans..10

M

Postleitzahl der Rechnungsadresse

bdCity

ans..255

M

Ort der Rechnungsadresse

bdCountryCode

a2

M

Ländercode der Rechnungsadresse zweistellig gemäß ISO 3166

bdPhone

ns..32

M

Telefonnummer des Kunden

Registrierungsadresse (B2B)

FirstName

ans..100

O

Vorname

LastName

ans..100

O

Nachname

AddrStreet

ans..50

C

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

AddrStreetNr

ans..10

C

Hausnummer. Pflicht wenn B2B (CompanyName angegeben).

AddressAddition

ans..50

O

Adresszusatz

AddrZip

ans..10

C

Postleitzahl. Pflicht wenn B2B (CompanyName angegeben).

AddrCity

ans..32

C

Ort. Pflicht wenn B2B (CompanyName angegeben).

AddrCountryCode

a2

C

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

Betrugsprävention

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

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 sowie im Capture- oder Credit-Request.

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

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

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

an8

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 Helpdesk abgesprochen

ExternalCode

ans..64

O

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

O

Eindeutige Referenznummer von Ratepay

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 sowie im Capture- oder Credit-Request.

TransID

ans..64

M

Ihre eigene 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 Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a3

M

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

MAC

an64

M

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

• HMAC-Authentisierung (Anfrage)

• HMAC-Authentisierung (Notify)

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 JJJJMMTT

DueDate

dttm8

O

Fälligkeitsdatum im Format JJJJMMTT

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

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 sowie im Capture- oder Credit-Request.

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

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

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

an8

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 Helpdesk abgesprochen

ExternalCode

ans..64

O

Fehlercode von Ratepay, wenn mit Computop Helpdesk 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.

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 sowie im Capture- oder Credit-Request.

TransID

ans..64

M

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

MAC

an64

M

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

• HMAC-Authentisierung (Anfrage)

• HMAC-Authentisierung (Notify)

EventToken

a..2

M

RC für Rateconfiguration

Account

ans..10

O

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

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 sowie im Capture- oder Credit-Request.

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

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

Status

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

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

an8

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

O

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

MinRateNormal

n..10

O

Mindestrate in der kleinsten Währungseinheit

MinRateLongrun

n..10

O

Mindestrate einer Langzeitfinanzierung in der kleinsten Währungseinheit

ServiceCharge

n..10

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 Helpdesk abgesprochen

ExternalCode

ans..64

O

Fehlercode von Ratepay, wenn mit Computop Helpdesk abgesprochen

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 sowie im Capture- oder Credit-Request.

TransID

ans..64

M

Ihre eigene 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 Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a3

M

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

MAC

an64

M

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

• HMAC-Authentisierung (Anfrage)

• HMAC-Authentisierung (Notify)

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

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

Versionsname 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

O

Bank Identifier Code

AccBank

ans..27

O

Name des Kreditinstituts

DebitPayType

a2

C

Zahlungsweise. Pflicht bei DirectDebit.

BT = BankTransfer ; DD = DirectDebit

Ratenzahlung (INSTALLMENT)

InterestRate

n..5

C

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

InstallmentNumber

n..12

C

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

InstallmentAmount

n..10

C

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

InstallmentLastAmount

n..10

C

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

FirstDay

n..2

O

Kalendertag der ersten Zahlung.

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

TotalAmount

n..10

C

Zu finanzierender Gesamtbetrag. Pflicht bei Ratenzahlung.

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 sowie im Capture- oder Credit-Request.

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

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

Status

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

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

an8

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 Helpdesk abgesprochen

ExternalCode

ans..64

O

Fehlercode von Ratepay, wenn mit Computop Helpdesk abgesprochen

RPTransID

ans..50

O

Eindeutige Referenznummer von Ratepay

Descriptor

ans..255

M

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

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 sowie im Capture- oder Credit-Request.

TransID

ans..64

M

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

MAC

an64

M

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

• HMAC-Authentisierung (Anfrage)

• HMAC-Authentisierung (Notify)

Account

ans..10

O

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

EventToken

a..2

M

V für verify

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 sowie im Capture- oder Credit-Request.

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

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

Status

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

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

an8

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 Helpdesk abgesprochen

ExternalCode

ans..64

O

Fehlercode von Ratepay, wenn mit Computop Helpdesk abgesprochen

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 zu buchende Zahlung

TransID

ans..64

M

Ihre eigene 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 Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a3

M

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

MAC

an64

M

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

• HMAC-Authentisierung (Anfrage)

• HMAC-Authentisierung (Notify)

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.

ShoppingBasket

ans..1024

M

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

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

ShippingProfile

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

O

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

Versionsname des Shop-Systems

EventToken

a..2

M

C für Capture (Buchung)

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 sowie im Capture- oder Credit-Request.

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

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

Status

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

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

an8

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 Helpdesk abgesprochen

ExternalCode

ans..64

O

Fehlercode von Ratepay, wenn mit Computop Helpdesk abgesprochen

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 sowie im Capture- oder Credit-Request.

TransID

ans..64

M

Ihre eigene 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 Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a3

M

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

MAC

an64

M

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

• HMAC-Authentisierung (Anfrage)

• HMAC-Authentisierung (Notify)

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.

RPMethod

ans..10

M

Zahlungsweise: INVOICE, INSTALLMENT oder ELV

ShoppingBasket

ans..1024

C

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

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

ShoppingBasketAmount

n..10

C

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

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

Discount

ans..100

O

Warenkorbübergreifender Rabatt.

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Rabatt;1000;1900

ShippingProfile

ans..100

O

Versandkosten

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Versand;500;1900

Account

ans..10

O

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

ShopSystem

ans..127

O

Name des Shop-Systems

ShopSystemVersion

ans..127

O

Versionsname 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

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 sowie im Capture- oder Credit-Request.

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

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

Status

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

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

an8

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 Helpdesk abgesprochen

ExternalCode

ans..64

O

Fehlercode von Ratepay, wenn mit Computop Helpdesk abgesprochen

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 gutzuschreibende Zahlung

TransID

ans..64

M

Ihre eigene 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 Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a3

M

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

MAC

an64

M

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

• HMAC-Authentisierung (Anfrage)

• HMAC-Authentisierung (Notify)

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.

ShoppingBasket

ans..1024

M

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

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

ShippingProfile

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

Versionsname des Shop-Systems

EventToken

a..2

M

CR für Credit (Gutschrift)

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 sowie im Capture- oder Credit-Request.

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

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

Status

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

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

an8

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 Helpdesk abgesprochen

ExternalCode

ans..64

O

Fehlercode von Ratepay, wenn mit Computop Helpdesk abgesprochen

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.

Action

Version

Beschreibung

Capture

1.0 / 2.0

Standardversion ohne Rückgabe von Parameter Code

1.x / 2.x

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

1.1.2 / 2.1.2

mit discount und shipping

Change

1.0 / 2.0

Standardversion ohne Rückgabe von Parameter Code

1.x / 2.x

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

1.1.2 / 2.1.2

mit discount und shipping

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 Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a3

M

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

TransID

ans..64

M

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

refnr

ans..30

O

Eindeutige Referenznummer des Händlers

PayID

an32

M

Vom Paygate vergebene ID für diese Transaktion

ShoppingBasket

ans..1024

C

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

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

EventToken

a..2

M

R für RateInit (Initialisierung)

CR für Credit (Gutschrift)

FC für full-cancellation (Vollstornierung)

PC für partial-cancellation (Teilstornierung)

CO für change-order (Änderung)

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

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

RPMethod

ans..10

C

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

Discount

ans..100

O

Warenkorbübergreifender Rabatt.

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Rabatt;1000;1900

ShippingProfile

ans..100

O

Versandkosten

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Versand;500;1900

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 (URLSuccess) oder FAILED (URLFailure)

Code

an8

M

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