About direct debit

General information about direct debit

Computop Paygate can combine electronic direct debits (ELV) in Germany with a block list check which offers high security at low cost: Paygate checks if the Customer's account number is black listed by major retailers. Additionally you can prevent fraud by setting sales limits per day, week or month which an account connection may not exceed.

Since there are substantially more accounts than credit cards, many Internet purchases are paid by direct debit. The direct debit process is unsafe for merchants without a block list check: in the case of SEPA direct debits there is no authorisation because it is not possible to carry out a credit rating on the account of the customer. Therefore there are frequently returned debit notes in the case of ELV due to lack of funds in accounts.

The block list check links the benefits of the direct debit with Paygate the security of a block list check and individual sales limits.

Transaction procedure of a direct debit payment on the Internet

In order to pay with a direct debit, the customer selects the Direct debit payment method at the Internet checkout and enters their account details. This Internet page is TLS encrypted to protect the account data during the transmission against tapping and manipulation. After the input Paygate checks if the account is blocked and if the sales limit for this account has been reached. After successful verification, Paygate draws direct debits from the customer's bank.

SEPA direct debit

With SEPA uniform rules for cashless payment transactions are effective since 1st February 2014. Therefore IBAN (International Bank Account Number) and BIC (Bank Identifier Code) are used as account data. With Paygate direct debits can be managed compliant to SEPA.

Time frames for chargebacks

Depending on the SEPA Mandate form there are different time frames during which the customer can trigger a chargeback.
• Authorised SEPA Mandates (at the POS with PIN/signature): maximum time frame during which the end-customer can trigger a return debit/chargeback is 8 weeks from the payment date.
• Unauthorised SEPA Mandates (eCommerce payments): maximum time frame during which the end-customer can trigger a return debit/chargeback is 13 months from the payment date.


Logo

Info

The Paygate enables you to handle the direct debit payment method popular with customers – and is fully compatible with SEPA.

Optionally with black list check and payment guarantee.

TypePayments by Direct Debit

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.

Cookie-/session - handling





Paygate interface: via form

Chart of process flow via form interface

Process flow of direct debit payment via form interface


Corporate PayPage

Paygate forms are framed as standard in white and grey. Merchants can customise the layout of the forms with the help of layout parameters. The simplest way to change the layout is to set the parameters for the background colour (BGColor), background image (BGImage) and the font (FFace). You can use XSL-templates to change the layout further:

In the case of direct debit payments you can change the parameter Template to create an individual layout for your PaySDD-form which exactly matches your shop layout. To this end your graphic designer can design an HTML-template in the shop-design based on XSLT (Extensible Stylesheet Language Transformation). Computop Helpdesk copies this XSLT-template to our Paygate Server. If you enter the name of your XSLT-file in the Template parameter, the Paygate form will appear in your layout.

For general information about XSLT see www.w3.org.


The subsequent conventions apply for the use of the Corporate Pay Page with XSLT:

File names

A XSL file designed by you defines your individual layout. The associated XML file contains the texts that are to be displayed on the form. Hence, multilingualism is easy. Always use your MerchantID in the names of the files.

XSL template:               MerchantID_PaySDD.xsl
XML text file:                MerchantID_PaySDD.xml
Sub-folder for images:  Templates/imagesMerchantID

In order not to receive safety notices, please ensure that external image sources are retrieved via SSL.

In order to call the individual layout, use the ‘template’ parameter with your MerchantID and attach it unencrypted to the call of the Computop payment page, for example: https://www.computop-paygate.com/paysdd.aspx?MerchantID=IhreMID&Len=123&Data=ABCFED…ACEF&template=IhreMerchantID

Field names of the form

When implementing the text field for the IBAN, use the following values for the parameters ‘name’ and ‘id’:

Account holder:           „AccOwner“
IBAN:                          „IBAN“
BIC:                             „BIC“
Bank (optional):           „AccBank“

A text field for the input of the IBAN is then implemented as follows:

<input type="text" name="IBAN" id= "IBAN" value=""></input>


Hidden Fields

The following hidden fields must be implemented so that the values can be passed on when sending the form:

MerchantID:               „MerchantID“
Request length:          „Len“
Request data:             „Data“
Template:                   „Template“
Language:                  „Language“

Language selection

The language selection in form PaySDD.aspx is automatically based on the parameter Language. Other language areas are filtered out. If you wish to access the field of another language area e.g. with JavaScript, you can do so via the following path: template/language/@name.

XML structure

The ‘language’ parameter controls which section of the XML text file is read out. German ‘de’ is always used as standard.

The XML file should have the following basic structure:

<?xml version="1.0" encoding="UTF-16"?>

       </languages>

             <language name="de">

             </language>

             <language name="en">

             </language>

       </languages>


With <xsl:variablename=““ select=“template/language/@name”/> you can directly address an XML language section from the XSL file.

For an overview of which parameters are rendered by the PaySDD, please examine the following structure (XSL file is rendered against the following XML string):

Dim strXML As String = "<?xml version='1.0' encoding='UTF-16'?>" & _

       "<template pay='elv'>" & _

                    "<merchantID>"..."</merchantID>" & _

                    "<PayID>"..."</PayID>" & _

                    "<len>"..."</len>" & _

                    "<data>"..."</data>" & _

                    "<language>"..."</language>" & _

                    "<Border>"..."</Border>" & _

                    "<Background>"..."</Background>" & _

                    "<BGImage>"..."</BGImage>" & _

                    "<BGColor>"..."</BGColor>" & _

                    "<FFace>"..."</FFace>" & _

                    "<FSize>"..."</FSize>" & _

                    "<FColor>"..."</FColor>" & _

                    "<twidth>"..."</twidth>" & _

                    "<theight>"..."</theight>" & _

                    strCustomFieldsXML & _

                    "<URLBack>"..."</URLBack>" & _

                    "<AccOwner>"..."</AccOwner>" & _

                    "<IBAN>"..."</IBAN>" & _

                    "<PBAN>"..."</PBAN>" & _

                    "<BIC>"..."</BIC>" & _

                    "<Bank>"..."</Bank>" & _

                    "<template>"..."</template>" & _

       "</template>"


Since merchants use its own layout for the form, you do not require the layout parameter. However, it is possible after prior consultation with Computop to use the parameters for the transfer, e.g. the SessionID.

JavaScript

If JavaScript functions are desired, you must implement them in your template.

<script id=“clientEventHandlersJS“ language=“JavaScript“>

if (document.SDDForm.IBAN.value.length > 34)

{

alert(„<xsl:value-of select=“/template/language/strJavaScript1“/>“);

       document.SDDForm.IBAN.focus();

}

...

</script>

Please do not use any external link to your JavaScript.

Computop is obliged to provide the account holder information on which server he is on. Please implement a Computop logo like it is implemented on the standard form or display a small imprint link. You can download the Computop logo from www.computop.de/downloads.

Both items of information must refer to the Computop page impressum.aspx. This expects the ‘Data’ parameter, which is appended to the URL as in the following example.

impressum.aspx?data=<xsl:value-of select="/template/language/@name"/>|<xsl:value-of select="template/merchantID"/>


Programming and testing the form

First design a HTML page with the layout for your payment page and initially save it for testing with the file extension .htm or .html. Open this file in the browser. Next, save this as an xsl file.

<?xml version='1.0' encoding="UTF-16"?>

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">

<xsl:output method="html" encoding="UTF-8"/>


<xsl:template match="/">

<html>

       <head>

             <title>PaySDD Template</title>

             <script>Your JavaScript</script>

       </head>

       <body>

       <form action="https://www.computop-paygate.com/payinterim.aspx" methode="POST">
       Your form with hidden fields and xsl-tags

       </form>

       </body>

</html>

</xsl:template>


In order to read the texts from the XML file, first of all create your tags in the desired language sections with the texts:

       <language name="de">

             <strIBAN>IBAN</strIBAN>

       </language>


Subsequently, replace the text in the HTML by a reference to the respective section in the XML file:

<xsl:value-of select="/template/language/strIBAN"/>


In order to test your template, we request that you integrate the following lines in your XML file only for the test (before sending it to Computop) and afterwards to call up the XML file in a browser. If no error is displayed you can send your template and the image folder in a Zip file to Computop Helpdesk with a request to check and install it.

<?xml version="1.0" encoding="UTF-16"?>

<?xml-stylesheet type="text/xsl" href="templatename.xsl"?>

<template>

       <languages>please omit for your layout tests

             <language name="de">

             </language>

             <language name="en">

             </language>

       <languages>please omit for your layout tests

</template>


In order to get an overview of the versions, please include the date and version number in the name of your Zip file.


General parameters of the interface

The interface of the Paygate form is consistently paysdd.aspx for all connections. In order to make a direct debit payment via Paygate form, please use the following URL:

https://www.computop-paygate.com/paysdd.aspx

 

This section explains the parameters which are the same for each connection. These values are always required, along with the special parameters explained in the following sections for each individual connection. The second table explains all response parameters which are also the same for all direct debit connections.

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

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

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.

Key

REST

Format

CND

Description

Beschreibung

TransID

"transactionId": "..."

ans..64

M

TransactionID which should be unique for each payment

When using auto-mandate (filling-in of MandateID with TransID or RefNr) the permitted character set is that of the MandateID parameter.

TransaktionsID, die für jede Zahlung eindeutig sein muss

Bei Nutzung von Automandat (Befüllen von MandateID mit TransID oder RefNr) gilt der erlaubte Zeichensatz des Parameters MandateID.

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "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

KeyRESTFormatCNDDescriptionBeschreibung

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:

KeyRESTFormatCNDDescriptionBeschreibung
ReqId"requestId": "..."

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.

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

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

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

KeyRESTFormatCNDDescriptionBeschreibung
URLSuccess"urls": {"success": "..."}

ans..256

M

Complete URL which calls up Paygate if payment has been successful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Vollständige URL, die das Paygate aufruft, wenn die Zahlung erfolgreich war. Die URL darf nur über Port 443 aufgerufen werden. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen nutzen Sie stattdessen den Parameter UserData.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

KeyRESTFormatCNDDescriptionBeschreibung
URLFailure"urls": {"failure": "..."}

ans..256

M

Complete URL which calls up Paygate if payment has been unsuccessful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Vollständige URL, die das Paygateaufruft, wenn die Zahlung gescheitert ist. Die URL darf nur über Port 443 aufgerufen werden. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen nutzen Sie stattdessen den Parameter UserData.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

KeyRESTFormatCNDDescriptionBeschreibung
Response

---

a7

O

Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.

Die Status-Rückmeldung, die das Paygate an URLSuccess und URLFailure sendet, sollte verschlüsselt werden. Dazu übergeben Sie den Parameter Response=encrypt.

KeyRESTFormatCNDDescriptionBeschreibung
URLNotify"urls": {"notify": "..."}

ans..256

M

Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443. It may not contain parameters: Use the UserData parameter instead.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Vollständige URL, die das Paygate aufruft, um den Shop zu benachrichtigen. Die URL darf nur über Port 443 aufgerufen werden. Sie darf keine Parameter enthalten: Nutzen Sie stattdessen den Parameter UserData.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

Key

REST

Format

CND

Description

Beschreibung





(info) In case of a direct debit payment and in the event of incorrect entries by the customer, one or more retries can be made directly on the Paygate form. The peculiarity here is that per payment attempt the shop receives a URLNotify call directly after execution. For that reason it is possible that the shop can receive e.g. 3 Notifies with an identical PayID and thereby different statuses can occur which must be processed accordingly.

(info) Im Fall einer Lastschrift-Zahlung und bei fehlerhaften Eingaben des Kunden können auf dem Paygate-Formular direkt ein bzw. mehrere Wiederholversuche stattfinden. Die Besonderheit ist hier, dass der Shop pro Zahlungsversuch direkt nach der Ausführung einen URLNotify-Aufruf erhält. Somit kann es sein, dass der Shop z.B. 3 Notifies mit identischer PayID erhält und dabei können unterschiedliche Status auftreten, welche entsprechend verarbeitet werden müssen.

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

KeyRESTFormatCNDDescriptionBeschreibung
Capture

"capture": {"auto": "Yes"}

"capture": {"manual": "Yes"}

"capture": ...


an..6

OM

Determines the type and time of capture.

Capture ModeDescription
AUTOCapturing immediately after authorisation (default value).
MANUALCapturing made by the merchant. Capture is normally initiated at time of delivery.
<Number>Delay in hours until the capture (whole number; 1 to 696).

Bestimmt Art und Zeitpunkt der Buchung (engl. Capture).

BuchungsartBeschreibung
AUTOBuchung sofort nach Autorisierung (Standardwert).
MANUALBuchung erfolgt durch den Händler - in der Regel die Buchung zum Zeitpunkt der Warenauslieferung bzw. Leistungserbringung.
<Zahl>Verzögerung in Stunden bis zur Buchung (ganze Zahl; 1 bis 696).

KeyRESTFormatCNDDescriptionBeschreibung
expirationTime"expirationTime": "..."

ans..19

O

timestamp for the end time of the transaction processing, specified in UTC.

Format: YYYY-MM-ddTHH:mm:ss

Zeitstempel für den Endzeitpunkt der Transaktionsverarbeitung, Angabe in UTC.

Format: YYYY-MM-ddTHH:mm:ss

KeyRESTFormatCNDDescriptionBeschreibung
Plain"metadata[plain]": "..."

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. 

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. 

Ein einzelner Wert, der von Ihnen gesetzt werden kann, um Informationen wieder unverschlüsselt in der Antwort bzw. im Notify zurückzugeben, z.B. die MID.

Da der "Plain"-Parameter Teil des verschlüsselten "Data" im Computop Paygate ist, ist dieser vor Manipulationen geschützt. 

KeyRESTFormatCND

Description

Beschreibung
Custom"metadata": "..."

ans..1024

O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose. 

Please find a samples here: Custom

Der "Custom"-Parameter wird vor der Verschlüsselung an den Aufruf angehängt und ist Teil des verschlüsselten "Data" im Computop Paygate Aufruf. Dadurch ist der Wert gegen Manipulation geschützt. 

Der Custom-Wert wird dann in Klartext an die Computop Paygate-Antwort angehängt und dabei wird "|" durch "&" ersetzt. Dadurch können Sie einen Custom-Wert übergeben und bekommen mehrere Key-Value-Paare zu Ihrer eigenen Verwendung in der Antwort zurück.

Hier finden Sie ein Beispiel: Custom

General parameters for direct debit payments via form



To adapt the layout of the SSL-page to your shop you can use the following unencrypted parameters to configure colours, fonts and images:

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

REST

Format

CND

Description

Beschreibung

AccBank

"payment": {"directDebitForm": { "account": {"name"= "..." }}}

ans..20

O

for the pre-completion of the direct debit form: Name of the account holder's bank

zur Vorbelegung des Lastschrift-Formulars: Name des Kreditinstituts des Kontoinhabers

AccOwner

"payment": {"directDebitForm": { "account": {"accountHolder"= "..." }}}

ans..50

O

for the pre-completion of the direct debit form: Name of account holder

zur Vorbelegung des Lastschrift-Formulars: Name des Kontoinhabers

IBAN

"payment": {"directDebitForm": { "account": {"number"= "..." }}}

ans..34

M

for the pre-completion of the SEPA form: International Bank Account Number

zur Vorbelegung des SEPA-Formulars: International Bank Account Number

BIC

"payment": {"directDebitForm": { "account": {"code"= "..." }}}

ans..11

O

for the pre-completion of the SEPA form: Bank Identifier Code

zur Vorbelegung des SEPA-Formulars: Bank Identifier Code

Language"language": "..."

a2

(enum)

M

Language code: <de> German, <al> Albanian, <at> Austrian, <cz/cs> Czech, <dk> Danish, <en> English, <fi> Finish, <fr> French, <gr> Greek, <hu> Hungarian, <it> Italian, <jp> Japanese,  <nl> Dutch, <no> Norwegian, <pl> Polish, <pt> Portuguese, <ro> Romanian, <ru> Russian, <sp> Spanish, <se> Swedish, <sk> Slovakian, <sl> Slovenian, <tr> Turkey, <zh> Simplified Chinese.

No details means the language is German.

Sprachcode: <de> deutsch, <al> albanisch, <at> österreichisch, <cz/cs> tschechisch, <dk> dänisch, <en> englisch, <fi> finnisch, <fr> französisch, <gr> griechisch, <hu> ungarisch, <it> italienisch, <jp> japanisch, <nl> holländisch, <no> norwegisch, <pl> polnisch, <pt> portugiesisch, <ro> rumänisch, <ru> russisch, <tr> türkisch, <sp> spanisch, <se> schwedisch, <sk> slowakisch, <sl> slowenisch, <tr> türkisch, <zh> Simplified Chinese

Ohne Angabe ist die Sprache Deutsch.

KeyRESTFormatCNDDescriptionBeschreibung
Template

"payment": {"cardForm": { "template": {"name"= "..." }}}

"payment": {"directDebitForm": { "template": {"name"= "..." }}}

ans..20

O

Name of XSLT-file with your own layout for the pay form. If you want to use the redesigned and downwards compatible Computop template, please transfer the template name “ct_compatible”. If you want to use the responsive Computop template for mobile devices, please transfer the template name “ct_responsive”.

Name der XSLT-Datei mit Ihrem individuellen Layout für das Bezahlformular. Wenn Sie das neugestaltete und abwärtskompatible Computop-Template nutzen möchten, übergeben Sie den Templatenamen „ct_compatible“. Wenn Sie das responsive Computop-Template für mobile Endgeräte nutzen möchten, übergeben Sie den Templatenamen „ct_responsive“.

KeyRESTFormatCNDDescriptionBeschreibung
Background

"payment": {"cardForm": { "template": {"background"= "..." }}}

"payment": {"directDebitForm": { "template": {"background"= "..." }}}

ans..256

O

Background ambiance of form:

URL for a background image

- HTML-colour value for background colour as HEX value or

- HTML-colour name

Formular Hintergrundumgebung:

- URL für ein Hintergrundbild

- HTML-Farbwert für Hintergrundfarbe als HEX-Wert oder

- HTML-Farbname

KeyRESTFormatCNDDescriptionBeschreibung
BGColor

"payment": {"cardForm": { "template": {"backgroundColour"= "..." }}}

"payment": {"directDebitForm": { "template": {"backgroundColour"= "..." }}}

ans..7

O

Form background colour:

- HTML-colour value for background colour as HEX value or

- HTML-colour name

Formular Hintergrundfarbe:

- HTML-Farbwert für Hintergrundfarbe als HEX-Wert oder

- HTML-Farbname

KeyRESTFormatCNDDescriptionBeschreibung
BGImage

"payment": {"cardForm": { "template": {"backgroundImage"= "..." }}}

"payment": {"directDebitForm": { "template": {"backgroundImage"= "..." }}}

ans..256

O

Form background image:

URL for a background image

Please note that this value supersedes “BGColor”.

Formular Hintergrundbild:

URL für ein Hintergrundbild

Beachten Sie bitte, dass dieser Wert „BGColor“ überschreibt.

KeyRESTFormatCNDDescriptionBeschreibung
FColor

"payment": {"cardForm": { "template": {"textColour"= "..." }}}

"payment": {"directDebitForm": { "template": {"textColour"= "..." }}}

ans..7
O

Text colour:

- HTML-colour value as HEX value or

- HTML-colour name

Textfarbe:

- HTML-Farbwert als HEX-Wert oder

- HTML-Farbname

KeyRESTFormatCNDDescriptionBeschreibung
FFace

"payment": {"cardForm": { "template": {"fontName"= "..." }}}

"payment": {"directDebitForm": { "template": {"fontName"= "..." }}}

a..10
O
HTML-name for the font

HTML-Name der Schriftart

KeyRESTFormatCNDDescriptionBeschreibung
FSize

"payment": {"cardForm": { "template": {"fontSize"= ... }}}

"payment": {"directDebitForm": { "template": {"fontSize"= ... }}}

n2
O
Number for font size

Zahl für die Schriftgröße

KeyRESTFormatCNDDescriptionBeschreibung
URLBack"urls": {"cancel": "..."}

ans..256

O

Complete URL which Paygate calls in case that Cancel is clicked by the customer.

The parameter "URLBack" can be sent

  • either as plain parameter (unencrypted) (compatibility mode)
  • or be part of encrypted payment request parameters (preferred mode)

In order to exchange values between Paygate and shop you may use something like this:

URLBack=https://your.shop.com/back.php?param1%3Dvalue1%26param2%3Dvalue3%26status%3Dcancelled 

When user cancels payment this URL is called exactly like this and you may use URL Decode to extract parameter and values.

Vollständige URL, die das Paygate aufruft, wenn der Kunde auf Abbruch klickt.

Der Parameter "URLBack" kann

  • sowohl unverschlüsselt ans Paygate übermittelt werden (Kompabilitätsmodus)
  • als auch in den verschlüsselten Übergabeparametern (bevorzugte Variante)

Wenn Sie Parameter/Werte in der URLBack übergeben möchten, so können Sie folgende Methode verwenden:

URLBack=https://your.shop.com/back.php?param1%3Dvalue1%26param2%3Dvalue3%26status%3Dcancelled 

Wenn der Kunde auf Abbruch klickt, so wird die URL genauso aufgerufen, so dass Sie URL Decode verwenden können, um Parameter und Werte zu extrahieren.

KeyRESTFormatCNDDescriptionBeschreibung
tWidth

payment": {"cardForm": { "template": {"tableWidth"= "..." }}}

payment": {"directDebitForm": { "template": {"tableWidth"= "..." }}}

ans..4

O
Width of table for input in the form as percent- (50%) or pixel values (320).

Breite der Tabelle im Eingabeformular als Prozent- (50%) oder Pixelwerte (320)

KeyRESTFormatCNDDescriptionBeschreibung
tHeight

"payment": {"cardForm": { "template": {"tableHeighth"= "..." }}}

"payment": {"directDebitForm": { "template": {"tableHeighth"= "..." }}}

ans..4

O
Height of table for input of the payment data in the form as percent- (70%) or pixel values (480).

Höhe der Tabelle für die Eingabe der Bezahldaten im Formular als Prozent- (70%) oder Pixelwerte (480)

KeyRESTFormatCNDDescriptionBeschreibung
CustomField[n]"payment": {"directDebitForm": { "template": {"customField"= OBJECT }}}

ans..50

O
Merchants can customize up to 14 special fields (called CustomField1 to CustomField14) on their payment form template. CustomFields are a feature that allows you to show additional information such as your logo, order details and customer details on the payment form.
Special characters (like &, ', <, >) are not allowed - even not "urlencoded".
The usage / display of CustomField{n] depends on the template that is used.
Händler können bis zu 14 spezielle Felder (genannt CustomField1 bis CustomField14) in ihrer Zahlungsformularvorlage anpassen. CustomFields sind eine Funktion, mit der Sie zusätzliche Informationen wie Ihr Logo, Bestelldetails und Kundendetails auf dem Zahlungsformular anzeigen können.
Sonderzeichen (wie &, ', <, >) sind nicht erlaubt - auch nicht "urlencoded".
Die Verwendung bzw. Darstellung der CustomField{n] ist abhängig vom verwendeten Template.

Layout parameters for Paygate forms for direct debit payments



In case of using REST API

In case of using REST API you will always receive a link where the merchant has to redirect the consumer to complete the payment.

RESTFormatCNDDescription

"paymentId": "..."

an32M

May be "00000000000000000000000000000000" if not yet set by Computop Paygate

"_Links.self.type": "..."an..20M

"application/json"

"_Links.redirect.href": "..."an..1024MMerchant needs to redirect consumer to this URL to complete payment
"_Links.redirect.type": "..."an..20M"text/html"

Merchant can use inquire.aspx

In case of using Key-Value-Pair API

The following table gives the result parameters which Computop Paygate transmits to URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted 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 or PENDING (URLSuccess) as well as FAILED (URLFailure)

OK oder PENDING (URLSuccess) sowie 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

IBAN

ans..34

OC

only without PBAN configuration: International Bank Account Number

nur ohne PBAN-Konfiguration: International Bank Account Number

BIC

ans..11

O

Bank Identifier Code

Bank Identifier Code

AccOwner

ans..50

O

Name of account holder

Name des Kontoinhabers

AccBank

ans..20

O

Name of the financial institute of the account holder

Name des Kreditinstituts des Kontoinhabers

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
UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

KeyFormatCNDDescriptionBeschreibung
Plain

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. 

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. 

Ein einzelner Wert, der von Ihnen gesetzt werden kann, um Informationen wieder unverschlüsselt in der Antwort bzw. im Notify zurückzugeben, z.B. die MID.

Da der "Plain"-Parameter Teil des verschlüsselten "Data" im Computop Paygate ist, ist dieser vor Manipulationen geschützt. 

KeyFormatCND

Description

Beschreibung
Custom

ans..1024

O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose. 

Please find a samples here: Custom

Der "Custom"-Parameter wird vor der Verschlüsselung an den Aufruf angehängt und ist Teil des verschlüsselten "Data" im Computop Paygate Aufruf. Dadurch ist der Wert gegen Manipulation geschützt. 

Der Custom-Wert wird dann in Klartext an die Computop Paygate-Antwort angehängt und dabei wird "|" durch "&" ersetzt. Dadurch können Sie einen Custom-Wert übergeben und bekommen mehrere Key-Value-Paare zu Ihrer eigenen Verwendung in der Antwort zurück.

Hier finden Sie ein Beispiel: Custom

Key

Format

CND

Description

Beschreibung

CustomField[n]ans..50O
Merchants can customize up to 14 special fields (called CustomField1 to CustomField14) on their payment form template. CustomFields are a feature that allows you to show additional information such as your logo, order details and customer details on the payment form.
Special characters (like &, ', <, >) are not allowed - even not "urlencoded".
The usage / display of CustomField{n] depends on the template that is used.
Händler können bis zu 14 spezielle Felder (genannt CustomField1 bis CustomField14) in ihrer Zahlungsformularvorlage anpassen. CustomFields sind eine Funktion, mit der Sie zusätzliche Informationen wie Ihr Logo, Bestelldetails und Kundendetails auf dem Zahlungsformular anzeigen können.
Sonderzeichen (wie &, ', <, >) sind nicht erlaubt - auch nicht "urlencoded".
Die Verwendung bzw. Darstellung der CustomField{n] ist abhängig vom verwendeten Template.

General results parameters for URLNotify, URLSuccess and URLFailure



Direct connection

In addition to the general parameters described above for the direct debit connection the following parameters need to be transmitted via form.

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

KeyRESTFormatCNDDescriptionBeschreibung
refnr"referenceNumber": "..."

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyREST

Format

CND

Description

Beschreibung

OrderDesc

"order": {"description[0]": "..."}

ans..384

M

Description of purchased goods, unit prices etc. The first 27 characters appear on the customer-account statement. You can view the full data in Computop Analytics.

Beschreibung der gekauften Waren, Einzelpreise etc. Die ersten 27 Zeichen erscheinen auf dem Kontoauszug des Kunden. In Computop Analytics können Sie die kompletten Daten einsehen.

OrderDesc2

"order": {"description[1]": "..."}

ans..384

M

2. Goods description which appears on the account extract (27 characters). You can view the full data in Computop Analytics.

2. Zeile der Warenbeschreibung, die auf dem Kontoauszug erscheint (27 Zeichen). In Computop Analytics können Sie die kompletten Daten einsehen.

KeyRESTFormatCNDDescriptionBeschreibung
Capture

"capture": {"auto": "Yes"}

"capture": {"manual": "Yes"}

"capture": ...


an..6

OM

Determines the type and time of capture.

Capture ModeDescription
AUTOCapturing immediately after authorisation (default value).
MANUALCapturing made by the merchant. Capture is normally initiated at time of delivery.
<Number>Delay in hours until the capture (whole number; 1 to 696).

Bestimmt Art und Zeitpunkt der Buchung (engl. Capture).

BuchungsartBeschreibung
AUTOBuchung sofort nach Autorisierung (Standardwert).
MANUALBuchung erfolgt durch den Händler - in der Regel die Buchung zum Zeitpunkt der Warenauslieferung bzw. Leistungserbringung.
<Zahl>Verzögerung in Stunden bis zur Buchung (ganze Zahl; 1 bis 696).

KeyRESTFormatCNDDescriptionBeschreibung
MandateID

"payment": { "mandateId": "..."}

"payment": {"directDebitForm": { "mandate": {"mandateId"= "..." }}}

ans..35

C

for SEPA: SEPA mandate number (compulsory in the case of SEPA)

should be unique, is not case-sensitive

Permissible characters: numbers 0-9, upper case letters A-Z, lower case letters a-z, apostrophe, colon, question mark, comma, full stop, plus sign, minus sign, forward slash, left and right bracket

für SEPA: SEPA-Mandatsnummer (Pflicht bei SEPA)

sollte eindeutig sein, ist nicht case-sensitive

Zulässige Zeichen: Ziffern 0-9, Großbuchstaben A-Z, Kleinbuchstaben a-z, Apostroph, Doppelpunkt, Fragezeichen, Komma, Punkt, Pluszeichen, Minuszeichen, Schrägstrich, linke und rechte Klammer

KeyRESTFormatCNDDescriptionBeschreibung
DtOfSgntr"payment": {"directDebitForm": { "mandate": {"dateOfSignature"= "..." }}}

ans..10

O
for SEPA: Date of issuing the mandate in the format DD.MM.YYYY (obligatory when transferring the MandateID)
für SEPA: Datum der Mandatserteilung im Format DD.MM.YYYY (Pflicht bei Übergabe von MandateID)

KeyRESTFormatCNDDescriptionBeschreibung
MdtSeqTypepayment": {"directDebitForm": { "mandate": {"mandateSequenceType"= "..." }}}

ans..4

O

for SEPA: Indicates whether the direct debit is a first, recurring, one-off or final direct debit.

Permissible values: FRST, RCUR, OOFF, FNAL

Standard: OOFF (single direct debit)

für SEPA: Gibt an, ob es sich um eine Erst-, Folge-, Einmal- oder letztmalige Lastschrift handelt.

Zulässige Werte: FRST, RCUR, OOFF, FNAL

Standard: OOFF (Einmal-Lastschrift)

KeyRESTFormatCNDDescriptionBeschreibung
PBAN

"payment": { "pseudoBankNumber": "..."}

"payment": {"directDebit": { "account": {"pseudoBankNumber"= "..." }}}

ans..27

O
for SEPA: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number
für SEPA: PseudoBankNumber. Die letzten drei Stellen sind identisch zu den letzten drei Stellen der IBAN

Additional parameters for the direct debit connection via Paygate form


In case of using REST API

In case of using REST API you will always receive a link where the merchant has to redirect the consumer to complete the payment.

RESTFormatCNDDescription

"paymentId": "..."

an32M

May be "00000000000000000000000000000000" if not yet set by Computop Paygate

"_Links.self.type": "..."an..20M

"application/json"

"_Links.redirect.href": "..."an..1024MMerchant needs to redirect consumer to this URL to complete payment
"_Links.redirect.type": "..."an..20M"text/html"

Merchant can use inquire.aspx

In case of using Key-Value-Pair API

The following table gives the result parameters which Computop Paygate transmits to URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted 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
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyFormatCNDDescriptionBeschreibung
MandateID

ans..35

C

for SEPA: SEPA mandate number (compulsory in the case of SEPA)

should be unique, is not case-sensitive

Permissible characters: numbers 0-9, upper case letters A-Z, lower case letters a-z, apostrophe, colon, question mark, comma, full stop, plus sign, minus sign, forward slash, left and right bracket

für SEPA: SEPA-Mandatsnummer (Pflicht bei SEPA)

sollte eindeutig sein, ist nicht case-sensitive

Zulässige Zeichen: Ziffern 0-9, Großbuchstaben A-Z, Kleinbuchstaben a-z, Apostroph, Doppelpunkt, Fragezeichen, Komma, Punkt, Pluszeichen, Minuszeichen, Schrägstrich, linke und rechte Klammer

KeyFormatCNDDescriptionBeschreibung
DtOfSgntr

ans..10

O
for SEPA: Date of issuing the mandate in the format DD.MM.YYYY (obligatory when transferring the MandateID)
für SEPA: Datum der Mandatserteilung im Format DD.MM.YYYY (Pflicht bei Übergabe von MandateID)

KeyFormatCNDDescriptionBeschreibung
MdtSeqType

ans..4

O

for SEPA: Indicates whether the direct debit is a first, recurring, one-off or final direct debit.

Permissible values: FRST, RCUR, OOFF, FNAL

Standard: OOFF (single direct debit)

für SEPA: Gibt an, ob es sich um eine Erst-, Folge-, Einmal- oder letztmalige Lastschrift handelt.

Zulässige Werte: FRST, RCUR, OOFF, FNAL

Standard: OOFF (Einmal-Lastschrift)

KeyFormatCNDDescriptionBeschreibung
PBAN

ans..27

O
for SEPA: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number
für SEPA: PseudoBankNumber. Die letzten drei Stellen sind identisch zu den letzten drei Stellen der IBAN

Additional result parameters for URLNotify, URLSuccess and URLFailure in case of direct connection



EVO Payments

Besides general parameters for direct debit connection via EVO Payments additionally the following parameters need to be transmitted via form.

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

Key

REST

Format

CND

Description

Beschreibung

EDDMethod

"payment": {"method": "..."}

a3

O

Direct debit in Germany:=ELV, Netherlands=ENL, Austria=EEV

Lastschrift in Deutschland=ELV, Niederlande=ENL, Österreich=EEV

OrderDesc

"order": {"description[0]": "..."}

ans..384

M

Description of purchased goods, unit prices etc. The first 27 characters appear on the customer-account statement. You can view the full data in Computop Analytics.

Beschreibung der gekauften Waren, Einzelpreise etc. Die ersten 27 Zeichen erscheinen auf dem Kontoauszug des Kunden. In Computop Analytics können Sie die kompletten Daten einsehen.

OrderDesc2

"order": {"description[1]": "..."}

ans..384

M

2. Goods description which appears on the account extract (27 characters). You can view the full data in Computop Analytics.

2. Zeile der Warenbeschreibung, die auf dem Kontoauszug erscheint (27 Zeichen). In Computop Analytics können Sie die kompletten Daten einsehen.

SubSeqType

"payment": {"directDebitForm": { "mandate": {"subSequenceType"= "..." }}}

a4

O

for SEPA: indicates type of (following) direct debit (FRST, RCUR, OOFF, FNAL permissible)

für SEPA: gibt Typ der (Folge-) Lastschrift an (FRST, RCUR, OOFF, FNAL zulässig)

DebitDelay

"payment": {"directDebitForm": { "debitDelay": ... }}

n..3

M

for SEPA: Number of bank working days >0 which has to be added for the execution date of direct debit

für SEPA: Anzahl Banktage>0, die für das Ausführungsdatum einer Lastschrift zum aktuellen Datum addiert werden

CreditDelay

"payment": {"directDebitForm": { "creditDelay": ... }}

n..3

O

for SEPA: Number of bank working days >0 which has to be added for the execution date of a credit

für SEPA: Anzahl Banktage>0, die für das Ausführungsdatum einer Gutschrift zum aktuellen Datum addiert werden

KeyRESTFormatCNDDescriptionBeschreibung
MandateID

"payment": { "mandateId": "..."}

"payment": {"directDebitForm": { "mandate": {"mandateId"= "..." }}}

ans..35

C

for SEPA: SEPA mandate number (compulsory in the case of SEPA)

should be unique, is not case-sensitive

Permissible characters: numbers 0-9, upper case letters A-Z, lower case letters a-z, apostrophe, colon, question mark, comma, full stop, plus sign, minus sign, forward slash, left and right bracket

für SEPA: SEPA-Mandatsnummer (Pflicht bei SEPA)

sollte eindeutig sein, ist nicht case-sensitive

Zulässige Zeichen: Ziffern 0-9, Großbuchstaben A-Z, Kleinbuchstaben a-z, Apostroph, Doppelpunkt, Fragezeichen, Komma, Punkt, Pluszeichen, Minuszeichen, Schrägstrich, linke und rechte Klammer

KeyRESTFormatCNDDescriptionBeschreibung
DtOfSgntr"payment": {"directDebitForm": { "mandate": {"dateOfSignature"= "..." }}}

ans..10

O
for SEPA: Date of issuing the mandate in the format DD.MM.YYYY (obligatory when transferring the MandateID)
für SEPA: Datum der Mandatserteilung im Format DD.MM.YYYY (Pflicht bei Übergabe von MandateID)

KeyRESTFormatCNDDescriptionBeschreibung
MdtSeqTypepayment": {"directDebitForm": { "mandate": {"mandateSequenceType"= "..." }}}

ans..4

O

for SEPA: Indicates whether the direct debit is a first, recurring, one-off or final direct debit.

Permissible values: FRST, RCUR, OOFF, FNAL

Standard: OOFF (single direct debit)

für SEPA: Gibt an, ob es sich um eine Erst-, Folge-, Einmal- oder letztmalige Lastschrift handelt.

Zulässige Werte: FRST, RCUR, OOFF, FNAL

Standard: OOFF (Einmal-Lastschrift)

KeyRESTFormatCNDDescriptionBeschreibung
PBAN

"payment": { "pseudoBankNumber": "..."}

"payment": {"directDebit": { "account": {"pseudoBankNumber"= "..." }}}

ans..27

O
for SEPA: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number
für SEPA: PseudoBankNumber. Die letzten drei Stellen sind identisch zu den letzten drei Stellen der IBAN

Additional parameters for the direct debit connection EVO Payments via Paygate form


In case of using REST API

In case of using REST API you will always receive a link where the merchant has to redirect the consumer to complete the payment.

RESTFormatCNDDescription

"paymentId": "..."

an32M

May be "00000000000000000000000000000000" if not yet set by Computop Paygate

"_Links.self.type": "..."an..20M

"application/json"

"_Links.redirect.href": "..."an..1024MMerchant needs to redirect consumer to this URL to complete payment
"_Links.redirect.type": "..."an..20M"text/html"

Merchant can use inquire.aspx

In case of using Key-Value-Pair API

The following table gives the result parameters which Computop Paygate transmits to URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted 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
MandateID

ans..35

C

for SEPA: SEPA mandate number (compulsory in the case of SEPA)

should be unique, is not case-sensitive

Permissible characters: numbers 0-9, upper case letters A-Z, lower case letters a-z, apostrophe, colon, question mark, comma, full stop, plus sign, minus sign, forward slash, left and right bracket

für SEPA: SEPA-Mandatsnummer (Pflicht bei SEPA)

sollte eindeutig sein, ist nicht case-sensitive

Zulässige Zeichen: Ziffern 0-9, Großbuchstaben A-Z, Kleinbuchstaben a-z, Apostroph, Doppelpunkt, Fragezeichen, Komma, Punkt, Pluszeichen, Minuszeichen, Schrägstrich, linke und rechte Klammer

KeyFormatCNDDescriptionBeschreibung
DtOfSgntr

ans..10

O
for SEPA: Date of issuing the mandate in the format DD.MM.YYYY (obligatory when transferring the MandateID)
für SEPA: Datum der Mandatserteilung im Format DD.MM.YYYY (Pflicht bei Übergabe von MandateID)

KeyFormatCNDDescriptionBeschreibung
MdtSeqType

ans..4

O

for SEPA: Indicates whether the direct debit is a first, recurring, one-off or final direct debit.

Permissible values: FRST, RCUR, OOFF, FNAL

Standard: OOFF (single direct debit)

für SEPA: Gibt an, ob es sich um eine Erst-, Folge-, Einmal- oder letztmalige Lastschrift handelt.

Zulässige Werte: FRST, RCUR, OOFF, FNAL

Standard: OOFF (Einmal-Lastschrift)

KeyFormatCNDDescriptionBeschreibung
PBAN

ans..27

O
for SEPA: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number
für SEPA: PseudoBankNumber. Die letzten drei Stellen sind identisch zu den letzten drei Stellen der IBAN

Additional result parameters for URLNotify, URLSuccess and URLFailure in case of EVO Payments connection



InterCard

Direct debit via Intercard does not offer payment protection. If you want to use a direct debit with payment protection, you must order and implement the payment method PayMorrow from Intercard.

Besides general parameters for direct debit connection via InterCard additionally the following parameters need to be transmitted via form.

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

KeyRESTFormatCNDDescriptionBeschreibung
MandateID

"payment": { "mandateId": "..."}

"payment": {"directDebitForm": { "mandate": {"mandateId"= "..." }}}

ans..35

C

for SEPA: SEPA mandate number (compulsory in the case of SEPA)

should be unique, is not case-sensitive

Permissible characters: numbers 0-9, upper case letters A-Z, lower case letters a-z, apostrophe, colon, question mark, comma, full stop, plus sign, minus sign, forward slash, left and right bracket

für SEPA: SEPA-Mandatsnummer (Pflicht bei SEPA)

sollte eindeutig sein, ist nicht case-sensitive

Zulässige Zeichen: Ziffern 0-9, Großbuchstaben A-Z, Kleinbuchstaben a-z, Apostroph, Doppelpunkt, Fragezeichen, Komma, Punkt, Pluszeichen, Minuszeichen, Schrägstrich, linke und rechte Klammer

KeyRESTFormatCNDDescriptionBeschreibung
DtOfSgntr"payment": {"directDebitForm": { "mandate": {"dateOfSignature"= "..." }}}

ans..10

O
for SEPA: Date of issuing the mandate in the format DD.MM.YYYY (obligatory when transferring the MandateID)
für SEPA: Datum der Mandatserteilung im Format DD.MM.YYYY (Pflicht bei Übergabe von MandateID)

KeyRESTFormatCNDDescriptionBeschreibung
PBAN

"payment": { "pseudoBankNumber": "..."}

"payment": {"directDebit": { "account": {"pseudoBankNumber"= "..." }}}

ans..27

O
for SEPA: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number
für SEPA: PseudoBankNumber. Die letzten drei Stellen sind identisch zu den letzten drei Stellen der IBAN

Key

REST

Format

CND

Description

Beschreibung

OrderDesc

"order": {"description[0]": "..."}

ans..384

M

Description of purchased goods, unit prices etc. The first 27 characters appear on the customer-account statement. You can view the full data in Computop Analytics.

Beschreibung der gekauften Waren, Einzelpreise etc. Die ersten 27 Zeichen erscheinen auf dem Kontoauszug des Kunden. In Computop Analytics können Sie die kompletten Daten einsehen.

RefNr

"referenceNumber": "..."

ns..30

O

Merchant’s unique reference number

When using auto-mandate (filling-in of MandateID with TransID or RefNr) the permitted character set is that of the MandateID parameter.

Referenznummer des Händlers

Bei Nutzung von Automandat (Befüllen von MandateID mit TransID oder RefNr) gilt der erlaubte Zeichensatz des Parameters MandateID.

CustomerID

"billing": {"consumer": { "consumerId": "..." }}

ans..30

M

Customer number at the merchant

Kundennummer beim Händler

DateOfRegistration

"accountInfo": {"creationDate": "..."}

dttm8

O

Customer since in the format YYYYMMDD

Kunde seit im Format JJJJMMTT

CustomerClassification


ans..20

O

(business / private)

(business / private)

eMail

"billing": {"contactInfo": { "email": "..." }}

ans..80

O

E-mail address

E-Mail-Adresse

DateOfBirth

"billing": {"consumer": { "birthDate": "..." }}

dttm8

O

Date of birth in the format YYYYMMDD

Geburtsdatum im Format JJJJMMTT

bdSalutation

"billing": {"consumer": { "salutation": "..." }}

ans...4

O

Salutation of the invoicing address

Anrede der Rechnungsanschrift

bdFirstName

"billing": {"consumer": { "firstName": "..." }}

ans..30

M

First name of the invoicing address

Vorname der Rechnungsanschrift

bdLastName

"billing": {"consumer": { "lastName": "..." }}

ans..30

M

Last name of the invoicing address

Nachname der Rechnungsanschrift

bdStreet

"billing": {"addressInfo": { "addressLine1": {"street"= "..." }}}

a..50

M

Street name of the invoicing address

Straßenname der Rechnungsanschrift

bdStreetNr

"billing": {"addressInfo": { "addressLine1": {"streetNumber"= "..." }}}

ans..5

M

Street number of the invoicing address

Hausnummer der Rechnungsanschrift

bdCountryCode

"billing": {"addressInfo": { "country": {"A2"= "..." }}}

a2

O

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

Ländercode der Rechnungsanschrift, zweistellig gemäß ISO 3166

bdZip

"billing": {"addressInfo": { "postalCode": "..." }}

n..5

M

Postcode of the invoicing address

Postleitzahl der Rechnungsanschrift

bdCity

"billing": {"addressInfo": { "city": "..." }}

a..32

M

Town or city of the invoicing address

Ortsname der Rechnungsanschrift

bdPhone

"billing": {"contactInfo": { "phone": "..." }}

ans..15

O

Phone number in the invoicing address

Telefonnummer der Rechnungsanschrift

bdFax

"billing": {"contactInfo": { "fax": "..." }}

ans..20

O

Fax number of the invoicing address

Faxnummer der Rechnungsanschrift

bdMaidenName

"billing": {"consumer": { "maidenName": "..." }}

ans..30

O

Maiden name of the invoicing address

Geburtsname der Rechnungsanschrift

UseBillingData


a..3

O

Is the invoicing address to be used as the delivery address?

<Yes> or <No>.

If <Yes> no parameters are transferred for the delivery address, if <No> they are obligatory.  Standard=Yes

Soll Rechnungsadresse als Lieferadresse genutzt werden?

<Yes> oder <No>.

Bei <Yes> werden keine Parameter zur Lieferadresse übergeben, bei <No> sind sie Pflicht.  Standard=Yes

sdSalutation

"shipping": {"consumer": { "salutation": "..." }}

ans...4

O

Salutation in the delivery address

Anrede der Lieferadresse

sdFirstName

"shipping": {"consumer": { "firstName": "..." }}

ans..30

O

First name in the delivery address

Vorname der Lieferadresse

sdLastName

"shipping": {"consumer": { "lastName": "..." }}

ans..30

O

Last name in the delivery address

Nachname der Lieferadresse

sdStreet

"shipping": {"addressInfo": { "addressLine1": {"street"= "..." }}}

a..50

O

Street in the delivery address

Straßenname der Lieferadresse

sdStreetNr

"shipping": {"addressInfo": { "addressLine1": {"streetNumber"= "..." }}}

ans..5

O

Street number of the delivery address

Hausnummer der Lieferadresse

sdCountryCode

"shipping": {"addressInfo": { "country": {"A2"= "..." }}}

a2

O

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

Ländercode der Lieferadresse, zweistellig gemäß ISO 3166

sdZip

"shipping": {"addressInfo": { "postalCode": "..." }}

n..5

O

Postcode in the delivery address

Postleitzahl der Lieferadresse

sdCity

"shipping": {"addressInfo": { "city": "..." }}

a..50

O

Town/city in the delivery address

Ortsname der Lieferadresse

RegularCustomerIndicator


a..5

O

Regular customer (true / false)

Stammkunde (true / false)

ShoppingBasket


ans..1024

O

Customer order information (prices each in the smallest currency unit):

- invoice number / order number

- total net price, numerical

- total gross price

- net shipping costs

- gross shipping costs

- net discount

- gross discount

<;> separates the fields in the shopping basket

Example: InvoiceNumber;TotalNetPrice;TotalGrossPrice;NetShippingCosts;GrossShippingCosts;NetDiscount;GrossDiscount

Bestellinformation des Kunden (Preise je in kleinster Währungseinheit):

- Rechnungsnummer / Bestellnummer

- Gesamtpreis netto numerisch

- Gesamtpreis brutto

- Versandkosten netto

- Versandkosten brutto

- Rabatt netto

- Rabatt brutto

<;> trennt die Felder im Warenkorb

Beispiel: Rechnungsnummer;GesamtpreisNetto;GesamtpreisBrutto;VersandkostenNetto;VersandkostenBrutto;RabattNetto;RabattBrutto

ArticleList

"order": {"items": "..."}

ans..2048

C

Mandatory if shopping basket is transmitted: Shopping basket of the customer:

- article description (ans—50)

- quantity

- net article price

- gross article price

Note on the structure of the article list:

<;> separates fields in the article data set
<+> separates the article data sets

Each article is transferred as a complete article data set:

ArticleDescription;Quantity; ArticleName; NetArticlePrice;GrossArticlePrice + ArtcleDescription;Quantity;ArticleName;NetArticlePrice;GrossArticlePrice

Pflicht, wenn ShoppingBasket angegeben ist: Warenkorb des Kunden:

- Artikelbeschreibung (ans—50)

- Menge

- Artikelpreis netto

- Artikelpreis brutto

Hinweis zum Aufbau der Artikelliste:

<;> trennt Felder im Artikeldatensatz
<+> trennt die Artikeldatensätze

Jeder Artikel wird als kompletter Artikeldatensatz übergeben:

Artikelbeschreibung;Anzahl;Artikelname; ArtikelpreisNetto;ArtikelpreisBrutto + Artikelbeschreibung;Anzahl;Artikelname; ArtikelpreisNetto;ArtikelpreisBrutto

Additional parameters for the direct debit connection InterCard via Paygate form


In case of using REST API

In case of using REST API you will always receive a link where the merchant has to redirect the consumer to complete the payment.

RESTFormatCNDDescription

"paymentId": "..."

an32M

May be "00000000000000000000000000000000" if not yet set by Computop Paygate

"_Links.self.type": "..."an..20M

"application/json"

"_Links.redirect.href": "..."an..1024MMerchant needs to redirect consumer to this URL to complete payment
"_Links.redirect.type": "..."an..20M"text/html"

Merchant can use inquire.aspx

In case of using Key-Value-Pair API

The following table gives the result parameters which Computop Paygate transmits to URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted 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
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

Key

Format

CND

Description

Beschreibung

CodeExt

n..10

O

InterCard error code, only if agreed with Computop Helpdesk

Fehlercode von InterCard, wenn mit Computop Helpdesk abgesprochen

ErrorText

ans..128

C

InterCard error text.

Notice: Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk.

Fehlertext von InterCard.

Hinweis: Wird nur bei Status=FAILED zurückgegeben. Nutzung nur in Abstimmung mit dem Computop Helpdesk möglich.

KeyFormatCNDDescriptionBeschreibung
MandateID

ans..35

C

for SEPA: SEPA mandate number (compulsory in the case of SEPA)

should be unique, is not case-sensitive

Permissible characters: numbers 0-9, upper case letters A-Z, lower case letters a-z, apostrophe, colon, question mark, comma, full stop, plus sign, minus sign, forward slash, left and right bracket

für SEPA: SEPA-Mandatsnummer (Pflicht bei SEPA)

sollte eindeutig sein, ist nicht case-sensitive

Zulässige Zeichen: Ziffern 0-9, Großbuchstaben A-Z, Kleinbuchstaben a-z, Apostroph, Doppelpunkt, Fragezeichen, Komma, Punkt, Pluszeichen, Minuszeichen, Schrägstrich, linke und rechte Klammer

KeyFormatCNDDescriptionBeschreibung
DtOfSgntr

ans..10

O
for SEPA: Date of issuing the mandate in the format DD.MM.YYYY (obligatory when transferring the MandateID)
für SEPA: Datum der Mandatserteilung im Format DD.MM.YYYY (Pflicht bei Übergabe von MandateID)

KeyFormatCNDDescriptionBeschreibung
PBAN

ans..27

O
for SEPA: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number
für SEPA: PseudoBankNumber. Die letzten drei Stellen sind identisch zu den letzten drei Stellen der IBAN

Additional result parameters for URLNotify, URLSuccess and URLFailure in case of InterCard connection



PPRO

Besides general parameters for direct debit connection via PPRO additionally the following parameters need to be transmitted via form.

Notice: Please remind that the standard parameter OrderDesc will not be forwarded with PPRO.

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

Key

REST

Format

CND

Description

Beschreibung

RefNr

"referenceNumber": "..."

ans..40

O

Merchant’s unique reference number. Only characters a-zA-Z0-9,-_ are allowed.

When using auto-mandate (filling-in of MandateID with TransID or RefNr) the permitted character set is that of the MandateID parameter.

Referenznummer des Händlers. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt.

Bei Nutzung von Automandat (Befüllen von MandateID mit TransID oder RefNr) gilt der erlaubte Zeichensatz des Parameters MandateID.

KeyFormatCNDDescriptionBeschreibung

SellingPoint

ans..50

O

Selling point

Verkaufsstelle

KeyFormatCNDDescriptionBeschreibung

Service

ans..50

O

products or service sold

verkaufte Produkte oder Dienstleistung

KeyRESTFormatCNDDescriptionBeschreibung

Channel

"channel": {"code": "..."}

ans..64

O

Configuration channel of the PPRO contract (account and ContractID are stored in the system). If it exists, it may overwrite channels stored in the system.

Konfigurationskanal des PPRO-Vertrags (Account und ContractID sind im System hinterlegt). Wenn vorhanden, überschreibt er den eventuell im System hinterlegten Channel.

Key

REST

Format

CND

Description

Beschreibung
Language"language": "..."a2O2-letter language code (e.g. de) that should be preferred when presenting payment pages to the consumer2-stelliger Sprachcode (z.B. de), der für die Zahlungsseiten für den Kunden bevorzugt werden soll

Email

"billing": {"contactInfo": { "email": "..." }}

ans..100

M

E-Mail address of account holder

E-Mail-Adresse des Kontoinhabers

CustomerID

"billing": {"consumer": { "consumerId": "..." }}

ans..30

O

Customer number

Kundennummer

AddrCountryCode

"billing": {"addressInfo": { "country": {"A2"= "..." }}}

a2

M

Two characters country code according to ISO 3166

Ländercode zweistellig gemäß ISO 3166

KeyRESTFormatCNDDescriptionBeschreibung
MdtSeqTypepayment": {"directDebitForm": { "mandate": {"mandateSequenceType"= "..." }}}

ans..4

O

for SEPA: Indicates whether the direct debit is a first, recurring, one-off or final direct debit.

Permissible values: FRST, RCUR, OOFF, FNAL

Standard: OOFF (single direct debit)

für SEPA: Gibt an, ob es sich um eine Erst-, Folge-, Einmal- oder letztmalige Lastschrift handelt.

Zulässige Werte: FRST, RCUR, OOFF, FNAL

Standard: OOFF (Einmal-Lastschrift)

Additional parameters for the direct debit connection PPRO via Paygate form


In case of using REST API

In case of using REST API you will always receive a link where the merchant has to redirect the consumer to complete the payment.

RESTFormatCNDDescription

"paymentId": "..."

an32M

May be "00000000000000000000000000000000" if not yet set by Computop Paygate

"_Links.self.type": "..."an..20M

"application/json"

"_Links.redirect.href": "..."an..1024MMerchant needs to redirect consumer to this URL to complete payment
"_Links.redirect.type": "..."an..20M"text/html"

Merchant can use inquire.aspx

In case of using Key-Value-Pair API

The following table gives the result parameters which Computop Paygate transmits to URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted 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 ...

Key

Format

CND

Description

Beschreibung

RefNr

ans..40

O

Merchant’s unique reference number. Only characters a-zA-Z0-9,-_ are allowed.

Referenznummer des Händlers. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt.

MandateID

ans..35

O

for SEPA: SEPA mandate number

für SEPA: SEPA-Mandatsnummer

KeyFormatCNDDescriptionBeschreibung

PaymentPurpose

ans..26

O

Purpose of payment

Zahlungszweck

KeyFormatCNDDescriptionBeschreibung

PaymentGuarantee

a..12

C
ValueDescription
NONEno payment guarantee
VALIDATEDcustomer account valid, but no payment guarantee
FULLpayment guarantee

Notice: This parameter is only returned if the Status=OK.

WertBeschreibung
NONEkeine Zahlungsgarantie
VALIDATEDKundenkonto valide, aber keine Zahlungsgarantie
FULLZahlungsgarantie

Hinweis: Dieser Parameter wird nur zurückgegeben, falls der Status=OK ist.

KeyFormatCNDDescriptionBeschreibung

ErrorText

ans..128

C

Detailed PPRO error message.

Notice: Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk.

Detaillierte PPRO Fehlermeldung.

Hinweis: Wird nur bei Status=FAILED zurückgegeben. Nutzung nur in Abstimmung mit dem Computop Helpdesk möglich.

Key

Format

CND

Description

Beschreibung

TransactionID

an..20

O

Unique transaction number with PPRO

Eindeutige Transaktionsnummer bei PPRO

Additional result parameters for URLNotify, URLSuccess and URLFailure in case of PPRO connection



Paygate interface: via Server-to-Server

Chart of process flow via Server-to-Server

For the server-to-server payment processes please refer to the programming basics manual.

Process flow of a direct debit payment via server-to-server interface


Call of interface: general parameters

The interface for direct debit payments is edddirect.aspx for all connections. To carry out an electronic direct debit via a Server-to-Server connection, please use the following URL:

https://www.computop-paygate.com/edddirect.aspx

 

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

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

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.

Key

REST

Format

CND

Description

Beschreibung

TransID

"transactionId": "..."

ans..64

M

TransactionID which should be unique for each payment

When using auto-mandate (filling-in of MandateID with TransID or RefNr) the permitted character set is that of the MandateID parameter.

TransaktionsID, die für jede Zahlung eindeutig sein muss

Bei Nutzung von Automandat (Befüllen von MandateID mit TransID oder RefNr) gilt der erlaubte Zeichensatz des Parameters MandateID.

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "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

KeyRESTFormatCNDDescriptionBeschreibung

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

REST

Format

CND

Description

Beschreibung

AccBank

"payment": {"directDebit": { "account": {"name"= "..." }}}

ans..20

O

Bank name

Bezeichnung der Bank

AccOwner

"payment": {"directDebit": { "account": {"accountHolder"= "..." }}}

a..50

M

Account holder

Kontoinhaber

IBAN

"payment": {"directDebit": { "account": {"number"= "..." }}}

ans..34

M

International Bank Account Number

International Bank Account Number

BIC

"payment": {"directDebit": { "account": {"code"= "..." }}}

ans..11

O

Bank Identifier Code

Bank Identifier Code

KeyRESTFormatCNDDescriptionBeschreibung
ReqId"requestId": "..."

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.

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

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

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

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

KeyRESTFormatCNDDescriptionBeschreibung
Capture

"capture": {"auto": "Yes"}

"capture": {"manual": "Yes"}

"capture": ...


an..6

OM

Determines the type and time of capture.

Capture ModeDescription
AUTOCapturing immediately after authorisation (default value).
MANUALCapturing made by the merchant. Capture is normally initiated at time of delivery.
<Number>Delay in hours until the capture (whole number; 1 to 696).

Bestimmt Art und Zeitpunkt der Buchung (engl. Capture).

BuchungsartBeschreibung
AUTOBuchung sofort nach Autorisierung (Standardwert).
MANUALBuchung erfolgt durch den Händler - in der Regel die Buchung zum Zeitpunkt der Warenauslieferung bzw. Leistungserbringung.
<Zahl>Verzögerung in Stunden bis zur Buchung (ganze Zahl; 1 bis 696).

General parameters for direct debit payments via socket connection


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

KeyRESTFormatCNDDescriptionBeschreibung

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

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.

KeyRESTFormatCNDDescriptionBeschreibung
XID"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

KeyRESTFormatCNDDescriptionBeschreibung
TransID"transactionId": "..."

ans..64

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

KeyRESTFormatCNDDescriptionBeschreibung
Status

"status": "OK"

"status": "PENDING"

"status": "FAILED"

a..50

M

OK or PENDING (URLSuccess) as well as FAILED (URLFailure)

OK oder PENDING (URLSuccess) sowie FAILED (URLFailure)

KeyRESTFormatCNDDescriptionBeschreibung
Description"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!

KeyRESTFormatCNDDescriptionBeschreibung
Code"code": ...

n8

M

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

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

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

Key

REST

Format

CND

Description

Beschreibung

IBAN

"payment": { "bankAccountNumber": "..."}

ans..34

O

International Bank Account Number

International Bank Account Number

BIC

"payment": { "bankIdentifierCode": "..."}

ans..11

OC

Only in the case of PBAN creation: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number

nur bei PBAN-Erzeugung: PseudoBankNumber. Die letzten drei Stellen sind identisch zu den letzten drei Stellen der IBAN

AccOwner

"payment": { "accountHolderName": "..."}

ans..50

OC

Only in the case of PBAN creation: Account holder

nur bei PBAN-Erzeugung: Kontoinhaber

AccBank

"payment": { "bankName": "..."}

ans..20

OC

Only in the case of PBAN creation: Name of the bank

nur bei PBAN-Erzeugung: Bezeichnung der Bank
PBAN"payment": { "pseudoBankNumber": "..."}ans..27OOnly in the case of PBAN creation: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN numbernur bei PBAN-Erzeugung: PseudoBankNumber. Die letzten drei Stellen sind identisch zu den letzten drei Stellen der IBAN

MandateID

"payment": { "mandateId": "..."}

ans..35

O

SEPA mandate number

SEPA-Mandatsnummer

KeyRESTFormatCNDDescriptionBeschreibung
DtOfSgntr"payment": {"directDebitForm": { "mandate": {"dateOfSignature"= "..." }}}

ans..10

O
For SEPA: Date of issuing the mandate in the format DD.MM.YYYY
Für SEPA: Datum der Mandatserteilung im Format TT.MM.JJJJ

General response parameters for direct debit payments via socket connection



Direct connection

Besides the general parameters described above for the direct debit connection, the following parameters are to be transmitted via server-to-server connection.

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

KeyRESTFormatCNDDescriptionBeschreibung
MandateID

"payment": { "mandateId": "..."}

"payment": {"directDebitForm": { "mandate": {"mandateId"= "..." }}}

ans..35

M

for SEPA: SEPA mandate number (compulsory in the case of SEPA)

should be unique, is not case-sensitive

Permissible characters: numbers 0-9, upper case letters A-Z, lower case letters a-z, apostrophe, colon, question mark, comma, full stop, plus sign, minus sign, forward slash, left and right bracket

für SEPA: SEPA-Mandatsnummer (Pflicht bei SEPA)

sollte eindeutig sein, ist nicht case-sensitive

Zulässige Zeichen: Ziffern 0-9, Großbuchstaben A-Z, Kleinbuchstaben a-z, Apostroph, Doppelpunkt, Fragezeichen, Komma, Punkt, Pluszeichen, Minuszeichen, Schrägstrich, linke und rechte Klammer

KeyRESTFormatCNDDescriptionBeschreibung
DtOfSgntr"payment": {"directDebitForm": { "mandate": {"dateOfSignature"= "..." }}}

ans..10

O
for SEPA: Date of issuing the mandate in the format DD.MM.YYYY (obligatory when transferring the MandateID)
für SEPA: Datum der Mandatserteilung im Format DD.MM.YYYY (Pflicht bei Übergabe von MandateID)

KeyRESTFormatCNDDescriptionBeschreibung
MdtSeqTypepayment": {"directDebitForm": { "mandate": {"mandateSequenceType"= "..." }}}

ans..4

O

for SEPA: Indicates whether the direct debit is a first, recurring, one-off or final direct debit.

Permissible values: FRST, RCUR, OOFF, FNAL

Standard: OOFF (single direct debit)

für SEPA: Gibt an, ob es sich um eine Erst-, Folge-, Einmal- oder letztmalige Lastschrift handelt.

Zulässige Werte: FRST, RCUR, OOFF, FNAL

Standard: OOFF (Einmal-Lastschrift)

KeyRESTFormatCNDDescriptionBeschreibung
PBAN

"payment": { "pseudoBankNumber": "..."}

"payment": {"directDebit": { "account": {"pseudoBankNumber"= "..." }}}

ans..27

O
for SEPA: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number
für SEPA: PseudoBankNumber. Die letzten drei Stellen sind identisch zu den letzten drei Stellen der IBAN

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

KeyRESTFormatCNDDescriptionBeschreibung
refnr"referenceNumber": "..."

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

Key

REST

Format

CND

Description

Beschreibung

OrderDesc

"order": { "description[0]": "..."}

ans..384

M

Description of purchased goods, unit prices etc. The first 27 characters appear on the customer-account statement. You can view the full data in Computop Analytics.

Beschreibung der gekauften Waren, Einzelpreise etc. Die ersten 27 Zeichen erscheinen auf dem Kontoauszug des Kunden. In Computop Analytics können Sie die kompletten Daten einsehen.

OrderDesc2

"order": { "description[1]": "..."}

ans..384

M

2. Goods description which appears on the account extract (27 characters). You can view the full data in Computop Analytics.

2. Zeile der Warenbeschreibung, die auf dem Kontoauszug erscheint (27 Zeichen). In Computop Analytics können Sie die kompletten Daten einsehen.

Key

REST

Format

CND

Additional parameters in case of activated DEVICERECOGNITION

Zusätzliche Parameter bei aktivierter DEVICERECOGNITION

DeviceID

"device": { "deviceId": "..."}

ans..50

O

Unique Device-ID

Eindeutige Geräte-ID

DRConfidence

"device": { "confidence": ...}

n..3

O

Allocation quote 0-100 (0=no allocation, 100=absolutely safe allocation

Zuordnungsquote 0-100 (0=keine Zuordnung, 100=absolut sichere Zuordnung)

DRNewDevice

"device": { "newDevice": "true"}

"device": { "newDevice": "false"}

ans..5

O

True / false

True / false

DRAnonProxyUsed

"device": { "isAnonymousProxyUsed": "true"}

"device": { "isAnonymousProxyUsed": "false"}

ans..5

O

True / false

True / false

DRProxyUsed

"device": { "isProxyUsed": "true"}

"device": { "isProxyUsed": "false"}

ans..5

O

True / false

True / false

DRCountryCode

"device": { "country": "..."}

a2

O

Country code, 2 characters according to ISO 3166, retrieved from geolocation data, e.g. DE

Ländercode zweistellig gemäß ISO 3166, ermittelt aus Geolocation-Daten, z.B. DE

DRCity

"device": { "city": "..."}

ans..50

O

City, retrieved form geolocation data, e.g. Frankfort

Stadt, ermittelt aus Geolocation-Daten, z.B. Frankfurt

DRLatitude

"device": { "latitude": "..."}

ans..50

O

Geographic latitude, retrieved from geolocation data, e.g. 13.754

Geografische Breite, ermittelt aus Geolocation-Daten, z.B. 13,754

DRLongitude

"device": { "longitude": "..."}

ans..50

O

Geographic longitude, retrieved from geolocation data, e.g. 100.5014

Geografische Länge, ermittelt aus Geolocation-Daten, z.B. 100,5014

DRFS

"device": { "fraudScore": ...}

n..3

O

Fraud score 0-100 (0=low fraud probability, 100=high fraud probability)

Fraudscore, 0-100 (0=geringe Betrugswahrscheinlichkeit, 100=hohe Betrugswahrscheinlichkeit)

DRFSRulematch

"device": { "fraudScoreRules": "..."}

ans..1024

O

Rules for allocation to fraud score

Regeln, die der Zuordnung zum Fraudscore dienen

DRBrowserLanguages

"device": { "browserLanguages": "..."}

ans..255

O

List of browser languages

Liste der am Browser hinterlegten Sprachen

DRIsMobileDevice

"device": { "iMobileDevice": "true"}

"device": { "iMobileDevice": "false"}

ans..5

O

True / false

True / false

Fraud

"device": { "fraud": "..."}

ans..50

O

e.g. Fraud, Suspicion, NoFraud

z.B. Fraud, Suspicion, NoFraud

Additional parameters for direct debit payments via socket connection for the direct connection


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

KeyRESTFormatCNDDescriptionBeschreibung
refnr"referenceNumber": "..."

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyRESTFormatCNDDescriptionBeschreibung
MdtSeqTypepayment": {"directDebitForm": { "mandate": {"mandateSequenceType"= "..." }}}

ans..4

O

for SEPA: Indicates whether the direct debit is a first, recurring, one-off or final direct debit.

Permissible values: FRST, RCUR, OOFF, FNAL

Standard: OOFF (single direct debit)

für SEPA: Gibt an, ob es sich um eine Erst-, Folge-, Einmal- oder letztmalige Lastschrift handelt.

Zulässige Werte: FRST, RCUR, OOFF, FNAL

Standard: OOFF (Einmal-Lastschrift)

Additional response parameters for direct debit payments via socket connection for the direct connection

 


EVO Payments

Besides the general parameters described above for the connection EVO Payments to direct debit, the following parameters are to be transmitted via server-to-server connection.

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

Key

REST

Format

CND

Description

Beschreibung

EDDMethod

"payment": {"method": "..."}

a3

O

Direct debit in Germany:=ELV, Netherlands=ENL, Austria=EEV

Lastschrift in Deutschland=ELV, Niederlande=ENL, Österreich=EEV

OrderDesc

"order": {"description[0]": "..."}

ans..384

M

Description of purchased goods, unit prices etc. The first 27 characters appear on the customer-account statement. You can view the full data in Computop Analytics.

Beschreibung der gekauften Waren, Einzelpreise etc. Die ersten 27 Zeichen erscheinen auf dem Kontoauszug des Kunden. In Computop Analytics können Sie die kompletten Daten einsehen.

OrderDesc2

"order": {"description[1]": "..."}

ans..384

M

2. Goods description which appears on the account extract (27 characters). You can view the full data in Computop Analytics.

2. Zeile der Warenbeschreibung, die auf dem Kontoauszug erscheint (27 Zeichen). In Computop Analytics können Sie die kompletten Daten einsehen.

SubSeqType

"payment": {"directDebitForm": { "mandate": {"subSequenceType"= "..." }}}

a4

O

for SEPA: indicates type of (following) direct debit (FRST, RCUR, OOFF, FNAL permissible)

für SEPA: gibt Typ der (Folge-) Lastschrift an (FRST, RCUR, OOFF, FNAL zulässig)

DebitDelay

"payment": {"directDebitForm": { "debitDelay": ... }}

n..3

M

for SEPA: Number of bank working days >0 which has to be added for the execution date of direct debit

für SEPA: Anzahl Banktage>0, die für das Ausführungsdatum einer Lastschrift zum aktuellen Datum addiert werden

CreditDelay

"payment": {"directDebitForm": { "creditDelay": ... }}

n..3

O

for SEPA: Number of bank working days >0 which has to be added for the execution date of a credit

für SEPA: Anzahl Banktage>0, die für das Ausführungsdatum einer Gutschrift zum aktuellen Datum addiert werden

KeyRESTFormatCNDDescriptionBeschreibung
MandateID

"payment": { "mandateId": "..."}

"payment": {"directDebitForm": { "mandate": {"mandateId"= "..." }}}

ans..35

C

for SEPA: SEPA mandate number (compulsory in the case of SEPA)

should be unique, is not case-sensitive

Permissible characters: numbers 0-9, upper case letters A-Z, lower case letters a-z, apostrophe, colon, question mark, comma, full stop, plus sign, minus sign, forward slash, left and right bracket

für SEPA: SEPA-Mandatsnummer (Pflicht bei SEPA)

sollte eindeutig sein, ist nicht case-sensitive

Zulässige Zeichen: Ziffern 0-9, Großbuchstaben A-Z, Kleinbuchstaben a-z, Apostroph, Doppelpunkt, Fragezeichen, Komma, Punkt, Pluszeichen, Minuszeichen, Schrägstrich, linke und rechte Klammer

KeyRESTFormatCNDDescriptionBeschreibung
DtOfSgntr"payment": {"directDebitForm": { "mandate": {"dateOfSignature"= "..." }}}

ans..10

O
for SEPA: Date of issuing the mandate in the format DD.MM.YYYY (obligatory when transferring the MandateID)
für SEPA: Datum der Mandatserteilung im Format DD.MM.YYYY (Pflicht bei Übergabe von MandateID)

KeyRESTFormatCNDDescriptionBeschreibung
MdtSeqTypepayment": {"directDebitForm": { "mandate": {"mandateSequenceType"= "..." }}}

ans..4

O

for SEPA: Indicates whether the direct debit is a first, recurring, one-off or final direct debit.

Permissible values: FRST, RCUR, OOFF, FNAL

Standard: OOFF (single direct debit)

für SEPA: Gibt an, ob es sich um eine Erst-, Folge-, Einmal- oder letztmalige Lastschrift handelt.

Zulässige Werte: FRST, RCUR, OOFF, FNAL

Standard: OOFF (Einmal-Lastschrift)

KeyRESTFormatCNDDescriptionBeschreibung
PBAN

"payment": { "pseudoBankNumber": "..."}

"payment": {"directDebit": { "account": {"pseudoBankNumber"= "..." }}}

ans..27

O
for SEPA: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number
für SEPA: PseudoBankNumber. Die letzten drei Stellen sind identisch zu den letzten drei Stellen der IBAN


Additional parameters for direct debit payments via socket connection for the connection EVO 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 ...

KeyRESTFormatCNDDescriptionBeschreibung
MdtSeqTypepayment": {"directDebitForm": { "mandate": {"mandateSequenceType"= "..." }}}

ans..4

O

for SEPA: Indicates whether the direct debit is a first, recurring, one-off or final direct debit.

Permissible values: FRST, RCUR, OOFF, FNAL

Standard: OOFF (single direct debit)

für SEPA: Gibt an, ob es sich um eine Erst-, Folge-, Einmal- oder letztmalige Lastschrift handelt.

Zulässige Werte: FRST, RCUR, OOFF, FNAL

Standard: OOFF (Einmal-Lastschrift)

Additional response parameters for direct debit payments via socket connection for the connection EVO Payments

 


InterCard

Direct debit via Intercard does not offer payment protection. If you want to use a direct debit with payment protection, you must order and implement the payment method PayMorrow from Intercard.

Besides the general parameters described above for the connection InterCard to direct debit, the following parameters are to be transmitted via server-to-server connection.

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

KeyRESTFormatCNDDescriptionBeschreibung
MandateID

"payment": { "mandateId": "..."}

"payment": {"directDebitForm": { "mandate": {"mandateId"= "..." }}}

ans..35

C

for SEPA: SEPA mandate number (compulsory in the case of SEPA)

should be unique, is not case-sensitive

Permissible characters: numbers 0-9, upper case letters A-Z, lower case letters a-z, apostrophe, colon, question mark, comma, full stop, plus sign, minus sign, forward slash, left and right bracket

für SEPA: SEPA-Mandatsnummer (Pflicht bei SEPA)

sollte eindeutig sein, ist nicht case-sensitive

Zulässige Zeichen: Ziffern 0-9, Großbuchstaben A-Z, Kleinbuchstaben a-z, Apostroph, Doppelpunkt, Fragezeichen, Komma, Punkt, Pluszeichen, Minuszeichen, Schrägstrich, linke und rechte Klammer

KeyRESTFormatCNDDescriptionBeschreibung
DtOfSgntr"payment": {"directDebitForm": { "mandate": {"dateOfSignature"= "..." }}}

ans..10

O
for SEPA: Date of issuing the mandate in the format DD.MM.YYYY (obligatory when transferring the MandateID)
für SEPA: Datum der Mandatserteilung im Format DD.MM.YYYY (Pflicht bei Übergabe von MandateID)

KeyRESTFormatCNDDescriptionBeschreibung
PBAN

"payment": { "pseudoBankNumber": "..."}

"payment": {"directDebit": { "account": {"pseudoBankNumber"= "..." }}}

ans..27

O
for SEPA: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number
für SEPA: PseudoBankNumber. Die letzten drei Stellen sind identisch zu den letzten drei Stellen der IBAN

Key

REST

Format

CND

Description

Beschreibung

OrderDesc

"order": {"description[0]": "..."}

ans..384

M

Description of purchased goods, unit prices etc. The first 27 characters appear on the customer-account statement. You can view the full data in Computop Analytics.

Beschreibung der gekauften Waren, Einzelpreise etc. Die ersten 27 Zeichen erscheinen auf dem Kontoauszug des Kunden. In Computop Analytics können Sie die kompletten Daten einsehen.

RefNr

"referenceNumber": "..."

ns..30

O

Merchant’s unique reference number

When using auto-mandate (filling-in of MandateID with TransID or RefNr) the permitted character set is that of the MandateID parameter.

Referenznummer des Händlers

Bei Nutzung von Automandat (Befüllen von MandateID mit TransID oder RefNr) gilt der erlaubte Zeichensatz des Parameters MandateID.

CustomerID

"billing": {"consumer": { "consumerId": "..." }}

ans..30

M

Customer number at the merchant

Kundennummer beim Händler

DateOfRegistration

"accountInfo": {"creationDate": "..."}

dttm8

O

Customer since in the format YYYYMMDD

Kunde seit im Format JJJJMMTT

CustomerClassification


ans..20

O

(business / private)

(business / private)

eMail

"billing": {"contactInfo": { "email": "..." }}

ans..80

O

E-mail address

E-Mail-Adresse

DateOfBirth

"billing": {"consumer": { "birthDate": "..." }}

dttm8

O

Date of birth in the format YYYYMMDD

Geburtsdatum im Format JJJJMMTT

bdSalutation

"billing": {"consumer": { "salutation": "..." }}

ans...4

O

Salutation of the invoicing address

Anrede der Rechnungsanschrift

bdFirstName

"billing": {"consumer": { "firstName": "..." }}

ans..30

M

First name of the invoicing address

Vorname der Rechnungsanschrift

bdLastName

"billing": {"consumer": { "lastName": "..." }}

ans..30

M

Last name of the invoicing address

Nachname der Rechnungsanschrift

bdStreet

"billing": {"addressInfo": { "addressLine1": {"street"= "..." }}}

a..50

M

Street name of the invoicing address

Straßenname der Rechnungsanschrift

bdStreetNr

"billing": {"addressInfo": { "addressLine1": {"streetNumber"= "..." }}}

ans..5

M

Street number of the invoicing address

Hausnummer der Rechnungsanschrift

bdCountryCode

"billing": {"addressInfo": { "country": {"A2"= "..." }}}

a2

O

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

Ländercode der Rechnungsanschrift, zweistellig gemäß ISO 3166

bdZip

"billing": {"addressInfo": { "postalCode": "..." }}

n..5

M

Postcode of the invoicing address

Postleitzahl der Rechnungsanschrift

bdCity

"billing": {"addressInfo": { "city": "..." }}

a..32

M

Town or city of the invoicing address

Ortsname der Rechnungsanschrift

bdPhone

"billing": {"contactInfo": { "phone": "..." }}

ans..15

O

Phone number in the invoicing address

Telefonnummer der Rechnungsanschrift

bdFax

"billing": {"contactInfo": { "fax": "..." }}

ans..20

O

Fax number of the invoicing address

Faxnummer der Rechnungsanschrift

bdMaidenName

"billing": {"consumer": { "maidenName": "..." }}

ans..30

O

Maiden name of the invoicing address

Geburtsname der Rechnungsanschrift

UseBillingData


a..3

O

Is the invoicing address to be used as the delivery address?

<Yes> or <No>.

If <Yes> no parameters are transferred for the delivery address, if <No> they are obligatory.  Standard=Yes

Soll Rechnungsadresse als Lieferadresse genutzt werden?

<Yes> oder <No>.

Bei <Yes> werden keine Parameter zur Lieferadresse übergeben, bei <No> sind sie Pflicht.  Standard=Yes

sdSalutation

"shipping": {"consumer": { "salutation": "..." }}

ans...4

O

Salutation in the delivery address

Anrede der Lieferadresse

sdFirstName

"shipping": {"consumer": { "firstName": "..." }}

ans..30

O

First name in the delivery address

Vorname der Lieferadresse

sdLastName

"shipping": {"consumer": { "lastName": "..." }}

ans..30

O

Last name in the delivery address

Nachname der Lieferadresse

sdStreet

"shipping": {"addressInfo": { "addressLine1": {"street"= "..." }}}

a..50

O

Street in the delivery address

Straßenname der Lieferadresse

sdStreetNr

"shipping": {"addressInfo": { "addressLine1": {"streetNumber"= "..." }}}

ans..5

O

Street number of the delivery address

Hausnummer der Lieferadresse

sdCountryCode

"shipping": {"addressInfo": { "country": {"A2"= "..." }}}

a2

O

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

Ländercode der Lieferadresse, zweistellig gemäß ISO 3166

sdZip

"shipping": {"addressInfo": { "postalCode": "..." }}

n..5

O

Postcode in the delivery address

Postleitzahl der Lieferadresse

sdCity

"shipping": {"addressInfo": { "city": "..." }}

a..50

O

Town/city in the delivery address

Ortsname der Lieferadresse

RegularCustomerIndicator


a..5

O

Regular customer (true / false)

Stammkunde (true / false)

ShoppingBasket


ans..1024

O

Customer order information (prices each in the smallest currency unit):

- invoice number / order number

- total net price, numerical

- total gross price

- net shipping costs

- gross shipping costs

- net discount

- gross discount

<;> separates the fields in the shopping basket

Example: InvoiceNumber;TotalNetPrice;TotalGrossPrice;NetShippingCosts;GrossShippingCosts;NetDiscount;GrossDiscount

Bestellinformation des Kunden (Preise je in kleinster Währungseinheit):

- Rechnungsnummer / Bestellnummer

- Gesamtpreis netto numerisch

- Gesamtpreis brutto

- Versandkosten netto

- Versandkosten brutto

- Rabatt netto

- Rabatt brutto

<;> trennt die Felder im Warenkorb

Beispiel: Rechnungsnummer;GesamtpreisNetto;GesamtpreisBrutto;VersandkostenNetto;VersandkostenBrutto;RabattNetto;RabattBrutto

ArticleList

"order": {"items": "..."}

ans..2048

C

Mandatory if shopping basket is transmitted: Shopping basket of the customer:

- article description (ans—50)

- quantity

- net article price

- gross article price

Note on the structure of the article list:

<;> separates fields in the article data set
<+> separates the article data sets

Each article is transferred as a complete article data set:

ArticleDescription;Quantity; ArticleName; NetArticlePrice;GrossArticlePrice + ArtcleDescription;Quantity;ArticleName;NetArticlePrice;GrossArticlePrice

Pflicht, wenn ShoppingBasket angegeben ist: Warenkorb des Kunden:

- Artikelbeschreibung (ans—50)

- Menge

- Artikelpreis netto

- Artikelpreis brutto

Hinweis zum Aufbau der Artikelliste:

<;> trennt Felder im Artikeldatensatz
<+> trennt die Artikeldatensätze

Jeder Artikel wird als kompletter Artikeldatensatz übergeben:

Artikelbeschreibung;Anzahl;Artikelname; ArtikelpreisNetto;ArtikelpreisBrutto + Artikelbeschreibung;Anzahl;Artikelname; ArtikelpreisNetto;ArtikelpreisBrutto

Additional parameters for direct debit payments via socket connection for the connection InterCard


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

KeyRESTFormatCNDDescriptionBeschreibung
refnr"referenceNumber": "..."

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

Key

REST

Format

CND

Description

Beschreibung

ErrorText


ans..128

O

Error text from InterCard.

Notice: Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk.

Fehlertext von InterCard.

Hinweis: Wird nur bei Status=FAILED zurückgegeben. Nutzung nur in Abstimmung mit dem Computop Helpdesk möglich.

CodeExt

"externalErrorCode": ...

n3

O

Error code from InterCard.

Notice: Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk.

Fehlercode von InterCard.

Hinweis: Wird nur bei Status=FAILED zurückgegeben. Nutzung nur in Abstimmung mit dem Computop Helpdesk möglich.

Additional response parameters for direct debit payments via socket connection for the InterCard connection



PPRO

Besides the general parameters described above for the connection PPRO to direct debit, the following parameters are to be transmitted via server-to-server connection.

Notice: Please remind that the standard parameter OrderDesc will not be forwarded with PPRO.

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

KeyRESTFormatCNDDescriptionBeschreibung
MandateID

"payment": { "mandateId": "..."}

"payment": {"directDebitForm": { "mandate": {"mandateId"= "..." }}}

ans..35

M

for SEPA: SEPA mandate number (compulsory in the case of SEPA)

should be unique, is not case-sensitive

Permissible characters: numbers 0-9, upper case letters A-Z, lower case letters a-z, apostrophe, colon, question mark, comma, full stop, plus sign, minus sign, forward slash, left and right bracket

für SEPA: SEPA-Mandatsnummer (Pflicht bei SEPA)

sollte eindeutig sein, ist nicht case-sensitive

Zulässige Zeichen: Ziffern 0-9, Großbuchstaben A-Z, Kleinbuchstaben a-z, Apostroph, Doppelpunkt, Fragezeichen, Komma, Punkt, Pluszeichen, Minuszeichen, Schrägstrich, linke und rechte Klammer

KeyRESTFormatCNDDescriptionBeschreibung
DtOfSgntr"payment": {"directDebitForm": { "mandate": {"dateOfSignature"= "..." }}}

ans..10

O
for SEPA: Date of issuing the mandate in the format DD.MM.YYYY (obligatory when transferring the MandateID)
für SEPA: Datum der Mandatserteilung im Format DD.MM.YYYY (Pflicht bei Übergabe von MandateID)

KeyRESTFormatCNDDescriptionBeschreibung
MdtSeqTypepayment": {"directDebitForm": { "mandate": {"mandateSequenceType"= "..." }}}

ans..4

O

for SEPA: Indicates whether the direct debit is a first, recurring, one-off or final direct debit.

Permissible values: FRST, RCUR, OOFF, FNAL

Standard: OOFF (single direct debit)

für SEPA: Gibt an, ob es sich um eine Erst-, Folge-, Einmal- oder letztmalige Lastschrift handelt.

Zulässige Werte: FRST, RCUR, OOFF, FNAL

Standard: OOFF (Einmal-Lastschrift)

Key

REST

Format

CND

Description

Beschreibung
MandateURL"payment": {"directDebit": { "mandate": {"mandateUrl"= "..." }}}ans..512C

Valid URL pointing to the SEPA mandate, needs to be accessible by PPRO risk and compliance department.

Mandatory in case of MdtSeqType = OOFF or FRST

Gültige URL, die auf das SEPA-Mandat zeigt. Sie muss für die PPRO-Abteilung für Risiko und Compliance zugänglich sein.

Pflicht bei MdtSeqType = OOFF oder FRST

Email"billing": {"contactInfo": { "email": "..." }}ans..100ME-Mail address of account holderE-Mail-Adresse des Kontoinhabers

AddrCountryCode

"billing": {"addressInfo": { "country": {"A2"= "..." }}}

a2

M

Two characters country code according to ISO 3166

Ländercode zweistellig gemäß ISO 3166

Additional parameters for direct debit payments via socket connection for the connection PPRO



Capture / Credit / Reversal

Capture

Captures are possible via a Server-to-Server connection. To perform a capture via a Server-to-Server connection please use the following URL:

https://www.computop-paygate.com/capture.aspx

 

Notice: Separate captures are not possible with the PPRO connection because all transactions are carried out directly as sale transactions.

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

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

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.

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment to be captured

Vom Paygate vergebene ID für die zu buchende Zahlung

Key

REST

Format

CND

Description

Beschreibung

TransID

"transactionId": "..."

ans..64

M

ID assigned by Merchant for the payment process to be captured

Vom Händler initial vergebene ID für den zu buchenden Zahlungsvorgang

KeyRESTFormatCNDDescriptionBeschreibung

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:

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "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

KeyRESTFormatCNDDescriptionBeschreibung
refnr"referenceNumber": "..."

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyRESTFormatCNDDescriptionBeschreibung
ReqId"requestId": "..."

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.

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

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

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

Key

REST

Format

CND

Description

Beschreibung

MandateID

"payment": { "mandateId": "..."}

"payment": {"directDebitForm": { "mandate": {"mandateId"= "..." }}}

ans..35

O

for SEPA: SEPA mandate number (compulsory in the case of SEPA)

should be unique, is not case-sensitive

Permissible characters: numbers 0-9, upper case letters A-Z, lower case letters a-z, apostrophe, colon, question mark, comma, full stop, plus sign, minus sign, forward slash, left and right bracket

für SEPA: SEPA-Mandatsnummer (Pflicht bei SEPA)

sollte eindeutig sein, ist nicht case-sensitive

Zulässige Zeichen: Ziffern 0-9, Großbuchstaben A-Z, Kleinbuchstaben a-z, Apostroph, Doppelpunkt, Fragezeichen, Komma, Punkt, Pluszeichen, Minuszeichen, Schrägstrich, linke und rechte Klammer

KeyRESTFormatCNDDescriptionBeschreibung
DtOfSgntr"payment": {"directDebitForm": { "mandate": {"dateOfSignature"= "..." }}}

ans..10

O
for SEPA: Date of issuing the mandate in the format DD.MM.YYYY (obligatory when transferring the MandateID)
für SEPA: Datum der Mandatserteilung im Format DD.MM.YYYY (Pflicht bei Übergabe von MandateID)

Parameters for captures of direct debit 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 ...

KeyRESTFormatCNDDescriptionBeschreibung

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

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.

KeyRESTFormatCNDDescriptionBeschreibung
XID"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

KeyRESTFormatCNDDescriptionBeschreibung
TransID"transactionId": "..."

ans..64

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

KeyRESTFormatCNDDescriptionBeschreibung
Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyRESTFormatCNDDescriptionBeschreibung
Description"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!

KeyRESTFormatCNDDescriptionBeschreibung
Code"code": ...

n8

M

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

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

KeyRESTFormatCNDDescriptionBeschreibung
refnr"referenceNumber": "..."

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

Response parameters for captures of direct debit payments



Credit with reference

Credits (refunds) are possible via a Server-to-Server connection. Paygate permits credits which relate to a capture previously activated by Paygate and allows merchants to carry out credits without a reference transaction. This section describes the processing of credits with reference transactions. If you refer to a capture for a Credit, the amount of the Credit is limited to the amount of the previous capture.

To carry out a credit with a reference transaction, please use the following URL:

https://www.computop-paygate.com/credit.aspx

 

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

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

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.

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment to be credited

Vom Paygate vergebene ID für die gutzuschreibende Zahlung

Key

REST

Format

CND

Description

Beschreibung

TransID

"transactionId": "..."

ans..64

M

ID assigned by Merchant for the payment process to be credited

Vom Händler initial vergebene ID für den gutzuschreibenden Zahlungsvorgang

KeyRESTFormatCNDDescriptionBeschreibung

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

REST

Format

CND

Description

Beschreibung

RefNr

"referenceNumber": "..."

ns..30

C

not with EVO: Merchant’s unique reference number

nicht bei EVO: Referenznummer des Händlers

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "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

KeyRESTFormatCNDDescriptionBeschreibung
ReqId"requestId": "..."

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.

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

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

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

Parameters for credits of direct debit 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 ...

KeyRESTFormatCNDDescriptionBeschreibung

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment to be credited

Vom Paygate vergebene ID für die gutzuschreibende Zahlung

KeyRESTFormatCNDDescriptionBeschreibung
XID"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

KeyRESTFormatCNDDescriptionBeschreibung
TransID"transactionId": "..."

ans..64

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

KeyRESTFormatCNDDescriptionBeschreibung
Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyRESTFormatCNDDescriptionBeschreibung
Description"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!

KeyRESTFormatCNDDescriptionBeschreibung
Code"code": ...

n8

M

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

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

Key

REST

Format

CND

Description

Beschreibung

RefNr

"referenceNumber": "..."

ns..30

C

not with EVO: Merchant’s unique reference number

nicht bei EVO: Referenznummer des Händlers

Response parameters for credits of direct debit payments



Credit without reference

Paygate can carry out Credits which do not relate to a previous capture. In this case the credit must be transferred to Paygate as a completely new payment transaction. Please contact the Computop Helpdesk for help in using the described additional functions.

Notice: Please note that credits without reference to a previous capture generate higher costs with your Acquiring Bank. If you are frequently unable to make reference to the capture you should agree this with your Acquiring Bank.

Notice: Credit without reference is only possible with a direct debit connection.

To carry out a Credit without a reference transaction via a Server-to-Server connection, please use the following URL:

https://www.computop-paygate.com/eddcreditex.aspx

 

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

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

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.

KeyRESTFormatCNDDescriptionBeschreibung
TransID"transactionId": "..."

ans..64

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

KeyRESTFormatCNDDescriptionBeschreibung
refnr"referenceNumber": "..."

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "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

Key

REST

Format

CND

Description

Beschreibung

AccOwner

"payment": {"directDebitForm": { "account": {"accountHolder"= "..." }}}

ans..50

M

Account holder

Kontoinhaber

AccBank

"payment": {"directDebitForm": { "account": {"name"= "..." }}}

ans..20

OC

Only in the case of PBAN creation: Name of the bank

nur bei PBAN-Erzeugung: Bezeichnung der Bank

IBAN

"payment": {"directDebitForm": { "account": {"number"= "..." }}}

ans..34

O

International Bank Account Number

International Bank Account Number

BIC

"payment": {"directDebitForm": { "account": {"code"= "..." }}}

ans..11

OC

Only in the case of PBAN creation: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number

nur bei PBAN-Erzeugung: PseudoBankNumber. Die letzten drei Stellen sind identisch zu den letzten drei Stellen der IBAN

OrderDesc

"order": {"description[0]": "..."}

ans..768

M

Description of refunded goods, unit prices, merchant’s comment etc.

Beschreibung der gutgeschriebenen Artikel, Einzelpreise, Händlerkommentar etc.

KeyRESTFormatCNDDescriptionBeschreibung
ReqId"requestId": "..."

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.

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

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

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

KeyRESTFormatCNDDescriptionBeschreibung

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:

Parameters for credits of direct debit payments without reference

 

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

KeyRESTFormatCNDDescriptionBeschreibung

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

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.

KeyRESTFormatCNDDescriptionBeschreibung
XID"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

KeyRESTFormatCNDDescriptionBeschreibung
TransID"transactionId": "..."

ans..64

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

KeyRESTFormatCNDDescriptionBeschreibung
Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyRESTFormatCNDDescriptionBeschreibung
Description"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!

KeyRESTFormatCNDDescriptionBeschreibung
Code"code": ...

n8

M

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

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

Response parameters for credits of direct debit payments without reference



Credit without reference for Intercard

Paygate can carry out Credits which do not relate to a previous capture. In this case the credit must be transferred to Paygate as a completely new payment transaction. Please contact the Computop Helpdesk for help in using the described additional functions.

Notice: Please note that credits without reference to a previous capture generate higher costs with your Acquiring Bank. If you are frequently unable to make reference to the capture you should agree this with your Acquiring Bank.

To carry out a Credit without a reference transaction via a Server-to-Server connection, please use the following URL:

https://www.computop-paygate.com/eddcreditex.aspx

 

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

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

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.

KeyRESTFormatCNDDescriptionBeschreibung
TransID"transactionId": "..."

ans..64

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

KeyRESTFormatCNDDescriptionBeschreibung
refnr"referenceNumber": "..."

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "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

Key

REST

Format

CND

Description

Beschreibung

AccOwner

"payment": {"directDebitForm": { "account": {"accountHolder"= "..." }}}

ans..50

OC

Only in the case of PBAN creation: Account holder

nur bei PBAN-Erzeugung: Kontoinhaber

AccBank

"payment": {"directDebitForm": { "account": {"name"= "..." }}}

ans..20

OC

Only in the case of PBAN creation: Name of the bank

nur bei PBAN-Erzeugung: Bezeichnung der Bank

IBAN

"payment": {"directDebitForm": { "account": {"number"= "..." }}}

ans..34

O

International Bank Account Number

International Bank Account Number

BIC

"payment": {"directDebitForm": { "account": {"number"= "..." }}}

ans..11

OC

Only in the case of PBAN creation: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number

nur bei PBAN-Erzeugung: PseudoBankNumber. Die letzten drei Stellen sind identisch zu den letzten drei Stellen der IBAN

OrderDesc

"order": {"description[0]": "..."}

ans..768

M

Description of refunded goods, unit prices, merchant’s comment etc.

Beschreibung gutgeschriebener Artikel, Einzelpreise, Händlerkommentar etc.

KeyRESTFormatCNDDescriptionBeschreibung
ReqId"requestId": "..."

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.

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

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

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

KeyRESTFormatCNDDescriptionBeschreibung

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

REST

Format

CND

Description

Beschreibung

CustomerID

"billing": {"consumer": { "consumerId": "..." }}

ans..30

M

Customer number at the merchant

Kundennummer beim Händler

DateOfRegistration

"accountInfo": {"creationDate": "..."}

dttm8

O

Customer since in the format YYYYMMDD

Kunde seit im Format JJJJMMTT

CustomerClassification


ans..20

O

(business / private)

(business / private)

eMail

"billing": {"contactInfo": { "email": "..." }}

ans..80

O

E-mail address

E-Mail-Adresse

DateOfBirth

"billing": {"consumer": { "birthDate": "..." }}

dttm8

O

Date of birth in the format YYYYMMDD

Geburtsdatum im Format JJJJMMTT

bdSalutation

"billing": {"consumer": { "salutation": "..." }}

ans...4

O

Salutation of the invoicing address

Anrede der Rechnungsanschrift

bdFirstName

"billing": {"consumer": { "firstName": "..." }}

ans..30

M

First name of the invoicing address

Vorname der Rechnungsanschrift

bdLastName

"billing": {"consumer": { "lastName": "..." }}

ans..30

M

Last name of the invoicing address

Nachname der Rechnungsanschrift

bdStreet

"billing": {"addressInfo": { "addressLine1": {"street"= "..." }}}

a..50

M

Street name of the invoicing address

Straßenname der Rechnungsanschrift

bdStreetNr

"billing": {"addressInfo": { "addressLine1": {"streetNumber"= "..." }}}

ans..5

M

Street number of the invoicing address

Hausnummer der Rechnungsanschrift

bdCountryCode

"billing": {"addressInfo": { "country": {"A2"= "..." }}}

a2

O

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

Ländercode der Rechnungsanschrift, zweistellig gemäß ISO 3166

bdZip

"billing": {"addressInfo": { "postalCode": "..." }}

n..5

M

Postcode of the invoicing address

Postleitzahl der Rechnungsanschrift

bdCity

"billing": {"addressInfo": { "city": "..." }}

a..32

M

Town or city of the invoicing address

Ortsname der Rechnungsanschrift

bdPhone

"billing": {"contactInfo": { "phone": "..." }}

ans..15

O

Phone number in the invoicing address

Telefonnummer der Rechnungsanschrift

bdFax

"billing": {"contactInfo": { "fax": "..." }}

ans..20

O

Fax number of the invoicing address

Faxnummer der Rechnungsanschrift

bdMaidenName

"billing": {"consumer": { "maidenName": "..." }}

ans..30

O

Maiden name of the invoicing address

Geburtsname der Rechnungsanschrift

UseBillingData


a..3

O

Is the invoicing address to be used as the delivery address?

<Yes> or <No>.

If <Yes> no parameters are transferred for the delivery address, if <No> they are obligatory.  Standard=Yes

Soll Rechnungsadresse als Lieferadresse genutzt werden?

<Yes> oder <No>.

Bei <Yes> werden keine Parameter zur Lieferadresse übergeben, bei <No> sind sie Pflicht. Standard=Yes

sdSalutation

"shipping": {"consumer": { "salutation": "..." }}

ans...4

O

Salutation in the delivery address

Anrede der Lieferadresse

sdFirstName

"shipping": {"consumer": { "firstName": "..." }}

ans..30

O

First name in the delivery address

Vorname der Lieferadresse

sdLastName

"shipping": {"consumer": { "lastName": "..." }}

ans..30

O

Last name in the delivery address

Nachname der Lieferadresse

sdStreet

"shipping": {"addressInfo": { "addressLine1": {"street"= "..." }}}

a..50

O

Street in the delivery address

Straßenname der Lieferadresse

sdStreetNr

"shipping": {"addressInfo": { "addressLine1": {"streetNumber"= "..." }}}

ans..5

O

Street number of the delivery address

Hausnummer der Lieferadresse

sdCountryCode

"shipping": {"addressInfo": { "country": {"A2"= "..." }}}

a2

O

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

Ländercode der Lieferadresse, zweistellig gemäß ISO 3166

sdZip

"shipping": {"addressInfo": { "postalCode": "..." }}

n..5

O

Postcode in the delivery address

Postleitzahl der Lieferadresse

sdCity

"shipping": {"addressInfo": { "city": "..." }}

a..50

O

Town/city in the delivery address

Ortsname der Lieferadresse

RegularCustomerIndicator


a..5

O

Regular customer (true / false)

Stammkunde (true / false)

Parameters for credits of direct debit payments without reference with Intercard

 

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

KeyRESTFormatCNDDescriptionBeschreibung

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

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.

KeyRESTFormatCNDDescriptionBeschreibung
XID"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

KeyRESTFormatCNDDescriptionBeschreibung
TransID"transactionId": "..."

ans..64

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

KeyRESTFormatCNDDescriptionBeschreibung
Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyRESTFormatCNDDescriptionBeschreibung
Description"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!

KeyRESTFormatCNDDescriptionBeschreibung
Code"code": ...

n8

M

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

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

Response parameters for credits of direct debit payments without reference with Intercard



Reversal

Reversals are possible via a Server-to-Server connection. In order to cancel a direct debit payment via a server-to-server communication, please use the following URL:

https://www.computop-paygate.com/reverse.aspx

 

Notice: Reverse.aspx does not only reverse authorisations, but any LAST TRANSACTION STAGE! If the last transaction was a capture, Reverse.aspx initiates the reverse, e.g. a credit. Therefore, the utmost caution is urged. Use is at your own risk. We recommend checking the transaction status with Inquire.aspx before using Reverse.aspx.

Notice: Cancellation is only possible with a direct debit connection.

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

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

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.

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment to be reversed

Vom Paygate vergebene ID für die zu stornierende Zahlung

Key

REST

Format

CND

Description

Beschreibung

TransID

"transactionId": "..."

ans..64

M

ID assigned by Merchant for the payment process to be reversed

ID des Händlers zur Identifizierung des zu stornierenden Zahlungsvorgangs

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "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

KeyRESTFormatCNDDescriptionBeschreibung

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:

KeyRESTFormatCNDDescriptionBeschreibung
ReqId"requestId": "..."

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.

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

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

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

Parameters for reversals of direct debit 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 ...

KeyRESTFormatCNDDescriptionBeschreibung

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

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.

KeyRESTFormatCNDDescriptionBeschreibung
XID"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

KeyRESTFormatCNDDescriptionBeschreibung
TransID"transactionId": "..."

ans..64

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

KeyRESTFormatCNDDescriptionBeschreibung
Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyRESTFormatCNDDescriptionBeschreibung
Description"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!

KeyRESTFormatCNDDescriptionBeschreibung
Code"code": ...

n8

M

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

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

Response parameters for reversals of direct debit payments



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.

Batch calls and answers

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

The possible actions per batch depend on the respective connection. In the case of direct connections all transactions including credit without reference are possible while cancellation and credit without reference are not possible with EVO Payment, InterCard and PPRO connections. In the case of PPRO the transactions are also purely sales transactions and so only sales and credit is possible here.

Following table gives an overview of all batch versions that are possible for a specific action and 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)

Authorize

1.0.1 / 2.0.1

Standard version without return of parameter Code

Standardversion ohne Rückgabe von Parameter Code


1.x.1 / 2.x.1

with RefNr (valid for all versions other than 1.0)

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

Sale

1.0.1 / 2.0.1

Standard version without return of parameter Code

Standardversion ohne Rückgabe von Parameter Code


1.x.1 / 2.x.1

with RefNr (valid for all versions other than 1.0)

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

Credit

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)

CreditEx

1.0 / 2.0

Standard version without return of parameter Code

Standardversion ohne Rückgabe von Parameter Code

 

1.x / 2x.

with RefNr (valid for all versions other than 1.0)

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

Description of the possible batch versions


The structure for a direct debit payment within a Batch file to be submitted is the following: 

HEAD,<MerchantID>,<Date>,<Version>
EDD,Authorize,<Amount>,<Currency>,<TransID>,(<RefNr>,)<AccOwner>,<IBAN>,<BIC>,<AccBankName>,<OrderDesc1>,<OrderDesc2>,(<MandateID>,<DtOfSgntr>,<MdtSeqType>)
EDD,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>,)<AccOwner>,<IBAN>,<BIC>,<AccBankName>,<OrderDesc1>,<OrderDesc2>,(<MandateID>,<DtOfSgntr>,<MdtSeqType>)
EDD,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,(<MandateID>,<DtOfSgntr>,<MdtSeqType>)
EDD,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>
EDD,CreditEx,<Amount>,<Currency>,<TransID>,(<RefNr>,)<AccOwner>,<IBAN>,<BIC>,<AccBankName>,<OrderDesc1>,<OrderDesc2>
EDD,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>
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) in 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, EDD for direct debit

HEAD für Header, FOOT für Footer, EDD für Lastschrift

Action

a..20

M

The parameter Action defines the type of transaction:

Authorize (authorisation)

Capture

Sale

Credit

CreditEx (credit note without previous capture; please agree this with Computop Helpdesk beforehand)

Reverse (cancellation)

Der Action-Parameter definiert die Art der Transaktion:

Authorize (Autorisierung)

Capture (Buchung)

Sale (Verkauf)

Credit (Gutschrift)

CreditEx (Gutschrift ohne vorherige Buchung; bitte stimmen sie sich hierzu vorher mit dem Computop Helpdesk ab)

Reverse (Storno)

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
PayID

an32

M

ID assigned by Paygate for this transaction

Vom Paygate vergebene ID für diese Transaktion

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Unique reference number

Eindeutige Referenznummer. Bei PPRO: Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt, Format ans..40.

AccOwner

ans..50

M

Account holder

Kontoinhaber

IBAN

ans..34

M

International Bank Account Number

International Bank Account Number

BIC

ans..11

O

Bank Identifier Code

Bank Identifier Code

AccBankName

ans..20

O

Name of the bank

Name der Bank

OrderDesc1

ans..27

M

Text explaining customer account withdrawal, max. 27 characters

Verwendungszweck-Text für Kontoauszug des Kunden, max. 27 Zeichen

OrderDesc2

ans..27

M

Text explaining customer account withdrawal, max. 27 characters (2. line)

Verwendungszweck-Text für Kontoauszug des Kunden, max. 27 Zeichen (2. Zeile)

MandateID

ans..35

O

SEPA mandate number (compulsory in the case of SEPA)

should be unique, is not case-sensitive

Permissible characters: numbers 0-9, upper case letters A-Z, lower case letters a-z, apostrophe, colon, question mark, comma, full stop, plus sign, minus sign, forward slash, left and right bracket

SEPA-Mandatsnummer (Pflicht bei SEPA)

sollte eindeutig sein, ist nicht case-sensitive

Zulässige Zeichen: Ziffern 0-9, Großbuchstaben A-Z, Kleinbuchstaben a-z, Apostroph, Doppelpunkt, Fragezeichen, Komma, Punkt, Pluszeichen, Minuszeichen, Schrägstrich, linke und rechte Klammer

KeyFormatCNDDescriptionBeschreibung
DtOfSgntr

ans..10

O
for SEPA: Date of issuing the mandate in the format DD.MM.YYYY (obligatory when transferring the MandateID)
für SEPA: Datum der Mandatserteilung im Format DD.MM.YYYY (Pflicht bei Übergabe von MandateID)

KeyFormatCNDDescriptionBeschreibung
MdtSeqType

ans..4

O

for SEPA: Indicates whether the direct debit is a first, recurring, one-off or final direct debit.

Permissible values: FRST, RCUR, OOFF, FNAL

Standard: OOFF (single direct debit)

für SEPA: Gibt an, ob es sich um eine Erst-, Folge-, Einmal- oder letztmalige Lastschrift handelt.

Zulässige Werte: FRST, RCUR, OOFF, FNAL

Standard: OOFF (Einmal-Lastschrift)

Description of fields within the record for Batch files

 

The record area within the response file for Batch transactions looks as follows:

HEAD,<MerchantID>,<Date>,<Version>
EDD,Authorize,<Amount>,<Currency>,<TransID>,(<RefNr>,)<AccOwner>,<IBAN>,<BIC>,<AccBankName>,<OrderDesc1>,<OrderDesc2>,(<MandateID>,<DtOfSgntr>,<MdtSeqType>,)<Status>,<Code>
EDD,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>,)<AccOwner>,<IBAN>,<BIC>,<AccBankName>,<OrderDesc1>,<OrderDesc2>,(<MandateID>,<DtOfSgntr>,<MdtSeqType>,)<Status>,<Code>
EDD,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,(<MandateID>,<DtOfSgntr>,<MdtSeqType>,)<Status>,<Code>
EDD,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>
EDD,CreditEx,<Amount>,<Currency>,<TransID>,(<RefNr>,)<AccOwner>,<IBAN>,<BIC>,<AccBankName>,<OrderDesc1>,<OrderDesc2>,<Status>,<Code>
EDD,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<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 before):

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 like capture or credit – see above.
Der Action-Parameter definiert die Art der Transaktion wie Capture (Buchung) oder Credit (Gutschrift) – siehe oben.

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