You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »


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

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescription

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

KeyFormatCNDDescription
Currency

a3

M

Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

KeyFormatCNDDescription
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

Key

Format

CND

Description

OrderDescans..768ODescription of the goods purchased
bdFirstNameans..100CFirst name of the customer who is billed. For B2B transactions it should be the contact person in the company. Required for B2C. Optional for B2B.
bdLastNameans..100CLast name of the customer who is billed. For B2B transactions it should be the contact person in the company. Required for B2C. Optional for B2B.
bdStreetans..100MStreet name of the billing address
bdStreetNrans..30OHouse number of the billing address
bdStreetAdditionans..50OAdditional info of the billing address
bdCityans..100MCity of the billing address
bdCountryCodeans..2MCountry code of the billing address
bdZIPans..10MPostal code of the billing address
Titleans..45OTitle of the customer
DateOfBirthans..10CDate of birth of customer in YYYY-MM-DD format. Required for B2C.
bdCompanyNameans..100CCompany Name. Required for B2B transactions.
VatIDans..25OCompany Vat ID. Relevant for B2B transactions.
Emailans..100MEmail address of the customer
Phoneans..60MPhone number of the customer
Languageans..2OThe language in which the buyer prefers communication to be done. If the preferred language is not supported, the buyer communication will be in German. Must conform to ISO 639-1 alpha 2.
CustomerIDan..100OUnique customer ID from your system
sdFirstNameans..100CFirst name of the shipping address. For B2B transactions it should be the contact person in the company.
sdLastNameans..100CLast name of the shipping address. For B2B transactions it should be the contact person in the company.
sdCompanyNameans..100CCompany Name
sdStreetans..100MStreet name of the shipping address
sdStreetHouseNumberans..30OHouse number of the shipping address
sdStreetAdditionans..50OAdditional info of the shipping address
sdCityans..100MCity of the shipping address
sdCountryCodeans..2MCountry code of the shipping address
sdZIPCodeans..10MPostal code of the shipping address
IPAddrans..39OIP Address of the customer's device
DeviceTokenans..255ODevice token
ChannelenumOThe sales channel the transaction originates from: "WEBSHOP", "POINT_OF_SALE", "PHONE_OR_MAIL"
BICans..50OBank Identifier Code
IBANans..34CInternational Bank Account Number. Mandatory when DebitPayType is SEPA_DIRECT_DEBIT.
AccOwnerans..100CName of account holder. Mandatory when DebitPayType is SEPA_DIRECT_DEBIT.
RPMethodenumMThe payment option the buyer selected: "OPEN_INVOICE", "PAY_NOW"
DebitPayTypeenumMThe transfer type the buyer selected: "BANK_TRANSFER", "SEPA_DIRECT_DEBIT
shoppingBasket JSONMShopping basket. For structure see Shopping Basket below. Has to be sent as Base64 encoded.

Parameter für Ratepay-Zahlungen


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

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

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

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

KeyFormatCNDDescription
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

Key

Format

CND

Description

AuthorizationExpirydttmCThe date and time when remaining un-cancelled and un-captured authorized amount will be automatically cancelled. Timestamp with offset according to ISO 8601. Available only for successful responses HTTP 201.
BankNameans..127CBank name of the bank account the customer has to transfer the money to. Provided only when DebitPayType is sent as BANK_TRANSFER in request.
BICans..50CBIC of the bank account the customer has to transfer the money to. Provided only when DebitPayType is sent as BANK_TRANSFER in request.
IBANans..34CIBAN of the bank account the customer has to transfer the money to. Provided only when DebitPayType is sent as BANK_TRANSFER in request.
AccOwnerans..100CAccount owner name of the bank account the customer has to transfer the money to. Provided only when DebitPayType is sent as BANK_TRANSFER in request.
RatepayPaymentReferenceans..127CPurpose to be indicated in the bank transfer (generated by Ratepay). Provided only when DebitPayType is sent as BANK_TRANSFER in request.

ExternalDeclineCategory

ans..

C

Decline category. See Decline Categories for details.

ExternalMessageans..256C

A message describing which constraint was violated

ExternalCodesans..64C

List of none, one or multiple reasons why the request was declined. See Decline Categories to learn about possible reasons for each decline category.

RPTransIDans..50M

ID of transaction generated by Ratepay during authorization. A transaction ID is generated for both accepted and declined transactions.

Antwort-Parameter für 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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescription

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for the payment to be captured

Key

Format

CND

Description

TransIDans..64OTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

KeyFormatCNDDescription
Currency

a3

M

Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Key

Format

CND

Description

itemsJSONOItem list. For structure see Shopping Basket below, only the items part. Has to be sent as Base64 encoded.
vatsJSONOVat information. For structure see Shopping Basket below, only the vats part. Has to be sent as Base64 encoded.

Parameter zum Buchen einer Ratepay-Zahlung


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

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

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

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

KeyFormatCNDDescription
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Key

Format

CND

Description

TransIDans..64OTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

Key

Format

CND

Description

ExternalDeclineCategory

ans..

C

Decline category. See Decline Categories for details.

ExternalMessageans..256C

A message describing which constraint was violated

ExternalCodesans..64C

List of none, one or multiple reasons why the request was declined. See Decline Categories to learn about possible reasons for each decline category.

RPCaptureIDans..50M

ID of transaction generated by Ratepay for capture

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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescription

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for the payment to be reversed

Key

Format

CND

Description

TransIDans..64OTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

KeyFormatCNDDescription
Currency

a3

M

Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Key

Format

CND

Description

itemsJSONOItem list. For structure see Shopping Basket below, only the items part. Has to be sent as Base64 encoded.
vatsJSONOVat information. For structure see Shopping Basket below, only the vats part. Has to be sent as Base64 encoded.

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


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

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

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

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

KeyFormatCNDDescription
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Key

Format

CND

Description

TransIDans..64OTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

Key

Format

CND

Description

ExternalDeclineCategory

ans..

C

Decline category. See Decline Categories for details.

ExternalMessageans..256C

A message describing which constraint was violated

ExternalCodesans..64C

List of none, one or multiple reasons why the request was declined. See Decline Categories to learn about possible reasons for each decline category.

RPCancellationIDans..50M

ID of transaction generated by Ratepay for cancellation

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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescription

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for the payment to be credited

Key

Format

CND

Description

TransIDans..64OTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

KeyFormatCNDDescription
Currency

a3

M

Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Key

Format

CND

Description

itemsJSONOItem list. For structure see Shopping Basket below, only the items part. Has to be sent as Base64 encoded.
vatsJSONOVat information. For structure see Shopping Basket below, only the vats part. Has to be sent as Base64 encoded.

Parameter für Gutschrift einer Ratepay-Zahlung


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

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

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

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

KeyFormatCNDDescription
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Key

Format

CND

Description

TransIDans..64OTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

Key

Format

CND

Description

ExternalDeclineCategory

ans..

C

Decline category. See Decline Categories for details.

ExternalMessageans..256C

A message describing which constraint was violated

ExternalCodesans..64C

List of none, one or multiple reasons why the request was declined. See Decline Categories to learn about possible reasons for each decline category.

RPRefundIDans..50M

ID of transaction generated by Ratepay for credit

Antwort-Parameter bei Gutschrift einer Ratepay-Zahlung


Erläuterung zum Parameter ShoppingBasket

Folgende Tabelle beschreibt die einzelnen Werte innerhalb des ShoppingBasket:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

Format

CND

Description

shoppingBasketAmountn..10M

The amount for the basket including VAT given in the currency of the transaction. shoppingBasketAmount=Sum from all items for ((unitPriceGross+discount) * quantity). Note: Since discount is a negative amount the addition above actually subtracts the discount from unitPriceGross.

items.artNrans..255O

The article number of the item, e.g. SKU. Not allowed to contain only whitespaces.

items.categoryans..511O

Category for the item

items.descriptionAdditionansO

Description of the item

items.discountansO

Gross discount on one item after taxes. Needs to be a negative value. Example: For a discount of 20.55 pass -2055.

items.namestringM

Name of the item

items.unitPriceGrossn..10M

Gross value of one item after taxes. For a value of €100.00 pass it as 10000.

items.quantityn..M

Ordered quantity of the item

items.taxRatedecimalM

Tax rate applicable for the item given in percent. Pass this value up to 2 decimals. For example 15.55% should be sent as 15.55.

items.unitans..255O

Arbitrary measurement unit of the item, e.g. kg, litre, pieces

vats.netAmountn..10M

Amount before taxes for all items

vats.taxAmountn..10M

Total tax amount for all the items for the given tax rate. For a value of 100.00 pass 10000.

vats.taxRatedecimalM

Tax rate given as percentage on the net amount. Pass this value up to 2 decimals. For example 15.55% should be sent as 15.55.

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
            }
        ]
    }
]



  • No labels