Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents


About direct debit

General information about direct debit

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

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

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

Transaction procedure of a direct debit payment on the Internet

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

SEPA direct debit

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


Page properties


Logo

Info


Excerpt

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

Optionally with black list check and payment guarantee.


TypTypePayments by Direct Debit EN





Paygate interface

Multiexcerpt include
SpaceWithExcerptDOCCT
MultiExcerptNameDefinition
PageWithExcerptDefinition EN


Paygate interface: via form

Chart of process flow via form interface


Process flow of direct debit payment via form interface


Corporate PayPage

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

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

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


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

File names

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

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

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

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

Field names of the form

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

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

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

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


Hidden Fields

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

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

Language selection

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

XML structure

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

The XML file should have the following basic structure:

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

       </languages>

             <language name="de">

             </language>

             <language name="en">

             </language>

       </languages>


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

                    strCustomFieldsXML & _

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

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

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

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

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

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

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

       "</template>"


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

JavaScript

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

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

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

{

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

       document.SDDForm.IBAN.focus();

}

...

</script>


Please do not use any external link to your JavaScript.

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

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

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


Programming and testing the form

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

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

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

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


<xsl:template match="/">

<html>

       <head>

             <title>PaySDD Template</title>

             <script>Your JavaScript</script>

       </head>

       <body>

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

       </form>

       </body>

</html>

</xsl:template>


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

       <language name="de">

             <strIBAN>IBAN</strIBAN>

       </language>


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

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


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

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

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

<template>

       <languages>please omit for your layout tests

             <language name="de">

             </language>

             <language name="en">

             </language>

       <languages>please omit for your layout tests

</template>


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


General parameters of the interface

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


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

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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

TransID

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.

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217 Only EUR is permissible.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

OrderDesc

ans..384

M

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

URLSuccess

ans..256

M

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

URLFailure

ans..256

M

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

Response

a7

O

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

URLNotify

ans..256

M

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

UserData

ans..256

O

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

Capture

ans..6

O

Determines the type and time of capture. AUTO: capturing immediately after authorisation (default value). MANUAL: capturing made by the merchant. <Number>: Delay in hours until the capture (whole number; 1 to 696).

ReqID

ans..32

O

To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

expirationTime

ans..19

O

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

Format: YYYY-MM-ddTHH:mm:ss

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

General parameters for direct debit payments via form


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

Parameter

Format

CND

Description

AccBank

ans..20

O

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

AccOwner

ans..50

O

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

IBAN

ans..34

M

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

BIC

ans..11

O

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

Template

ans..20

M

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

Background

ans..256

M

Background ambiance of form:

URL for a background image

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

- HTML-colour name

BGColor

ans..7

M

Form background colour:

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

- HTML-colour name

BGImage

ans..256

M

Form background image:

URL for a background image

Please note that this value supersedes “BGColor”.

FColor

ans..6

M

Text colour:

- HTML-colour value as HEX value or

- HTML-colour name

FFace

a..10

M

HTML-name for the font

FSize

n2

M

Number for font size

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.

URLBack

ans..256

M

URL for "Cancel" button

tWidth

ans..4

M

Width of table for input of the direct debit data as percent- (50%) or pixel values (320).

tHeight

ans..4

M

Height of table for input of the direct debit data as percent- (70%) or pixel values (480).

CustomField[n]

ans..50

O

Field that can be used individually by the merchant. Presently 14 fields from CustomField1 to CustomField14 are supported.

Layout parameters for Paygate forms for direct debit payments


The following table describes the result parameters that Paygate transmits to your URLNotify, URLSuccess or URLFailure. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..50

M

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

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

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

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

UserData

ans..1024

O

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

IBAN

ans..34

OC

only without PBAN configuration: International Bank Account Number

BIC

ans..11

O

Bank Identifier Code

AccOwner

ans..50

O

Name of account holder

AccBank

ans..20

O

Name of the financial institute of the account holder

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

CustomField[n]

ans..50

O

Field that can be used individually by the merchant. Presently 14 fields from CustomField1 to CustomField14 are supported.

General results parameters for URLNotify, URLSuccess and URLFailure



Direct connection

In addition to the general parameters described above for the direct debit connection the fol-lowing parameters need to be transmitted via form. The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

OrderDesc2

ans..384

M

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

Capture

ans..6

O

Determines the type and time of capture. AUTO: capturing immediately after authorisation (default value). MANUAL: capturing made by the merchant. <Number>: Delay in hours until the capture (whole number; 1 to 696).

MandateID

ans..35

C

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

should be unique, is not case-sensitive

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

DtOfSgntr

ans..10

O

for SEPA: Date of issuing the mandate in the format DD.MM.YYYY (obligatory when transferring the MandateID)

MdtSeqType

a4

O

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

Permissible values: FRST, RCUR, OOFF, FNAL

Standard: OOFF (single direct debit)

PBAN

ans..27

O

for SEPA: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number

Additional parameters for the direct debit connection via Paygate form


The following table gives the result parameters which the Paygate transmits especially for the direct connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:

Parameter

Format

CND

Description

MandateID

ans..35

O

for SEPA: SEPA mandate number

DtOfSgntr

ans..10

O

for SEPA: Registration date of granting mandate in the format DD.MM.YYYY

MdtSeqType

a4

O

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

Permissible values: FRST, RCUR, OOFF, FNAL

Standard: OOFF (single direct debit)

PBAN

ans..27

O

for SEPA: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number

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



b4payment

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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

RefNr

ns..30

O

Merchant’s unique reference number

AccBank

ans..20

O

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

AccOwner

ans..50

O

Name of account holder for the pre-completion of the form

IBAN

ans..34

O

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

BIC

ans..11

O

Bank Identifier Code for the pre-completion of the form

MandateID

ans..35

C

For SEPA: SEPA mandate number (compulsory in the case of SEPA)
It should be unique and it 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

For BACS: BACS mandate reference (optional)

If a previously generated mandate reference for this customer is transferred this one will be used and a new mandate is not created.

DtOfSgntr

ans..10

C

For SEPA/BACS: Date of issuing the mandate in the format DD.MM.YYYY (obligatory when transferring the MandateID)

Template

ans..20

M

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

If a BACS payment including mandate creation for the customer should be executed , the template name „b4pBACS_responsive“ can be used.

Additional parameters for the direct debit connection b4payment via Paygate form


The following table gives the result parameters which the Paygate transmits especially for the b4payment connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:

Parameter

Format

CND

Description

RefNr

ns..30

O

Merchant’s unique reference number

MandateID

ans..35

O

For BACS: BACS mandate reference

If this parameter is not submitted within request the process of mandate creating will be initiated at b4payment. Within the response the created MandateID and DtOfSgntr are returned. These parameters can be used for follow-up transactions.

DtOfSgntr

ans..10

O

For BACS: Date of issuing the mandate in the format DD.MM.YYYY (see also MandateID)

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



EVO Payments

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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

EDDMethod

a3

O

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

OrderDesc2

ans..384

M

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

MandateID

ans..35

C

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

should be unique, is not case-sensitive

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

DtOfSgntr

ans..10

O

for SEPA: Date of issuing the mandate in the format DD.MM.YYYY (obligatory when transferring the MandateID)

MdtSeqType

a4

O

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

Permissible values: FRST, RCUR, OOFF, FNAL

Standard: OOFF (single direct debit)

PBAN

ans..27

O

for SEPA: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number

SubSeqType

a4

O

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

DebitDelay

n..3

M

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

CreditDelay

n..3

O

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

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


The following table gives the result parameters which the Paygate transmits especially for the EVO Payments connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:

Parameter

Format

CND

Description

MandateID

ans..35

O

for SEPA: SEPA mandate number

DtOfSgntr

ans..10

O

for SEPA: Registration date of granting mandate in the format DD.MM.YYYY

MdtSeqType

a4

O

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

Permissible values: FRST, RCUR, OOFF, FNAL

Standard: OOFF (single direct debit)

PBAN

ans..27

O

for SEPA: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number

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



InterCard

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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

RefNr

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.

MandateID

ans..35

C

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

should be unique, is not case-sensitive

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

DtOfSgntr

ans..10

O

for SEPA: Date of issuing the mandate in the format DD.MM.YYYY (obligatory when transferring the MandateID)

PBAN

ans..27

O

for SEPA: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number

CustomerID

ans..30

M

Customer number at the merchant

DateOfRegistration

dttm8

O

Customer since in the format YYYYMMDD

CustomerClassification

ans..20

O

(business / private)

eMail

ans..80

O

E-mail address

DateOfBirth

dttm8

O

Date of birth in the format YYYYMMDD

bdSalutation

ans...4

O

Salutation of the invoicing address

bdFirstName

ans..30

M

First name of the invoicing address

bdLastName

ans..30

M

Last name of the invoicing address

bdStreet

a..50

M

Street name of the invoicing address

bdStreetNr

ans..5

M

Street number of the invoicing address

bdCountryCode

a2

O

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

bdZip

n..5

M

Postcode of the invoicing address

bdCity

a..32

M

Town or city of the invoicing address

bdPhone

ans..15

O

Phone number in the invoicing address

bdFax

ans..20

O

Fax number of the invoicing address

bdMaidenName

ans..30

O

Maiden name of the invoicing address

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

sdSalutation

ans...4

O

Salutation in the delivery address

sdFirstName

ans..30

O

First name in the delivery address

sdLastName

ans..30

O

Last name in the delivery address

sdStreet

a..50

O

Street in the delivery address

sdStreetNr

ans..5

O

Street number of the delivery address

sdCountryCode

a2

O

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

sdZip

n..5

O

Postcode in the delivery address

sdCity

a..50

O

Town/city in the delivery address

RegularCustomerIndicator

a..5

O

Regular customer (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

ArticleList

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

Additional parameters for the direct debit connection InterCard via Paygate form


The following table gives the result parameters which the Paygate transmits especially for the InterCard connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:

Parameter

Format

CND

Description

RefNr

ns..30

O

Merchant’s unique reference number

CodeExt

n..10

O

InterCard error code, only if agreed with Computop Support.

ErrorText

ans..128

C

InterCard error text.

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

MandateID

ans..35

O

for SEPA: SEPA mandate number

DtOfSgntr

ans..10

O

for SEPA: Registration date of granting mandate in the format DD.MM.YYYY

PBAN

ans..27

O

for SEPA: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number

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 pa-rameters need to be transmitted via form.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

RefNr

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.

SellingPoint

ans..50

O

Selling point

Service

ans..50

O

products or service sold

Channel

ans..64

O

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

Languagea2O2-letter language code (e.g.. de) that should be preferred when presenting payment pages to the consumer

Email

ans..100

M

E-Mail address of account holder

CustomerID

ans..30

O

Customer number

AddrCountryCode

a2

M

Two characters country code according to ISO 3166

Additional parameters for the direct debit connection PPRO via Paygate form


The following table gives the result parameters which the Paygate transmits especially for the PPRO connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:

Parameter

Format

CND

Description

RefNr

ans..40

O

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

PaymentPurpose

ans..26

O

Purpose of payment

PaymentGuarantee

a..12

C

NONE= no payment guarantee,

VALIDATED= customer account valid, but no payment guarantee,

FULL= payment guarantee

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

ErrorText

ans..128

C

Detailed PPRO error message.

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

TransactionID

an..20

O

Unique transaction number with PPRO

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



Paygate interface: via Server-to-Server

Chart of process flow via Server-to-Server

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


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


Call of interface: general parameters

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


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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

TransID

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.

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217 Only EUR is permissible.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

UserData

ans..256

O

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

ReqID

ans..32

O

To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

AccBank

ans..20

M

Bank name

AccOwner

a..50

M

Account holder

Capture

ans..6

O

Determines the type and time of capture. AUTO: capturing immediately after authorisation (default value). MANUAL: capturing made by the merchant. <Number>: Delay in hours until the capture (whole number; 1 to 696).

OrderDesc

ans..384

M

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

IBAN

ans..34

M

International Bank Account Number

BIC

ans..11

O

Bank Identifier Code

General parameters for direct debit payments via socket connection


The following table gives the parameters with which Paygate responds:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..50

M

OK, PENDING or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

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

UserData

ans..1024

O

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

IBAN

ans..34

O

International Bank Account Number

BIC

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

AccOwner

ans..50

OC

Only in the case of PBAN creation: Account holder

AccBank

ans..20

OC

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

MandateID

ans..35

O

SEPA mandate number

DtOfSgntr

ans..10

O

Registration date of granting mandate in the format DD.MM.YYYY

PBAN

ans..27

O

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

General response parameters for direct debit payments via socket connection



Direct connection

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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

OrderDesc2

ans..384

M

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

MandateID

ans..35

C

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

should be unique, is not case-sensitive

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

DtOfSgntr

ans..10

O

for SEPA: Date of issuing the mandate in the format DD.MM.YYYY (obligatory when transferring the MandateID)

MdtSeqType

a4

O

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

Permissible values: FRST, RCUR, OOFF, FNAL

Standard: OOFF (single direct debit)

PBAN

ans..27

O

for SEPA: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number

Additional parameters in case of activated DEVICERECOGNITION

DeviceID

ans..50

O

Unique Device-ID

DRConfidence

n..3

O

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

DRNewDevice

ans..5

O

True / false

DRAnonProxyUsed

ans..5

O

True / false

DRProxyUsed

ans..5

O

True / false

DRCountryCode

a2

O

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

DRCity

ans..50

O

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

DRLatitude

ans..50

O

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

DRLongitude

ans..50

O

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

DRFS

n..3

O

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

DRFSRulematch

ans..1024

O

Rules for allocation to fraud score

DRBrowserLanguages

ans..255

O

List of browser languages

DRIsMobileDevice

ans..5

O

True / false

Fraud

ans..50

O

e.g. Fraud, Suspicion, NoFraud

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


The following table gives the parameters with which Paygate responds:

Parameter

Format

CND

Description

MdtSeqType

a4

O

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

Permissible values: FRST, RCUR, OOFF, FNAL

Standard: OOFF (single direct debit)

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



b4payment

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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

RefNr

ns..30

O

Merchant’s unique reference number

FirstName

ans..70

C

First name of account holder [Condition: either AccOwner or First-Name + Lastname must exist]

LastName

ans..70

C

Last name of account holder [Condition: either AccOwner or First-Name + Lastname must exist]

BankAccount

n8

C

BACS account number [Condition: either IBAN or BankAccount + BankCode must exist]

BankCode

n6

C

BACS sort code [Condition: either IBAN or BankAccount + BankCode must exist]

OrderID

ans..1024

O

Unique ID to identify the order.
If not transferred, the Computop PayID is set as OrderID.

MandateID

ans..35

C

For SEPA: SEPA mandate number (compulsory in the case of SEPA)
It should be unique and it 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


For BACS: BACS mandate reference (optional for BACS)

If this parameter is not submitted, the process of mandate creating will be initiated at b4payment. Within the response the created MandateID and DtOfSgntr is returned. These parameters can be used for follow-up transactions.

DtOfSgntr

ans..10

C

For SEPA/BACS: Date of issuing the mandate in the format DD.MM.YYYY (obligatory when transferring the MandateID)

MdtSeqType

a4

O

Indicates whether the direct debit is a one-off or recurring direct debit.

Permissible values: OOFF, RCUR. Standard value: OOFF (single direct debit)

CustomerIDans..40CUnique designation of the customer from merchant's point of view, e.g. customer number, username etc. (Mandatory, if MdtSeqType=RCUR)

Parameters for mandate creation process (CND in that case, no MandateID is transferred)

Salutation

ans..20

O

Salutation of account holder

CompanyName

ans..70

O

Name of company

AddrStreet

ans..70

M

Street within address of account holder

AddrStreet2

ans..70

O

Extension – Street within address of account holder

AddrStreet3

ans..70

O

Extension – Street within address of account holder

AddrZip

ans..15

M

Postcode within address of account holder

AddrCity

ans..70

M

City within address of account holder

AddrCountryCode

a2

O

Country code in the card holder's address according to ISO-3166-1, alphanumeric 2-digits

Email

ans..70

M

E-Mail address of account holder

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


The following table gives the parameters with which Paygate responds:

Parameter

Format

CND

Description

CodeExt

n3

O

Error code from b4payment.

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

ErrorText

ans..128

O

Error text from b4payment.

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

MandateID

ans..35

O

For BACS: BACS mandate reference

If this parameter is not submitted within request the process of mandate creating will be initiated at b4payment. Within the response the created MandateID and DtOfSgntr are returned. These parameters can be used for follow-up transactions.

DtOfSgntr

ans..10

O

For BACS: Date of issuing the mandate in the format DD.MM.YYYY (see also MandateID)

PBAN

ans..27

O

For SEPA: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number

Use is possible only in agreement with Computop support.

Additional response tparameters for direct debit payments via socket connection for the connection b4payment

 


EVO Payments

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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

EDDMethod

a3

O

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

OrderDesc2

ans..384

M

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

MandateID

ans..35

C

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

should be unique, is not case-sensitive

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

DtOfSgntr

ans..10

O

for SEPA: Date of issuing the mandate in the format DD.MM.YYYY (obligatory when transferring the MandateID)

MdtSeqType

a4

O

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

Permissible values: FRST, RCUR, OOFF, FNAL

Standard: OOFF (single direct debit)

PBAN

ans..27

O

for SEPA: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number

SubSqType

a4

O

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

DebitDelay

n..3

M

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

CreditDelay

n..3

O

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

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


The following table gives the parameters with which Paygate responds:

Parameter

Format

CND

Description

MdtSeqType

a4

O

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

Permissible values: FRST, RCUR, OOFF, FNAL

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



InterCard

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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

RefNr

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.

MandateID

ans..35

C

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

should be unique, is not case-sensitive

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

DtOfSgntr

ans..10

O

for SEPA: Date of issuing the mandate in the format DD.MM.YYYY (obligatory when transferring the MandateID)

PBAN

ans..27

O

for SEPA: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number

CustomerID

ans..30

M

Customer number at the merchant

DateOfRegistration

dttm8

O

Customer since in the format YYYYMMDD

CustomerClassification

ans..20

O

(business / private)

eMail

ans..80

O

E-mail address

DateOfBirth

dttm8

O

Date of birth in the format YYYYMMDD

bdSalutation

ans...4

O

Salutation of the invoicing address

bdFirstName

ans..30

M

First name of the invoicing address

bdLastName

ans..30

M

Last name of the invoicing address

bdStreet

a..50

M

Street name of the invoicing address

bdStreetNr

ans..5

M

Street number of the invoicing address

bdCountryCode

a2

O

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

bdZip

n..5

M

Postcode of the invoicing address

bdCity

a..32

M

Town or city of the invoicing address

bdPhone

ans..15

O

Phone number in the invoicing address

bdFax

ans..20

O

Fax number of the invoicing address

bdMaidenName

ans..30

O

Maiden name of the invoicing address

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

sdSalutation

ans...4

O

Salutation in the delivery address

sdFirstName

ans..30

O

First name in the delivery address

sdLastName

ans..30

O

Last name in the delivery address

sdStreet

a..50

O

Street in the delivery address

sdStreetNr

ans..5

O

Street number of the delivery address

sdCountryCode

a2

O

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

sdZip

n..5

O

Postcode in the delivery address

sdCity

a..50

O

Town/city in the delivery address

RegularCustomerIndicator

a..5

O

Regular customer (true / false)

ShoppingBasket

ans..1024

O

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

- invoice number / order number
- total price net, numerical
- total price gross
- shipping costs net
- shipping costs gross
- rebate net
- rebate gross

<;> separates the fields in the shopping basket

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

ArticleList

ans..2048

C

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

- article description (ans..50)
- quantity
- article price net
- article price gross

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

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


The following table gives the parameters with which Paygate responds:

Parameter

Format

CND

Description

RefNr

ns..30

O

Merchant’s unique reference number

ErrorText

ans..128

C

InterCard error text.

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

CodeExt

n..10

O

InterCard error code, only if agreed with Computop Support.

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



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:


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

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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

PayID

an32

M

ID assigned by Paygate for the payment to be captured

TransID

ans..64

M

TransactionID which should be unique for each payment

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency code, three digits DIN / ISO 4217

RefNr

ns..30

M

Merchant’s unique reference number

ReqIDans..32OTo avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

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

DtOfSgntr

ans..10

O

for SEPA: Date of issuing the mandate in the format DD.MM.YYYY (obligatory when transferring the MandateID)

Parameters for captures of direct debit payments


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..50

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

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

RefNr

ns..30

O

Merchant’s unique reference number

Response parameters for captures of direct debit payments



Credit with reference

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

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


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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

PayID

an32

M

ID assigned by Paygate for the payment to be credited

TransID

ans..64

M

TransactionID which should be unique for each payment

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

RefNr

ns..30

C

not with EVO: Merchant’s unique reference number

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency code, three digits DIN / ISO 4217

ReqIDans..32OTo avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Parameters for credits of direct debit payments


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..50

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

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

RefNr

ns..30

C

not with EVO: Merchant’s unique reference number

Response parameters for credits of direct debit payments



Credit without reference

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

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

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

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


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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ns..30

O

Merchant’s unique reference number

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency code, three digits DIN / ISO 4217

AccOwner

ans..50

OC

Only in the case of PBAN creation: Account holder

AccBank

ans..20

OC

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

IBAN

ans..34

O

International Bank Account Number

BIC

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

OrderDesc

ans..768

M

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

ReqID

ans..32

O

To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

Parameters for credits of direct debit payments without reference


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

MC

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..50

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

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

Response parameters for credits of direct debit payments without reference



Credit without reference for Intercard

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

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

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


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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ns..30

O

Merchant’s unique reference number

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency code, three digits DIN / ISO 4217

AccOwner

ans..50

OC

Only in the case of PBAN creation: Account holder

AccBank

ans..20

OC

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

IBAN

ans..34

O

International Bank Account Number

BIC

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

OrderDesc

ans..768

M

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

ReqID

ans..32

O

To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

CustomerID

ans..30

M

Customer number at the merchant

DateOfRegistration

dttm8

O

Customer since in the format YYYYMMDD

CustomerClassification

ans..20

O

(business / private)

eMail

ans..80

O

E-mail address

DateOfBirth

dttm8

O

Date of birth in the format YYYYMMDD

bdSalutation

ans...4

O

Salutation of the invoicing address

bdFirstName

ans..30

M

First name of the invoicing address

bdLastName

ans..30

M

Last name of the invoicing address

bdStreet

a..50

M

Street name of the invoicing address

bdStreetNr

ans..5

M

Street number of the invoicing address

bdCountryCode

a2

O

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

bdZip

n..5

M

Postcode of the invoicing address

bdCity

a..32

M

Town or city of the invoicing address

bdPhone

ans..15

O

Phone number in the invoicing address

bdFax

ans..20

O

Fax number of the invoicing address

bdMaidenName

ans..30

O

Maiden name of the invoicing address

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

sdSalutation

ans...4

O

Salutation in the delivery address

sdFirstName

ans..30

O

First name in the delivery address

sdLastName

ans..30

O

Last name in the delivery address

sdStreet

a..50

O

Street in the delivery address

sdStreetNr

ans..5

O

Street number of the delivery address

sdCountryCode

a2

O

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

sdZip

n..5

O

Postcode in the delivery address

sdCity

a..50

O

Town/city in the delivery address

RegularCustomerIndicator

a..5

O

Regular customer (true / false)

Parameters for credits of direct debit payments without reference with Intercard


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

MC

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..50

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

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

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



Credit without reference for b4payment

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

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

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


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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ns..30

O

Merchant’s unique reference number

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency code, three digits DIN / ISO 4217

AccOwner

ans..50

C

Account holder [Condition: either AccOwner or First-Name + Lastname must exist]

FirstName

ans..70

C

First name of account holder [Condition: either AccOwner or First-Name + Lastname must exist]

LastName

ans..70

C

Last name of account holder [Condition: either AccOwner or First-Name + Lastname must exist]

IBAN

ans..34

C

International Bank Account Number [Condition: either IBAN or BankAccount + BankCode must exist]

BIC

ans..11

C

Bank Identifier Code:

BankAccount

n8

C

BACS account number [Condition: either IBAN or BankAccount + BankCode must exist]

BankCode

n6

C

BACS sort code [Condition: either IBAN or BankAccount + BankCode must exist]

OrderDesc

ans..768

M

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

ReqID

ans..32

O

To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

Parameters for credits of direct debit payments without reference with b4payment


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

MC

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..50

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

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

CodeExt

n3

O

Error code from b4payment.

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

ErrorText

ans..128

O

Error text from b4payment.

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

PBAN

ans..27

O

For SEPA: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number

Use is possible only in agreement with Computop support.

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



Reversal

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


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: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

PayID

an32

M

Paygate ID for the identification of a payment

TransID

ans..64

M

TransactionID which should be unique for each payment

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency code, three digits DIN / ISO 4217

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

ReqIDans..32OTo avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Parameters for reversals of direct debit payments


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

MC

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

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

TransID

ans..64

M

Merchant transaction number, which must be unique

Status

a..50

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

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

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 and via b4payment 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. BACS payments with b4payment are not possible via Batch.

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

Action

Version

Description

Capture

1.0 / 2.0

Standard version without return of parameter Code

 

1.x / 2.x

with RefNr (valid for all versions other than 1.0)

Authorize

1.0.1 / 2.0.1

Standard version without return of parameter Code

 

1.x.1 / 2.x.1

with RefNr (valid for all versions other than 1.0)

Sale

1.0.1 / 2.0.1

Standard version without return of parameter Code

 

1.x.1 / 2.x.1

with RefNr (valid for all versions other than 1.0)

Credit

1.0 / 2.0

Standard version without return of parameter Code

 

1.x / 2.x

with RefNr (valid for all versions other than 1.0)

CreditEx

1.0 / 2.0

Standard version without return of parameter Code

 

1.x / 2x.

with RefNr (valid for all versions other than 1.0)

Description of the possible batch versions


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

HEAD,<MerchantID>,<Date>,<Version>

EDD,Authorize,<Amount>,<Currency>,<TransID>,(<RefNr>,)<AccOwner>,<IBAN>,<BIC>,<AccBankName>,<OrderDesc1>,<OrderDesc2>,(<MandateID>,<DtOfSgntr>,<MdtSeqType>)

EDD,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>,)<AccOwner>,<IBAN>,<BIC>,<AccBankName>,<OrderDesc1>,<OrderDesc2>,(<MandateID>,<DtOfSgntr>,<MdtSeqType>)

EDD,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,(<MandateID>,<DtOfSgntr>,<MdtSeqType>)

EDD,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>

EDD,CreditEx,<Amount>,<Currency>,<TransID>,(<RefNr>,)<AccOwner>,<IBAN>,<BIC>,<AccBankName>,<OrderDesc1>,<OrderDesc2>

EDD,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>

FOOT,<CountRecords>,<SumAmount>


Example for Master MID Funktion:

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


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

Parameter

Format

CND

Description

Type

a..11

M

HEAD for Header, FOOT for Footer, EDD for direct debit

Action

a..20

M

The parameter Action defines the type of transaction:

Authorize (authorisation)

Capture

Sale

Credit

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

Reverse (cancellation)

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency code, three digits DIN / ISO 4217

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ns..30

O

Unique reference number

PayID

an32

M

ID for this transaction given by Paygate

AccOwner

ans..50

M

Account holder

IBAN

ans..34

M

International Bank Account Number

BIC

ans..11

O

Bank Identifier Code

AccBankName

ans..20

M

Name of the bank

OrderDesc1

ans..27

M

Text explaining customer account withdrawal, max. 27 characters

OrderDesc2

ans..27

M

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

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

DtOfSgntr

ans..10

O

Date of issuing the mandate in the format DD.MM.YYYY (obligatory when transferring the MandateID)

MdtSeqType

a4

O

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

Permissible values: FRST, RCUR, OOFF, FNAL

Standard: OOFF (single direct debit)

Description of fields within the record for Batch files

 

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

HEAD,<MerchantID>,<Date>,<Version>

EDD,Authorize,<Amount>,<Currency>,<TransID>,(<RefNr>,)<AccOwner>,<IBAN>,<BIC>,<AccBankName>,<OrderDesc1>,<OrderDesc2>,(<MandateID>,<DtOfSgntr>,<MdtSeqType>,)<Status>,<Code>

EDD,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>,)<AccOwner>,<IBAN>,<BIC>,<AccBankName>,<OrderDesc1>,<OrderDesc2>,(<MandateID>,<DtOfSgntr>,<MdtSeqType>,)<Status>,<Code>

EDD,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,(<MandateID>,<DtOfSgntr>,<MdtSeqType>,)<Status>,<Code>

EDD,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>

EDD,CreditEx,<Amount>,<Currency>,<TransID>,(<RefNr>,)<AccOwner>,<IBAN>,<BIC>,<AccBankName>,<OrderDesc1>,<OrderDesc2>,<Status>,<Code>

EDD,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>

FOOT,<CountRecords>,<SumAmount>

 

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

Parameter

Format

CND

Description

Action

a..20

M

The parameter Action defines the type of transaction like capture or credit – see above.

PayID

an32

M

ID for this transaction given by Paygate

Status

a..50

M

OK or FAILED

Code

n8

M

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

Description of result parameters within the record for Batch files