Skip to end of metadata
Go to start of metadata


About Ratepay

General information about Ratepay

With payment by invoice you can reduce the number of uncompleted orders in your online shop by up to 81%. This increases your turnover and your sales. Therefore Computop Paygate allows purchase on account in several European countries with payment guarantee. Rate payment at the online shop motivates your customers to order high value baskets. This also increases your turnover. Therefore Computop Paygate offers guaranteed hire purchase within several European countries.

With Ratepay you profit as a merchant from a full invoice and hire purchase service. Therefore you pass on all the invoice data during the order to the service provider. That than takes over the complete billing and debtor management. As merchant you get a payment guarantee. Furthermore Ratepay offers classical hire purchase and SEPA direct debit.

Ratepay guarantees an online consent in seconds for purchases by instalment during the order process. A PostIdent-process is not necessary. Ratepay transfers the invoice amount rapidly to the merchant and bears the non-payment risk themselves.


Logo

Info

Ratepay offers payments solutions for purchases on invoice and hire purchases as well as direct debits with full processing and carries to complete risk of payments defaults.

TypePayments by Invoice and Installments


Further information can be found on the webpage of Ratepay (http://www.ratepay.com).


Process flow chart

Ratepay process flow


Paygate interface

Definitions

Data formats

Format

Description

a

alphabetical

as

alphabetical with special characters

n

numeric

an

alphanumeric

ans

alphanumeric with special characters

ns

numeric with special characters

bool

boolean expression (true or false)

3

fixed length with 3 digits/characters

..3

variable length with maximum 3 digits/characters

enum

enumeration of allowed values

dttm

ISODateTime (YYYY-MM-DDThh:mm:ss)


Abbreviations

Abbreviation

Description

Comment

CND

condition


M

mandatory

If a parameter is mandatory, then it must be present

O

optional

If a parameter is optional, then it can be present, but it is not required

C

conditional

If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional


Notice: Please note that the names of parameters can be returned in upper or lower case.


Ratepay invoice and hire purchase

A payment with Ratepay consists of several transaction steps. At the start an initialisation is necessary, which returns the permissible methods of payment for the customer: purchase on invoice, hire purchase or direct debit. If the customer wants hire purchase the instalment calculator must be displayed. The payment is subsequently created, confirmed, changed if needed and finally captured. Credits are also possible.

Computop Ratepay has 5 different requests which must be carried out in the payment process depending on the situation and progress. Computop converts these requests into the corresponding Ratepay requests. In this case the following mapping applies:


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

Computop request

Ratepay request

Description

Beschreibung

INIT / Authorize

PAYMENT_INIT

(PAYMENT_QUERY)

Computop executes automatically the request PAYMENT_INIT. If a merchant uses Integrated Payment Control (IBS) the PAYMENT_QUERY request is carried out.

EventToken = A

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

EventToken = A

Create payment

(Authorize step 1)

PAYMENT_REQUEST

Initialises a purchase by instalment or purchase on account

EventToken = R

Initialisiert einen Raten- bzw. Rechnungskauf

EventToken = R

Verify

(Authorize step 2)

PAYMENT_CONFIRM

Confirms the initialisation again.

Computop can also automate this request. Please leave this request out in that case (contact our support for this).

EventToken = V

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: Here the payment can be modified. Possible are:

-          Full cancellation / EventToken = FC

-          Partial cancellation / EventToken = PC

-          Order change / EventToken = CO

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

-          Vollstornierung / EventToken = FC

-          Teilstornierung / EventToken = PC

-          Auftragsänderung / EventToken = CO

CaptureCONFIRMATION_DELIVERY

Activates and/or carries out payment.

This request must be given when the goods are shipped for reasons of liability and falling due!

EventToken = C

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: Here the payment can be modified. Possible are:

-          Full return / EventToken = FC

-          Partial return / EventToken = PR

-          Credit / EventToken = CR

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

-          Vollrückgabe / EventToken = FR

-          Teilrückgabe / EventToken = PR

-          Gutschrift / EventToken = CR


Initialising Ratepay payments

In order to initialise a Ratepay payment via server-to-server communication, please use the following URL:


Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

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

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

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

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyFormatCNDDescriptionBeschreibung
Amount

n..10

M

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

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.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

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

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

Format

CND

Description

Beschreibung

OrderDescans..768ODescription of the goods purchasedBeschreibung der gekauften Waren
E-mailans..255MeMail address of the card holderE-Mail-Adresse des Karteninhabers
CustomerIDan..30OUnique customer ID in merchant system or the customer’s email addressEindeutige ID des Kunden im Händlersystem oder die E-Mail-Adresse des Kunden
CustomerClassificationans..8OInstruction to risk management about type of customer: negative, neutral, positive, vipAnweisung an das Risikomanagement, um welchen Kundentyp es sich handelt: negative, neutral, positive, vip
Titleans..45OTitleTitel
Salutationans..45OSalutationAnrede
Gendera1MGender: Sex (M=male / F=female / U=unknown)Geschlecht: M=male, F=female, U=unknown
DateOfBirthdttm8C

Date of birth in the format YYYYMMDD.

Optional for B2B (CompanyName transmitted), otherwise mandatory.

Geburtsdatum im Format JJJJMMTT.

Optional bei B2B (CompanyName angegeben), sonst Pflicht.

PhoneAreaCodeans..30CTelephone code. Mandatory if MobileAreaCode is not transmitted.Telefonvorwahl. Pflicht, wenn kein MobileAreaCode übergeben ist.
Phoneans..30CPhone number. Mandatory if Mobile is not transmitted.Rufnummer. Pflicht, wenn kein Mobile übergeben ist.
FaxAreaCodeans..30OFax area codeFax-Vorwahl
Faxans..30OFax numberFaxnummer
MobileAreaCodeans..30CMobile area code. Mandatory if PhoneAreaCode is not transmitted.Mobil-Vorwahl. Pflicht, wenn kein PhoneAreaCode übergeben ist.
Mobileans..30CMobile telephone number. Mandatory if Phone is not transmitted.Mobiltelefonnummer. Pflicht, wenn kein Phone übergeben ist.
AccOwner

ans..55

CName of account holder. Mandatory for direct debit.Name des Kontoinhabers. Pflicht bei DirectDebit.
IBAN

ans..34

CInternational Bank Account Number. Mandatory for direct debit.International Bank Account Number. Pflicht bei DirectDebit.
BIC

ans11

OBank Identifier CodeBank Identifier Code
AccBank

ans..27

OName of the financial institutionName des Kreditinstituts
Nationality

a2

MCountry code of customer's country of origin according to ISO-3166 alpha 2Ländercode des Herkunftslandes des Kunden gemäß ISO-3166 alpha 2
AlloowCredInq

a..3

MCustomer agrees to the passing on of his details for credit offers (yes/no)Kunde stimmt der Weitergabe seiner Daten für Kreditangebote zu (yes/no)
ShopSystem

ans..127

OName of the shop systemName des Shop-Systems
ShopSystemVersion

ans..127

OVersion name of the shop systemVersionsname des Shop-Systems
ShoppingBasket

ans..1024

MCurrent shopping basket (for structure see table Shopping-Basket)Aktueller Warenkorb (Aufbau siehe Tabelle Shopping-Basket)
ShoppingBasketAmount

n..10

MTotal value of shopping basket in smallest currency unit (less discount, incl. shipment etc.)Gesamtwert des Warenkorbs in kleinster Währungseinheit (abzüglich Rabatte, inkl. Versand u.a.)
Discountans..100O

Trans-shopping cart discount

Format: DESCRIPTION; GROSS AMOUNT; VAT

Example: Discount;1000;1900

Warenkorbübergreifender Rabatt.

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Rabatt;1000;1900

ShippingProfileans..100O

Shipping costs

Format: DESCRIPTION; GROSS AMOUNT; VAT

Example: Shipment;500;1900

Versandkosten

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Versand;500;1900

Accountans..10OAccount identification to use separate logins (SubShops)Account-Kennung, um gesonderte (SubShops) Logins zu nutzen
EventTokena..2M„A“ for authorization„A“ für Autorisierung



Company data (B2B)Firmendaten (B2B)
CompanyName

ans..100

CCompany name, obligatory for B2BFirmenname, Pflicht bei B2B
VatID

ans..25

CVAT-ID, obligatory for B2BUmsatzsteuer-ID, Pflicht bei B2B
CompanyID

ans..50

ORegister of Companies numberHandelsregisternummer
LegalForm

ans..100

OLegal form. The value to be transmitted must be coordinated with Ratepay!Rechtsform. Zu übergebender Wert muss mit Ratepay abgestimmt werden!
RegistryLocation

ans..255

OCompany's principal officeFirmensitz
Homepage

ans..255

OHomepage of the companyHomepage des Unternehmens



Delivery dataLieferdaten
sdFirstName

ans..100

O

First name of the customerVorname des Kunden
sdLastName

ans..100

O

Last name of the customerNachname des Kunden
sdStreet

ans..100

O

Street name and house numberStraßenname und Hausnummer
sdStreetHouseNumber

ans..10

O

Street numberHausnummer
sdStreetAddition

ans..50

O

Addition in the delivery addressZusatz in der Lieferadresse
sdZIPCode

ans..10

O

PostcodePostleitzahl
sdCity

ans..255

O

CityOrt
sdCountryCode

a2

O

Two characters country code according to ISO 3166Ländercode zweistellig gemäß ISO 3166
sdPhone

ns..32

O

Customer’s phone numberTelefonnummer des Kunden



Invoice data (check address)Rechnungsdaten (Prüfadresse)
bdFirstName

ans..100

M

First name of the custumer

Vorname des Kunden
bdLastName

ans..100

M

Last name of the customer

Nachname des Kunden
bdCompanyName

ans..100

O

Name of company

Firmenname
bdStreet

ans..50

M

Street name in the invoicing address

Straßenname der Rechnungsadresse
bdStreetNr

ans..10

M

Street number of the invoicing address

Hausnummer der Rechnungsadresse
bdStreetAddition

ans..50

O

Address addition in the billing address

Adresszusatz der Rechnungsadresse
bdZIP

ans..10

M

Postcode in the invoicing address

Postleitzahl der Rechnungsadresse
bdCity

ans..255

M

Town/city of the invoicing address

Ort der Rechnungsadresse
bdCountryCode

a2

M

Country code for the invoicing address, 2 characters according to ISO 3166

Ländercode der Rechnungsadresse zweistellig gemäß ISO 3166
bdPhone

ns..32

M

Customer’s phone number

Telefonnummer des Kunden



Registration address (B2B)Registrierungsadresse (B2B)
FirstName

ans..100

O

First nameVorname
LastName

ans..100

O

Last nameNachname
AddrStreet

ans..50

C

Street. Mandatory if B2B (CompanyName is given).Straße. Pflicht wenn B2B (CompanyName angegeben).
AddrStreetNr

ans..10

C

Street number. Mandatory if B2B (CompanyName is given)Hausnummer. Pflicht wenn B2B (CompanyName angegeben).
AddressAddition

ans..50

O

Address c/oAdresszusatz
AddrZip

ans..10

C

Postcode. Mandatory if B2B (CompanyName is given).Postleitzahl. Pflicht wenn B2B (CompanyName angegeben).
AddrCity

ans..32

C

City. Mandatory if B2B (CompanyName is given).Ort. Pflicht wenn B2B (CompanyName angegeben).
AddrCountryCode

a2

C

Two characters country code according to ISO 3166. Mandatory if B2B (CompanyName is given).Ländercode zweistellig gemäß ISO 3166. Pflicht wenn B2B (CompanyName angegeben).



Fraud preventionBetrugsprävention
IPAddrans..15M

With the transferred IP address Paygate can determine in which country and in which town your customer has connected with the Internet (see also IPZone). Format: 123,456,789,012

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

DeviceTokenans..100ODevice token, see external documentation from RatepayGeräte-Token, siehe externe Dokumentation von Ratepay

Parameters for Ratepay payments


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

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

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

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

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

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

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

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Key

Format

CND

Description

Beschreibung

Status

a..50

M

INIT or FAILED

INIT oder FAILED

KeyFormatCNDDescriptionBeschreibung
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

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

KeyFormatCNDDescriptionBeschreibung
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

Key

Format

CND

Description

Beschreibung

InfoText

ans..1024

O

Contains an infotext which can be forwarded to the customer (e.g. at refusal)

Enthält einen Info-Text, der dem Kunden weitergegeben werden kann (z.B. bei Ablehnung)
ExternalMessageans..256O

Error text from Ratepay, if agreed with Computop Helpdesk

Fehlertext von Ratepay, wenn mit Computop Helpdesk abgesprochen

ExternalCodeans..64O

Error code from Ratepay, if agreed with Computop Helpdesk

Fehlercode von Ratepay, wenn mit Computop Helpdesk abgesprochen

Installmenta..5OFor IBS: True / False, if installment is allowedBei IBS: True / False, ob installment erlaubt ist
Prepaymenta..5OFor IBS: True / False, if prepayment is allowedBei IBS: True / False, ob prepayment erlaubt ist
Invoicea..5OFor IBS: True / False, if invoice is allowedBei IBS: True / False, ob invoice erlaubt ist
ELVa..5OFor IBS: True / False, if ELV is allowedBei IBS: True / False, ob ELV erlaubt ist
RPTransIDans..50OUnique reference number from RatepayEindeutige Referenznummer von Ratepay

Result parameters for Ratepay payments



Ratepay instalment calculator

The Ratepay instalment calculator (control surface implemented by the merchant) must be displayed if the end customer is expected to make a purchase by instalment. In this case the instalments are calculated on the basis of the amount + e.g. the duration (or the duration is calculated based on the instalments).

Use the following URL to display the Ratepay instalment calculator:


Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

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

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

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

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

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

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Amount

n..10

M

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

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.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

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

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

Format

CND

Description

Beschreibung

Month

ans.255

C

Duration in months. Obligatory for EventToken RT.

Laufzeit in Monaten. Pflicht bei EventToken RT.
Raten..8CMonthly instalment in the smallest currency unit. Obligatory for EventToken RR.Monatliche Rate in kleinster Währungseinheit. Pflicht bei EventToken RR.
FirstDayn..2O

Calendar day of first payment.

Possible values are: 1, 15, 28. Default value = 28.

Kalendertag der ersten Zahlung.

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

StartDatedttm8OStart date of instalment payment in the format YYYYMMDDStartdatum der Ratenzahlung im Format JJJJMMTT
DueDatedttm8ODue date in the format YYYYMMDDFälligkeitsdatum im Format JJJJMMTT
InterestRaten..5ODebit interest rate, e.g. 1370 for 13,70%Sollzinssatz, zum Beispiel 1370 für 13,70%
EventTokena..2MRT (CalculationbyTime) or RR (CalculationbyRate)RT (CalculationbyTime) oder RR (CalculationbyRate)
Accountans..10OAccount identification to use separate logins (SubShops)Account-Kennung, um gesonderte (SubShops) Logins zu nutzen

Parameters for Ratepay instalment calculator


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

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

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

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

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

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

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

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Key

Format

CND

Description

Beschreibung

Status

a..50

M

INIT or FAILED

INIT oder FAILED

KeyFormatCNDDescriptionBeschreibung
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

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

KeyFormatCNDDescriptionBeschreibung
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

Key

Format

CND

Description

Beschreibung

InfoText

ans..1024

O

Contains an infotext which can be forwarded to the customer (e.g. at refusal)

Enthält einen Info-Text, der dem Kunden weitergegeben werden kann (z.B. bei Ablehnung)
ExternalMessageans..256O

Error text from Ratepay, if agreed with Computop Helpdesk

Fehlertext von Ratepay, wenn mit Computop Helpdesk abgesprochen

ExternalCodeans..64O

Error code from Ratepay, if agreed with Computop Helpdesk

Fehlercode von Ratepay, wenn mit Computop Helpdesk abgesprochen

TotalAmountn..10MTotal amount to be financed in the smallest currency unitZu finanzierender Gesamtbetrag in der kleinsten Währungseinheit
InterestAmountn..10MSum of all monthly instalments in the smallest currency unitSumme aller monatlich gezahlten Raten in der kleinsten Währungseinheit
ServiceChargen..10MAdditional financing costs in the smallest currency unitZusätzliche Finanzierungskosten in der kleinsten Währungseinheit
InterestRaten..5MDebit interest rate, e.g. 1370 for 13,70%Sollzinssatz, zum Beispiel 1370 für 13,70%
AnnualPercentageRaten..5MAnnual interest based on ServiceCharge and InterestRateJahreszins basierend auf ServiceCharge und InterestRate
MonthlyDebitInterestn..5MMonthly debit interest based on AnnualPercentageRateMonatlicher Zins basierend auf AnnualPercentageRate
InstallmentNumbern..2MNumber of monthly instalmentsAnzahl Monate der Ratenzahlung
InstallmentAmountn..10MMonthly amount payable in the smallest currency unitMonatlich zu bezahlender Betrag in der kleinsten Währungseinheit
InstallmentLastAmountn..10MAmount of the last rate in the smallest currency unitBetrag der letzten Rate in der kleinsten Währungseinheit
FirstDayn..2O

Calendar day of first payment.

Possible values are 1, 15, 28. Default value = 28.

Kalendertag der ersten Zahlung.

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

Result parameters for Ratepay instalment calculator


Although the configuration of the instalment calculator is firmly specified by Ratepay, it may be helpful to query this configuration before further processing in order to avoid subsequent errors. Use the following URL to do this:


Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

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

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

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

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

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

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

Format

CND

Description

Beschreibung

EventTokena..2MRC for RateconfigurationRC für Rateconfiguration
Accountans..10OAccount identification to use separate logins (SubShops)Account-Kennung, um gesonderte (SubShops) Logins zu nutzen

Parameters for querying the configuration of the Ratepay instalment calculator


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

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

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

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

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

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

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

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

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

Key

Format

CND

Description

Beschreibung

MinRaten..2OMinimum number of instalmentsMindestanzahl der Raten
DefaultRaten..12ODefault rate in the smallest currency unitStandardrate in der kleinsten Währungseinheit
MaxInterestRaten..5OMaximum interest rateMaximaler Zinssatz
MinMonthn..2OMinimum running time in monthsMindestlaufzeit in Monaten
MaxMonthn..2OMaximum running time in monthsMaximallaufzeit in Monaten
MonthLongrunn..2OMinimum running time for a long time financingMindestlaufzeit für eine Langzeitfinanzierung
MonthAllowedans..50OComma-separated list of permissible running times in monthsKommaseparierte Liste mit erlaubten Laufzeiten in Monaten
FirstDayans..20OComma-separated list of permissible start days (1, 15, 28)Kommaseparierte Liste mit möglichen Starttagen (1, 15, 28)
LastRaten..10OMinimum amount for the final instalment in the smallest currency unitMindestbetrag für die Abschlussrate in der kleinsten Währungseinheit
MinRateNormaln..10OMinimum rate in the smallest currency unitMindestrate in der kleinsten Währungseinheit
MinRateLongrunn..10OMinimum rate for a long term financing in the smallest currency unitMindestrate einer Langzeitfinanzierung in der kleinsten Währungseinheit
ServiceChargen..10OAdditional financing costs in the smallest currency unitZusätzliche Finanzierungskosten in der kleinsten Währungseinheit

InfoText

ans..1024

O

Contains an infotext which can be forwarded to the customer (e.g. at refusal)

Enthält einen Info-Text, der dem Kunden weitergegeben werden kann (z.B. bei Ablehnung)
ExternalMessageans..256O

Error text from Ratepay, if agreed with Computop Helpdesk

Fehlertext von Ratepay, wenn mit Computop Helpdesk abgesprochen

ExternalCodeans..64O

Error code from Ratepay, if agreed with Computop Helpdesk

Fehlercode von Ratepay, wenn mit Computop Helpdesk abgesprochen

Response parameters of the configuration query of the Ratepay instalment calculator



Create payment process

In order to create a payment transaction with Ratepay, please use the following URL:


Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

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

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

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

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

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

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Amount

n..10

M

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

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.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

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

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

Format

CND

Description

Beschreibung

RPMethodans..10MType of payment: INVOICE, INSTALLMENT or ELVZahlungsweise: INVOICE, INSTALLMENT oder ELV
ShoppingBasketAmountn..10MTotal value of shopping basket in smallest currency unit (less discount, incl. shipment etc.)Gesamtwert des Warenkorbs in kleinster Währungseinheit (abzüglich Rabatte, inkl. Versand u.a.)
Accountans..10OAccount identification to use separate logins (SubShops)Account-Kennung, um gesonderte (SubShops) Logins zu nutzen
DeviceTokenans..100ODevice token, see external documentation from RatepayGeräte-Token, siehe externe Dokumentation von Ratepay
ShopSystemans..127OName of the shop systemName des Shop-Systems
ShopSystemVersionans..127OVersion name of the shop systemVersionsname des Shop-Systems
EventTokena..2MR for RateInitR für RateInit



SEPA (ELV)SEPA (ELV)
AccOwner

ans..55

C

Name of account holder. Mandatory for direct debit.Name des Kontoinhabers. Pflicht bei DirectDebit.
IBAN

ans..34

C

International Bank Account Number. Mandatory for direct debit.International Bank Account Number. Pflicht bei DirectDebit.
BIC

ans11

O

Bank Identifier CodeBank Identifier Code. Pflicht bei DirectDebit.
AccBank

ans..27

O

Name of the financial institutionName des Kreditinstituts
DebitPayType

a2

C

Type of payment. Mandatory for direct debit.

BT = BankTransfer ; DD = DirectDebit

Zahlungsweise. Pflicht bei DirectDebit.

BT = BankTransfer ; DD = DirectDebit




Instalment payment (INSTALLMENT)Ratenzahlung (INSTALLMENT)
InterestRate

n..5

C

Reference interest rate (value is taken from the instalment calculator). Mandatory for instalment.

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

n..12

C

Number of monthly instalments (value is taken from the instalment calculator). Mandatory for instalment.

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

n..10

C

Amount payable monthly (value is taken from the instalment calculator). Mandatory for instalment.

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

n..10

C

Amount of final instalment (value is taken from the instalment calculator). Mandatory for instalment.

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

n..2

O

Calendar day of first payment.

Possible values are 1, 15, 28. Default value = 28.

Kalendertag der ersten Zahlung.

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

TotalAmount

n..10

C

Total amount to be financed. Mandatory for instalment.

Zu finanzierender Gesamtbetrag. Pflicht bei Ratenzahlung.

Parameters for the creation of a Ratepay payment


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

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

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

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

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

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

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

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

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

Key

Format

CND

Description

Beschreibung

InfoText

ans..1024

O

Contains an infotext which can be forwarded to the customer (e.g. at refusal)

Enthält einen Info-Text, der dem Kunden weitergegeben werden kann (z.B. bei Ablehnung)
ExternalMessageans..256O

Error text from Ratepay, if agreed with Computop Helpdesk

Fehlertext von Ratepay, wenn mit Computop Helpdesk abgesprochen

ExternalCodeans..64O

Error code from Ratepay, if agreed with Computop Helpdesk

Fehlercode von Ratepay, wenn mit Computop Helpdesk abgesprochen

Response parameters for the creation of a Ratepay payment



Confirm payment transaction

In order to conform a payment transaction with Ratepay, please use the following URL:


Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

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

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

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

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

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

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

Format

CND

Description

Beschreibung

Accountans..10OAccount identification to use separate logins (SubShops)Account-Kennung, um gesonderte (SubShops) Logins zu nutzen
EventTokena..2MV for verifyV für verify

Parameters for confirming a Ratepay payment


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

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

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

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

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

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

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

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

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

Key

Format

CND

Description

Beschreibung

InfoText

ans..1024

O

Contains an infotext which can be forwarded to the customer (e.g. at refusal)

Enthält einen Info-Text, der dem Kunden weitergegeben werden kann (z.B. bei Ablehnung)
ExternalMessageans..256O

Error text from Ratepay, if agreed with Computop Helpdesk

Fehlertext von Ratepay, wenn mit Computop Helpdesk abgesprochen

ExternalCodeans..64O

Error code from Ratepay, if agreed with Computop Helpdesk

Fehlercode von Ratepay, wenn mit Computop Helpdesk abgesprochen

Response parameters for confirmung a Ratepay payment



Capture a Ratepay payment transaction (full / partial capture)

In order to capture a payment transaction with Ratepay, please use the following URL:


Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

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

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

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

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

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for the payment to be captured

Vom Paygate vergebene ID für die zu buchende Zahlung

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Amount

n..10

M

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

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.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

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

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyFormatCNDDescriptionBeschreibung
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. Submissions with identical ReqID for an open status will be processed regularly. Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

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 einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

Key

Format

CND

Description

Beschreibung

ShoppingBasketans..1024MShopping cart with items to be posted (structure - see ShoppingBasket table)Warenkorb mit den zu buchenden Artikeln (Aufbau siehe Tabelle ShoppingBasket)
ShoppingBasketAmountn..10MTotal value of the present shopping basket in smallest currency unit (less discount, incl. shipment etc.)Gesamtwert des aktuellen Warenkorbs in kleinster Währungseinheit (abzüglich Rabatte, inkl. Versand u.a.)
Discountans..100O

Trans-shopping cart discount

Format: DESCRIPTION; GROSS AMOUNT; VAT

Example: Discount;1000;1900

Warenkorbübergreifender Rabatt.

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Rabatt;1000;1900

ShippingProfileans..100O

Shipping costs

Format: DESCRIPTION; GROSS AMOUNT; VAT

Example: Shipment;500;1900

Versandkosten

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Versand;500;1900

Accountans..10OAccount identification to use separate logins (SubShops)Account-Kennung, um gesonderte (SubShops) Logins zu nutzen
InvoiceIDans..50OInvoice numberRechnungsnummer
TrackingIDans..100O

List of shipment service providers with associated parcel number.


Format: SERVICE PROVIDER; PACKAGE NUMBER

Example: DHL;Paket1


Other service providers/dispatch numbers are respectively delimited with a “+”.

Example: DHL;Paket1+DHL;Paket2+GLS;Paket9


Caution: The shortcodes for providers are to coordinate with Ratepay!

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!

ShopSystemans..127OName of the shop systemName des Shop-Systems
ShopSystemVersionans..127OVersion name of the shop systemVersionsname des Shop-Systems
EventTokena..2MC for captureC für Capture (Buchung)

Parameters for capture of a Ratepay payment


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

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

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

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

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

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

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

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

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

Key

Format

CND

Description

Beschreibung

InfoText

ans..1024

O

Contains an infotext which can be forwarded to the customer (e.g. at refusal)

Enthält einen Info-Text, der dem Kunden weitergegeben werden kann (z.B. bei Ablehnung)
ExternalMessageans..256O

Error text from Ratepay, if agreed with Computop Helpdesk

Fehlertext von Ratepay, wenn mit Computop Helpdesk abgesprochen

ExternalCodeans..64O

Error code from Ratepay, if agreed with Computop Helpdesk

Fehlercode von Ratepay, wenn mit Computop Helpdesk abgesprochen

Response parameters for capturing a Ratepay payment



Cancellation / return of Ratepay payments

In order to cancel a Ratepay payment partial or in full or the make changes on a payment, please use the following URL:


Notice: There are constraints for the different actions (event tokens) regarding when actions can be carried out. Before the capture only the following are allowed: FC (full cancellation), PC (partial cancellation), CO (change order). Only after the capture are allowed FR (full return) and PR (partial return).

Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

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

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

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

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

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

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Amount

n..10

M

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

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.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

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

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyFormatCNDDescriptionBeschreibung
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. Submissions with identical ReqID for an open status will be processed regularly. Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

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 einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

Key

Format

CND

Description

Beschreibung

RPMethodans..10MType of payment: INVOICE, INSTALLMENT or ELVZahlungsweise: INVOICE, INSTALLMENT oder ELV
ShoppingBasketans..1024C

Shopping cart with items to be cancelled (structure - see ShoppingBasket table)

  • for EventToken FC / FR either ShoppingBasket or ShoppingBasketAmount is required

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

  • für EventToken FC / FR ist entweder ShoppingBasket oder ShoppingBasketAmount erforderlich
ShoppingBasketAmountn..10C

Total value of the present shopping basket in smallest currency unit (less discount, incl. shipment etc.)

  • for EventToken FC / FR either ShoppingBasket or ShoppingBasketAmount is required

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
Discountans..100O

Trans-shopping cart discount

Format: DESCRIPTION; GROSS AMOUNT; VAT

Example: Discount;1000;1900

Warenkorbübergreifender Rabatt.

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Rabatt;1000;1900

ShippingProfileans..100O

Shipping costs

Format: DESCRIPTION; GROSS AMOUNT; VAT

Example: Shipment;500;1900

Versandkosten

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Versand;500;1900

Accountans..10OAccount identification to use separate logins (SubShops)Account-Kennung, um gesonderte (SubShops) Logins zu nutzen
ShopSystemans..127OName of the shop systemName des Shop-Systems
ShopSystemVersionans..127OVersion name of the shop systemVersionsname des Shop-Systems
EventTokena..2M

FC for full-cancellation

PC for partial-cancellation

CO for change-order

FR for full-return

PR for partial-return

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

Parameters for cancellation / change of a Ratepay payment


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

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

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

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

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

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

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

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

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

Key

Format

CND

Description

Beschreibung

InfoText

ans..1024

O

Contains an infotext which can be forwarded to the customer (e.g. at refusal)

Enthält einen Info-Text, der dem Kunden weitergegeben werden kann (z.B. bei Ablehnung)
ExternalMessageans..256O

Error text from Ratepay, if agreed with Computop Helpdesk

Fehlertext von Ratepay, wenn mit Computop Helpdesk abgesprochen

ExternalCodeans..64O

Error code from Ratepay, if agreed with Computop Helpdesk

Fehlercode von Ratepay, wenn mit Computop Helpdesk abgesprochen

Response parameters for cancellation / change of a Ratepay payment



Crediting Ratepay payments

In order to credit a payment transaction with Ratepay, please use the following URL:


Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

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

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

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

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

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for the payment to be credited

Vom Paygate vergebene ID für die gutzuschreibende Zahlung

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Amount

n..10

M

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

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.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

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

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyFormatCNDDescriptionBeschreibung
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. Submissions with identical ReqID for an open status will be processed regularly. Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

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 einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

Key

Format

CND

Description

Beschreibung

ShoppingBasketans..1024MShopping cart with a “CREDIT” item (structure - see ShoppingBasket table)Warenkorb mit einem „CREDIT“-Artikel (Aufbau siehe Tabelle ShoppingBasket)
ShoppingBasketAmountn..10MTotal value of the present shopping basket in smallest currency unit (less discount, incl. shipment etc.)Gesamtwert des aktuellen Warenkorbs in kleinster Währungseinheit (abzüglich Rabatte, inkl. Versand u.a.)
Discountans..100O

Trans-shopping cart discount

Format: DESCRIPTION; GROSS AMOUNT; VAT

Example: Discount;1000;1900

Warenkorbübergreifender Rabatt.

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Rabatt;1000;1900

ShippingProfileans..100O

Shipping costs

Format: DESCRIPTION; GROSS AMOUNT; VAT

Example: Shipment;500;1900

Versandkosten

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Versand;500;1900

Accountans..10OAccount identification to use separate logins (SubShops)Account-Kennung, um gesonderte (SubShops) Logins zu nutzen
ShopSystemans..127OName of the shop systemName des Shop-Systems
ShopSystemVersionans..127OVersion name of the shop systemVersionsname des Shop-Systems
EventTokena..2MCR for CreditCR für Credit (Gutschrift)

Parameters for crediting a Ratepay payment


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

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

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

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

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

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

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

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

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

Key

Format

CND

Description

Beschreibung

InfoText

ans..1024

O

Contains an infotext which can be forwarded to the customer (e.g. at refusal)

Enthält einen Info-Text, der dem Kunden weitergegeben werden kann (z.B. bei Ablehnung)
ExternalMessageans..256O

Error text from Ratepay, if agreed with Computop Helpdesk

Fehlertext von Ratepay, wenn mit Computop Helpdesk abgesprochen

ExternalCodeans..64O

Error code from Ratepay, if agreed with Computop Helpdesk

Fehlercode von Ratepay, wenn mit Computop Helpdesk abgesprochen

Response parameters for crediting a Ratepay payment


ShoppingBasket parameter explained

The ShoppingBasket parameter describes the affected transaction items and is comprised of various parameters. The individual parameters within a shopping cart are separated with a “;”. Only enter the values and not the associated parameter name. Unused optional parameters must be transferred as an empty field. Each further item is separated from the last with a “+”. For an example see table below.

The following table describes the individual values within the 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

Beschreibung

ArtNr

ans..255

C

Unique article number. Each item in the shopping cart must be clearly identifiable. Either via ArtNr or a combination of ArtNr and UniqueArticleNumber.

Eindeutige Artikelnummer. Jeder Artikel im Warenkorb muss eindeutig identifizierbar sein. Entweder über ArtNr oder eine Kombination aus ArtNr und UniqueArticleNumber.
Quantity

n..12

M

Quantity

Anzahl
Category

n..2

O

Article category (as agreed with Ratepay)

Artikelkategorie (nach Absprache mit Ratepay)
Item

ans..255

M

Article description

Artikelbeschreibung
UnitPriceGross

n..12

M

Unit price gross in smallest currency unit

Stückpreis brutto in kleinster Währungseinheit
TaxRate

n..5

M

VAT rate with 2 decimal places, e.g. 1900 for 19%

Steuersatz mit 2 Nachkommastellen, z.B. 1900 für 19%
UniqueArticleNumber

ans..50

C

Unique article number. Each item in the shopping cart must be clearly identifiable. Either via ArtNr or a combination of ArtNr and UniqueArticleNumber.

Eindeutige Artikelnummer. Jeder Artikel im Warenkorb muss eindeutig identifizierbar sein. Entweder über ArtNr oder eine Kombination aus ArtNr und UniqueArticleNumber.
Discount

n..12

O

Article-specific discount in smallest currency unit

Artikelbezogener Nachlass in kleinster Währungseinheit
DescriptionAddition

ans..511

O

Additional text for further description. Can be used in communication between Ratepay and the end customer.

Zusatztext für weitere Beschreibung. Kann in der Kommunikation zwischen Ratepay und dem Endkunden genutzt werden.

Parameters within the shopping basket

 

Example of a shopping basket with 3 articles:

ShoppingBasket=A;1;1;bed;10000;1900;01233;1000;blue+B;2;1;towel;3000;1900;0234;;180x200+C;5;1;pillow;1000;1900;;;


Batch processing via the interface

Basic information about using Batch files and about their structure can be found in the Batch Manager manual. Within batch processing not alle functions are available which are usually available for the online interface.

This section describes the parameters which must be transferred within the data set (Record) for executing a Ratepay capture or change and which information can be found within the response file about the payment status.

For Batch calls there must be considered batch versions, from which optional parameters depend. All version designations starting with „2.“ pertain calls for a group of enterprises. That means within a batch file for a particular MerchantID can be transferred transactions for other merchants with a separate Sub-MID.

Following table gives an overview of all batch versions that are possible for a specific action an their specialities:

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

Action

Version

Description

Beschreibung

Capture

1.0 / 2.0

Standard version without return of parameter Code

Standardversion ohne Rückgabe von Parameter Code


1.x / 2.x

with RefNr (valid for all versions other than 1.0)

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

1.1.2 / 2.1.2with discount and shippingmit discount und shipping
Change

1.0 / 2.0

Standard version without return of parameter Code

Standardversion ohne Rückgabe von Parameter Code

1.x / 2.x

with RefNr (valid for all versions other than 1.0)

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

1.1.2 / 2.1.2with discount and shippingmit discount und shipping

Description of the possible batch versions


The structure for a capture or credit within a Batch file to be submitted is the following:

HEAD,<MerchantID>,<Date>,<Version>
Ratepay,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<ShoppingBasket>,<ShoppingBasketAmount>,<EventToken>,<RPMethod>(,<Discount>,<Shipping>)
Ratepay,Change,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<ShoppingBasket>,<ShoppingBasketAmount>,<EventToken>,<RPMethod>(,<Discount>,<Shipping>)
FOOT,<CountRecords>,<SumAmount>

Example for Master MID function:

HEAD,[Master]MerchantID,Date,2.x
Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action)
FOOT,CountRecords,SumAmount

The following table describes the individual fields and values used within the data set (record) within the batch file:

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

Beschreibung

Type

a..11

M

HEAD for Header, FOOT for Footer, Ratepay for the transactions

HEAD für Header, FOOT für Footer, Ratepay für Transaktionen

Action

a..20

M

The parameter Action defines the type of transaction:

Capture

Change (credit / change)

Der Action-Parameter definiert die Art der Transaktion:

Capture (Buchung)

Change (Gutschrift / Änderung)

KeyFormatCNDDescriptionBeschreibung
Amount

n..10

M

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

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.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

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

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for this transaction

Vom Paygate vergebene ID für diese Transaktion

Key

Format

CND

Description

Beschreibung

ShoppingBasket

ans..1024

M

Shopping cart with items to be cancelled (structure - see ShoppingBasket table)

  • for EventToken FC / FR either ShoppingBasket or ShoppingBasketAmount is required

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

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

n..12

M

Total value of the present shopping basket in smallest currency unit (less discount, incl. shipment etc.)

  • for EventToken FC / FR either ShoppingBasket or ShoppingBasketAmount is required

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
EventToken

a..2

M

R for RateInit

CR for Credit

FC for full-cancellation

PC for partial-cancellation

CO for change-order

FR for full-return

PR for partial-return

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

Type of payment: INVOICE, INSTALLMENT or ELV. Is not needed for capture!

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

ans..100

O

Trans-shopping cart discount

Format: DESCRIPTION; GROSS AMOUNT; VAT

Example: Discount;1000;1900

Warenkorbübergreifender Rabatt

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Rabatt;1000;1900

ShippingProfile

ans..100

O

Shipping costs

Format: DESCRIPTION; GROSS AMOUNT; VAT

Example: Shipment;500;1900

Versandkosten

Format: BEZEICHNUNG;BRUTTOBETRAG;STEUERSATZ

Beispiel: Versand;500;1900

Description of fields within the record for Batch files

 

The record area within the response file for Batch transactions looks the following way:

HEAD,<MerchantID>,<Date>,<Version>
Ratepay,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<ShoppingBasket>,<ShoppingBasketAmount>,<EventToken>,<RPMethod>(,<Discount>,<Shipping>),<Status>,<Code>
Ratepay,Change,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<ShoppingBasket>,<ShoppingBasketAmount>,<EventToken>,<RPMethod>(,<Discount>,<Shipping>),<Status>,<Code>
FOOT,<CountRecords>,<SumAmount>

The following table describes the response parameters which the Batch Manager saves in the Record area for each transaction (standard parameters not explained here, such as <TransID> or <RefNR> and request parameters are returned unchanged and correspond to the call as specified in):

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

Beschreibung

Action

a..20

M

The parameter Action defines the type of transaction:

Capture

Change (credit / change)

Der Action-Parameter definiert die Art der Transaktion:

Capture (Buchung)

Change (Gutschrift / Änderung)

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for this transaction

Vom Paygate vergebene ID für diese Transaktion

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

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

Description of result parameters within the record for Batch files