Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space ENWORK and version Documentation

About direct debit

General information about direct debit

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Name
PageWithExcerptWording
can combine electronic direct debits (ELV) in Germany with a block list check which offers high security at low cost:
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
checks if the account is blocked and if the sales limit for this account has been reached. After successful verification,
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
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.


Page properties
Logo

Info
Excerpt

The

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
interface

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameDefinition
PageWithExcerptDefinition EN

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameLink_CookieSessionHandling
DisableCachingtrue
PageWithExcerptReuse API


Table of Contents



Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
interface: via form

Chart of process flow via form interface

Multiexcerpt
MultiExcerptNameProcessFlow_Form

draw.io Diagram
bordertrue
diagramNameDirectDebit_CT
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth1109

Process flow of direct debit payment via form interface


Corporate PayPage

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
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).

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
copies this XSLT-template to our
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
Server. If you enter the name of your XSLT-file in the Template parameter, the
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
payment page, for example:
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
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.

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

Both items of information must refer to the

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
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="

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
) 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
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
form is consistently paysdd.aspx for all connections. In order to make a direct debit payment via
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
form, please use the following URL:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
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.

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1618512856592_1542840231
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepaysdd_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1618587502543_-1280868138
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Multiexcerpttable-excerpt-include
SpaceWithExcerptEN
MultiExcerptNameRequest_AmountMac
DisableCachingtrue
PageWithExcerptReuse API
isFirstTimeEntertrue
statictrue
v2
nameMerchantID_REST
pageMerchantID
typepage

Key

REST

Key

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.

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
name
ReqId-ans..32
Amount_REST
page
ReqId
Amount
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
name
URLSuccess
Currency_REST
page
URLSuccess
Currency
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameURLFailureMAC_REST
pageURLFailureMAC
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameResponseReqId-ans..32_REST
pageResponseReqId
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameURLNotifyURLSuccess_REST
pageURLNotifyURLSuccess
typepage-descendants

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameURLFailure_REST
pageURLFailure
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameResponse_REST
pageResponse
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameURLNotify_REST
pageURLNotify
typepage-descendants

Key

REST

Format

CND

Description

Beschreibung





(info) In case of a direct

Key

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 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
-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.

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameUserData_REST
pageUserData
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameCapture_REST
pageCapture
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameexpirationTime_REST
pageexpirationTime
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
namePlain_REST
pagePlain
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameCustom_REST
pageCustom
typepage

General parameters for direct debit payments via form



Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameLayout_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1618516821236_1860302678
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepaysdd_template
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1618587542577_29835081
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Key

REST

Format

CND

Description

Beschreibung

AccBank

ans..20

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

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameTemplate_REST
pageTemplate
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameBackground_REST
pageBackground
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameBGColor_REST
pageBGColor
typepage

Table Excerpt Include
staticisFirstTimeEntertrue
statictrue
v2
nameBGImage_REST
pageBGImage
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameFColor_REST
pageFColor
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameFFace_REST
pageFFace
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameFSize_REST
pageFSize
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameURLBack_REST
pageURLBack
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nametWidth_REST
pagetWidth
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nametHeight_REST
pagetHeight
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameCustomField[n]_REST
pageCustomField[n]
typepage

Layout parameters for

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
forms for direct debit payments



Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRestResponse_IntroURL
PageWithExcerptReuse API

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameKvpResponseResponse_IntroURL
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1618519475469_-143512491
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepaysdd_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1618587590573_1458199043
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameStatus_OK_PENDING
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage-children

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

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

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
namePlain
pagePlain
typepage

Table Excerpt Include
statictrue
nameCustom
pageCustom
typepage

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.

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro_Short
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1618865361130_-1393746912
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamedirect_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1618865361132_82799603
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameRefNr_REST
pagerefnr
typepage

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 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBackoffice-Name
DisableCachingtrue
PageWithExcerptWording
.

Beschreibung der gekauften Waren, Einzelpreise etc. Die ersten 27 Zeichen erscheinen auf dem Kontoauszug des Kunden. In

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBackoffice-Name
PageWithExcerptWording
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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBackoffice-Name
PageWithExcerptWording
.

2. Zeile der Warenbeschreibung, die auf dem Kontoauszug erscheint (27 Zeichen). In 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBackoffice-Name
PageWithExcerptWording
können Sie die kompletten Daten einsehen.

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameCapture_REST
pageCapture
typepage

Table Excerpt Include
isFirstTimeEntertrue
v2
nameMandateID_C_REST
pageMandateID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameDtOfSgntr_REST
pageDtOfSgntr
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMdtSeqType_REST
pageMdtSeqType
typepage

Table Excerpt Include
isFirstTimeEntertrue
v2
namePBAN_REST
pagePBAN
typepage

Additional parameters for the direct debit connection via
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
form


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRestResponse_IntroURL
PageWithExcerptReuse API

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponseKvpResponse_IntroURL
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1618867128346_23508430
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamedirect_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1618867128348_2114114079
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameMandateID_C
pageMandateID
typepage

Table Excerpt Include
statictrue
nameDtOfSgntr
pageDtOfSgntr
typepage

Table Excerpt Include
statictrue
nameMdtSeqType
pageMdtSeqType
typepage

Table Excerpt Include
statictrue
namePBAN
pagePBAN
typepage

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.

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro_Short
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1618867564171_-1529883876
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameevo_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1618867564172_-1322649534
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

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 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBackoffice-Name
DisableCachingtrue
PageWithExcerptWording
.

Beschreibung der gekauften Waren, Einzelpreise etc. Die ersten 27 Zeichen erscheinen auf dem Kontoauszug des Kunden. In

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBackoffice-Name
PageWithExcerptWording
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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBackoffice-Name
PageWithExcerptWording
.

2. Zeile der Warenbeschreibung, die auf dem Kontoauszug erscheint (27 Zeichen). In

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBackoffice-Name
PageWithExcerptWording
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": ... }}

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

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMandateID_C_REST
pageMandateID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameDtOfSgntr_REST
pageDtOfSgntr
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMdtSeqType_REST
pageMdtSeqType
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
namePBAN_REST
pagePBAN
typepage

Additional parameters for the direct debit connection EVO Payments via

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
form


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRestResponse_IntroURL
PageWithExcerptReuse API

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameKvpResponseResponse_IntroURL
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1618867792876_-913388778
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameevo_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1618867792878_1392175081
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMandateID_C
pageMandateID
typepage

Table Excerpt Include
statictrue
nameDtOfSgntr
pageDtOfSgntr
typepage

Table Excerpt Include
statictrue
nameMdtSeqType
pageMdtSeqType
typepage

Table Excerpt Include
statictrue
namePBAN
pagePBAN
typepage

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.

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro_Short
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1618941775631_-709936021
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameintercard_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1618941775634_1924080756
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMandateID_C_REST
pageMandateID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameDtOfSgntr_REST
pageDtOfSgntr
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
namePBAN_REST
pagePBAN
typepage

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 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBackoffice-Name
DisableCachingtrue
PageWithExcerptWording
.

Beschreibung der gekauften Waren, Einzelpreise etc. Die ersten 27 Zeichen erscheinen auf dem Kontoauszug des Kunden. In

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBackoffice-Name
PageWithExcerptWording
können Sie die kompletten Daten einsehen.

RefNr

"referenceNumber": "..."

ns..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..30ans..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..15ans..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..5ans..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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
form


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRestResponse_IntroURL
PageWithExcerptReuse API

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameKvpResponseResponse_IntroURL
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1618942229835_893895604
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameintercard_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1618942229836_1274338352
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Key

Format

CND

Description

Beschreibung

CodeExt

n..10

O

InterCard error code, only if agreed with

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording

Fehlercode von InterCard, wenn mit

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
abgesprochen

ErrorText

ans..128

C

InterCard error text.

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
.

Fehlertext von InterCard.

Hinweis: Wird nur bei Status=FAILED zurückgegeben. Nutzung nur in Abstimmung mit dem 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
möglich.

Table Excerpt Include
statictrue
nameMandateID_C
pageMandateID
typepage

Table Excerpt Include
statictrue
nameDtOfSgntr
pageDtOfSgntr
typepage

Table Excerpt Include
statictrue
namePBAN
pagePBAN
typepage

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.

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro_Short
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1619018672947_1414314307
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameppro_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1619018672951_1924080756
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

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.

Table Excerpt Include
statictrue
nameSellingPoint
pageSellingPoint
typepage

Table Excerpt Include
statictrue
nameService
pageService
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
namev2
nameChannel_REST
pageChannel
typepage

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

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMdtSeqType_REST
pageMdtSeqType
typepage

Additional parameters for the direct debit connection PPRO via

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
form


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRestResponse_IntroURL
PageWithExcerptReuse API

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameKvpResponseResponse_IntroURL
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1619018820714_-63256835
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameppro_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1619018820715_-1325293951
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

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

Table Excerpt Include
statictrue
namePaymentPurpose
pagePaymentPurpose
typepage

Table Excerpt Include
statictrue
namePaymentGuarantee
pagePaymentGuarantee
typepage

Table Excerpt Include
statictrue
nameErrorText_PPRO
pageErrorText
typepage

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



Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
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.

Multiexcerpt
MultiExcerptNameProcessFlow_S2S

draw.io Diagram
bordertrue
diagramNameDirectDebit_S2S_CT
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth1109

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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
edddirect.aspx

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1619038405937_1531233092
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameedddirect_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1619038405941_536143383
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Multiexcerpttable-excerpt-include
SpaceWithExcerptisFirstTimeEnterENtrue
MultiExcerptNamestaticRequest_AmountMactrue
DisableCachingvtrue2
PageWithExcerptReuse API
nameMerchantID_REST
pageMerchantID
typepage

Bank Identifier Code

Key

Format

CND

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.

AccBank

ans..20

M

Bank name

Bezeichnung der Bank

AccOwner

a..50

M

Account holder

Kontoinhaber

IBAN

ans..34

M

International Bank Account Number

International Bank Account Number

BIC

ans..11

O

Bank Identifier Code

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameAmount_REST
pageAmount
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
name

ReqId-ans..32

Currency_REST
page

ReqId

Currency
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
name

UserData

MAC_REST
page

UserData

MAC
typepage

Table Excerpt Include
nameCapture
pageCapture
typepage

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

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameReqId-ans..32_REST
pageReqId
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameUserData_REST
pageUserData
typepage

Table Excerpt Include
isFirstTimeEntertrue
v2
nameCapture_REST
pageCapture
typepage

General parameters for direct debit General parameters for direct debit payments via socket connection


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_IntroURLIntro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1619084881736_925422062
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameedddirect_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1619084881741_-703848722
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMID_REST
pagemid
typepage

Table Excerpt Include
isFirstTimeEntertrue
v2
namePayID_REST
pagePayID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameXID_REST
pageXID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameTransID_REST
pageTransID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameStatus_OK_PENDING_REST
pageStatus
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameDescription_REST
pageDescription
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameCode_REST
pageCode
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameUserData_REST
pageUserData
typepage

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

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameDtOfSgntr_Response_REST
pageDtOfSgntr
typepage

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.

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro_Short
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1619175178248_-1559314444
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameedddirect_direct_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1619175178251_-1326881857
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMandateID_M_REST
pageMandateID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameDtOfSgntr_REST
pageDtOfSgntr
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMdtSeqType_REST
pageMdtSeqType
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
namePBAN_REST
pagePBAN
typepage

Table Excerpt Include
staticisFirstTimeEntertrue
namestaticCodetrue
pageCode
typepage
Table Excerpt Include
v2
statictrue
nameUserData_REST
pageUserData
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameRefNr_REST
pagerefnr
typepage

). 100,5014

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 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBackoffice-Name
DisableCachingtrue
PageWithExcerptWording
.

Beschreibung der gekauften Waren, Einzelpreise etc. Die ersten 27 Zeichen erscheinen auf dem Kontoauszug des Kunden. In

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBackoffice-Name
PageWithExcerptWording
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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBackoffice-Name
PageWithExcerptWording
.

2. Zeile der Warenbeschreibung, die auf dem Kontoauszug erscheint (27 Zeichen). In 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBackoffice-Name
PageWithExcerptWording
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"}DRNewDevice

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": ...}DRFS

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 connectionThe following table gives the parameters with which


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-KurzResponse_Intro
PageWithExcerptWording
responds:
Reuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1619175582953_-1559314444
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameedddirect_direct_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1619175582954_-1326881857
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameRefNr_REST
pagerefnr
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMdtSeqType_REST
pageMdtSeqType
typepage

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.

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro_Short
PageWithExcerptReuse API

Table Filter
inversefalse
sparkNameSparkline
hidePanetrue
isNewfalse
separatorPoint (.)
ddSeparatorstrue
defaultBeschreibung
hideColumnstrue
datepatterndd M yy
id1636019888342_67645590
worklog365|5|8|y w d h m|y w d h m
isORAND
order0

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameevo_request
PageWithExcerptDirect debit


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

The following table gives the parameters with which

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-KurzResponse_Intro
PageWithExcerptWordingReuse API
responds:

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1619188260629_581090465
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameedddirect_evo_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1619188260633_1874159766
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMdtSeqType_REST
pageMdtSeqType
typepage

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.

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro_Short
PageWithExcerptReuse API

Table Filter
inversefalse
sparkNameSparkline
hidePanetrue
isNewfalse
separatorPoint (.)
ddSeparatorstrue
defaultBeschreibung
hideColumnstrue
datepatterndd M yy
id1636019977176_1669087128
worklog365|5|8|y w d h m|y w d h m
isORAND
order0

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameintercard_request
PageWithExcerptDirect debit

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


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1619188780949_82419720
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameedddirect_intercard_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1619188780951_1242615958
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameRefNr_REST
pagerefnr
typepage

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
.

Fehlertext von InterCard.

Hinweis: Wird nur bei Status=FAILED zurückgegeben. Nutzung nur in Abstimmung mit dem 

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
möglich.

CodeExt

"externalErrorCode": ...

n3

O

Error code from InterCard.

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
.

Fehlercode von InterCard.

Hinweis: Wird nur bei Status=FAILED zurückgegeben. Nutzung nur in Abstimmung mit dem 

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
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.

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro_Short
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1619636765895_-585974910
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameedddirect_ppro_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1619636765896_1346739939
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMandateID_M_REST
pageMandateID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameDtOfSgntr_REST
pageDtOfSgntr
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMdtSeqType_REST
pageMdtSeqType
typepage

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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
capture.aspx

 

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1619637327580_-585974910
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecapture_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1619637327582_1346739939
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMerchantID_REST
pageParameterMerchantID
typepage-descendants

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
namePayID_Capture_REST
pagePayID
typepage

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

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMAC_REST
pageMAC
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameAmount_REST
pageAmount
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameCurrency_REST
pageCurrency
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameRefNr_REST
pagerefnr
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameReqId-ans..32_REST
pageReqId
typepage

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

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameDtOfSgntr_REST
pageDtOfSgntr
typepage

Parameters for captures of direct debit payments

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1619636448779_1046877523
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecapture_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1619636448782_419634113
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMID_REST
pagemid
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
namePayID_REST
pagePayID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameXID_REST
pageXID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameTransID_REST
pageTransID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameStatus_OK_FAILED_REST
pageStatus
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameDescription_REST
pageDescription
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameCode_REST
pageCode
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameRefNr_REST
pagerefnr
typepage

Response parameters for captures of direct debit payments



Credit with reference

Credits (refunds) are possible via a Server-to-Server connection.

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
permits credits which relate to a capture previously activated by
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
credit.aspx

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620206142617_1723357047
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecredit_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620206142620_-1652704979
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMerchantID_REST
pageMerchantID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
namePayID_Credit_REST
pagePayID
typepage

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

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMAC_REST
pageMAC
typepage

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

Table Excerpt Include
isFirstTimeEntertrue
v2
nameAmount_REST
pageAmount
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameCurrency_REST
pageCurrency
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameReqId-ans..32_REST
pageReqId
typepage

Parameters for credits of direct debit payments

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620720925960_736394440
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecredit_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620720925962_-621253027
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMID_REST
pagemid
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
namePayID_Credit_REST
pagePayID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameXID_REST
pageXID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameTransID_REST
pageTransID
typepage

Table Excerpt Include
isFirstTimeEntertrue
v2
nameStatus_OK_FAILED_REST
pageStatus
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameDescription_REST
pageDescription
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameCode_REST
pageCode
typepage

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
can carry out Credits which do not relate to a previous capture. In this case the credit must be transferred to
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
as a completely new payment transaction. Please contact the 
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
eddcreditex.aspx

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620721605142_-1822401749
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecreditex_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620721605144_-2086432909
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMerchantID_REST
pageMerchantID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameTransID_REST
pageTransID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameRefNr_REST
pagerefnr
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameAmount_REST
pageAmount
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameCurrency_REST
pageCurrency
typepage

nur bei PBAN-Erzeugung:

Key

REST

Format

CND

Description

Beschreibung

Description

Beschreibung

AccOwner

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

ans..50

OC

M

Only in the case of PBAN creation: 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.

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameReqId-ans..32_REST
pageReqId
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMAC_REST
pageMAC
typepage

Parameters for credits of direct debit payments without referencereference

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620725422638_1899584286
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecreditex_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620725422640_-1165238281
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMID_REST
pagemid
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
namePayID_REST
pagePayID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameXID_REST
pageXID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameTransID_REST
pageTransID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameStatus_OK_FAILED_REST
pageStatus
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameDescription_REST
pageDescription
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameCode_REST
pageCode
typepage

Response parameters for credits of direct debit payments without reference



Credit without reference for Intercard

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
can carry out Credits which do not relate to a previous capture. In this case the credit must be transferred to
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
as a completely new payment transaction. Please contact the 
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
eddcreditex.aspx

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620726417908_-1247083361
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecreditex_intercard_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620726417910_-764777346
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMerchantID_REST
pageMerchantID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameTransID_REST
pageTransID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameRefNr_REST
pagerefnr
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameAmount_REST
pageAmount
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameCurrency_REST
pageCurrency
typepage

Key

REST

Format

CND

Description

Beschreibung

Beschreibung

AccOwner

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

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.

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameReqId-ans..32_REST
pageReqId
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMAC_REST
pageMAC
typepage

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 RechnungsanschriftNachname der Rechnungsanschrift

bdStreet

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

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

Telefonnummer der Rechnungsanschrift

bdFax

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

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

delivery address

Straßenname der Lieferadresse

sdStreetNr

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

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

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620726747344_-338362829
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecreditex_intercard_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620726747346_-1689798262
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMID_REST
pagemid
typepage

Table Excerpt Include
isFirstTimeEntertrue
v2
namePayID_REST
pagePayID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameXID_REST
pageXID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameTransID_REST
pageTransID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameStatus_OK_FAILED_REST
pageStatus
typepage

Table Excerpt Include
isFirstTimeEntertrue
v2
nameDescription_REST
pageDescription
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameCode_REST
pageCode
typepage

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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
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.

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620728656851_-1247083361
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamereversal_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620728656853_-764777346
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMerchantID_REST
pageMerchantID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
namePayID_Reverse_REST
pagePayID
typepage

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

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameAmount_REST
pageAmount
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameCurrency_REST
pageCurrency
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMAC_REST
pageMAC
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameReqId-ans..32_REST
pageReqId
typepage

Parameters for reversals of direct debit payments

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620728954412_-1808328409
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamereversal_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620728954414_-847970708
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameMID_REST
pagemid
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
namePayID_REST
pagePayID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameXID_REST
pageXID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameTransID_REST
pageTransID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameStatus_OK_FAILED_REST
pageStatus
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameDescription_REST
pageDescription
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
nameCode_REST
pageCode
typepage

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:

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620729480196_1746080268
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamebatch_versions
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620729480197_1590040209
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

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:

Multiexcerpt
MultiExcerptNameBatch_Structure
Code Block
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:

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


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBatch_Request_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620730035909_1936119754
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamebatch_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620730035911_1605943250
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
ab)

Reverse (Storno)

Table Excerpt Include
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
namePayID_Batch
pagePayID
typepage

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

MO

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

Table Excerpt Include
statictrue
nameDtOfSgntr
pageDtOfSgntr
typepage

Table Excerpt Include
statictrue
nameMdtSeqType
pageMdtSeqType
typepage

Description of fields within the record for Batch files

 

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

Multiexcerpt
MultiExcerptNameBatch_Response
Code Block
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>

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBatch_Response_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620730823703_2060961042
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamebatch_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620730823705_1474436447
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

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.

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Description of result parameters within the record for Batch files