About EasyCollect

General information about EasyCollect

EasyCollect is a system provided by Worldline to manage SEPA mandates for direct debits and also to handle direct debit payments themself.

SEPA Mandates can be approved with an One-Time-password (OTP) which can be provideed to the consumer either via SMS/text message or via email.

Transaction procedure of a direct debit payment on the Internet

In order to pay with a direct debit, the customer first needs to approve a SEPA mandate. Therefore the customer needs to be in session and approve the mandate creation via OTP.

Using this SEPA mandate the merchant can create later SEPA direct debit payments.


Logo

Info

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

TypePayments by Direct Debit





Chart of process flow: Mandate approval via form interface / Direct Debit via Server-2-Server connection

Process flow of Mandate approval via form interface / Direct Debit via Server-2-Server connection


Paygate interface

Definitions

Data formats

Format

Description

a

alphabetical

as

alphabetical with special characters

n

numeric

an

alphanumeric

ans

alphanumeric with special characters

ns

numeric with special characters

bool

boolean expression (true or false)

3

fixed length with 3 digits/characters

..3

variable length with maximum 3 digits/characters

enum

enumeration of allowed values

dttm

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


Abbreviations

Abbreviation

Description

Comment

CND

condition


M

mandatory

If a parameter is mandatory, then it must be present

O

optional

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

C

conditional

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


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


Mandate creation with customer approval via OTP

The interface of the Paygate form to approve a SEPA mandate is MandateForm.aspx.

This section explains the parameters for Mandate Approval.


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

The following table describes the encrypted payment request parameters:

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

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

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

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

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

Key

Format

CND

Description

Beschreibung

TransID

ans..35

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.

Transaktions-ID, die für jede Zahlung eindeutig sein sollte.

Bei Verwendung des Automandats (Befüllung der MandateID mit TransID oder RefNr) ist der zulässige Zeichensatz der des Parameters MandateID.

Account

ans..12

O

Within Paygate several EasyCollect accounts can be stored on one MerchantID and controlled by the parameter Account. Each account relates to a specific creditor configuration. By default, first entry will be used. The setup must be agreed with Computop Helpdesk.

Im Paygate können mehrere EasyCollect-Konten unter einer MerchantID gespeichert und über den Parameter „Account“ gesteuert werden. Jedes Konto bezieht sich auf eine bestimmte Gläubigerkonfiguration. Standardmäßig wird der erste Eintrag verwendet. Die Einrichtung muss mit dem Computop Helpdesk abgestimmt werden.

KeyFormatCNDDescriptionBeschreibung
Amount

n..10

M

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

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

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

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

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

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

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

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

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

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

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

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

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

(info) Common notes:

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

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

(info) Allgemeine Hinweise:

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

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

(info) Common notes:

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

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

(info) Allgemeine Hinweise:

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

KeyFormatCNDDescriptionBeschreibung
Response

a7

O

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

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

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

(info) Common notes:

  • Fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

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

(info) Allgemeine Hinweise:

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

Key

Format

CND

Description

Beschreibung




Consumer DataKundendaten
EMailans..254MEmail address of the customerE-Mail-Adresse des Kunden
FirstNameans..50MFirst nameVorname
LastNameans..50MLast nameNachname
bdStreetans..50MStreetStraße
bdStreetNrans..50MStreet numberHausnummer
bdZipans..50MPostcodePostleitzahl
bdCityans..50MTownOrt
bdCountryCodea..3MCountry code 2 or 3 characters according to ISO 3166Ländercode zwei- oder dreistellig gemäß ISO 3166
phoneans..50MMobile phone of the customer; an OTP value is sent to this mobile number in case agreementScheme=SMS is usedMobiltelefon des Kunden; an diese Mobiltelefonnummer wird ein OTP-Wert gesendet, falls agreementScheme=SMS verwendet wird
bdGendera1M
  • M=Male
  • F=Female
  • M=männlich
  • F=weiblich



Mandate DataMandatsdaten
contractIdans..50O

Underlying contract identifier

Kennung des zugrundeliegenden Vertrags
contractDescriptionans..50OUnderlying contract descriptionBeschreibung des zugrundeliegenden Vertrags
businessIdentifierans..50OUnique SIREN Id of the merchantEindeutige SIREN-ID des Händlers
agreementSchemeenumO

The way how the OneTimePassword (OTP) will be forwarded to the customer.

Value
SMS (default)Given phone number (phone)
EMAILGiven email address (EMail)

Der Weg, wie das Einmal-Passwort (OTP) zum Kunden weitergeleitet wird.

Wert
SMS (Standardwert)Angegebene Telefonnummer (phone)
EMAILAngegebene E-Mail-Adresse (EMail)
DocumentSignatureenumO

The stamp is added on the last page of the mandate document.

Value
true (default)The last page of the document will contain the stamp in the middle of the last page.
falseNo stamp is added

Der Stempel wird auf der letzten Seite des Mandatsdokuments angebracht.

Wert
true (Standardwert)Auf der letzten Seite des Dokuments befindet sich in der Mitte der Stempel.
falseEs wird kein Stempel hinzugefügt
GoogleAnalyticsConsentenumO

Debtor consent to use google analytics

Value
true (default)
false

Zustimmung des Schuldners zur Nutzung von Google Analytics

Wert
true (Standardwert)
false
SignatureByScaenumO

If "true" customer will be authenticated by AccountIdentificationService.

Value
true
false (default)

Wenn „true“, wird der Kunde durch AccountIdentificationService authentifiziert.

Wert
true
false (Standardwert)
SpsenumO

Allows to identify that WS call comes from SPS

Value
true (default)WS call comes from SPS
falseWS call does not come from SPS

Ermöglicht die Identifizierung, dass der WS-Aufruf von SPS kommt

Wert
true (Standardwert)WS-Aufruf kommt von SPS
falseWS-Aufruf kommt nicht von SPS
ValidationenumO

If Validation = TRUE --> ORG / If Validation = FALSE --> OTU

Value
true (default)
false

If Validation = TRUE --> ORG / If Validation = FALSE --> OTU

Wert
true (Standardwert)
false
customerTypeenumO

Type of customer

Value
KNOWNKnown customer
PROSPECTUnknown customer

Art des Kunden

Wert
KNOWNBekannter Kunde
PROSPECTUnbekannter Kunde
MandateIDans..35O

Predefined mandate id. The mandate itself will use this mandate id.

Pattern: ^[a-zA-Z\+\?\(\)\-\s:/.,_'0-9] {1,35}$

Vordefinierte Mandats-ID. Das Mandat selbst verwendet diese Mandats-ID.

Muster: ^[a-zA-Z\+\?\(\)\-\s:/.,_'0-9] {1,35}$

MdtSeqTypeenumO

Indicates whether the mandate is a one-off mandate or a mandate for recurring direct debits.

There is no default. The default value depends on merchant configuration.

Value
OOFFone-off mandate
RCURrecurring mandate

Gibt an, ob es sich um ein einmaliges Mandat oder ein Mandat für wiederkehrende Lastschriften handelt.

Es gibt keinen Standardwert. Der Standardwert hängt von der Händlerkonfiguration ab.

Wert
OOFFeinmaliges Mandat
RCURwiederkehrendes Mandat
MdtTypeenumO

Indicates whether the mandate is a business-to-business mandate or a customer-to-business mandate.

There is no default. The default value depends on merchant configuration.

Value
B2BBusiness-to-business mandate
COREBase mandate (customer-to-business)

Gibt an, ob es sich um ein Business-to-Business-Mandat oder ein Customer-to-Business-Mandat handelt.

Es gibt keinen Standardwert. Der Standardwert hängt von der Händlerkonfiguration ab.

Wert
B2BBusiness-to-Business-Mandat
COREBasismandat (Customer-to-Business)
EventTokenenumO

Creates a new mandate and first direct debit transaction simultaneously.

Value
PaymentCreates mandate and payment simultaneously.

Erzeugt gleichzeitig ein neues Mandat und die erste Lastschrifttransaktion.

Wert
PaymentErzeugt Mandat und Zahlung gleichzeitig.
DueDateans10O

DueDate of this transaction. If missing the current day will be used.

Pattern: YYYY-MM-DD

Fälligkeitsdatum dieser Transaktion. Fehlt diese Angabe, wird der aktuelle Tag verwendet.. 

Muster: JJJJ-MM-TT

CustomerIdan1..64O

Customer identifier submitted by the merchant during a payment

Vom Händler bei einer Zahlung übermittelte Kundenkennung

KeyFormatCNDDescriptionBeschreibung
UserData

ans..1024

O

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

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

KeyFormatCNDDescriptionBeschreibung
Plain

ans..50

O

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

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

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

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

KeyFormatCND

Description

Beschreibung
Custom

ans..1024

O

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

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

Please find a samples here: Custom

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

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

Hier finden Sie ein Beispiel: Custom

General parameters to create new SEPA Mandates approved with OTP


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

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

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

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

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

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

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

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

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

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

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

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

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
Description

ans..1024

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

KeyFormatCNDDescriptionBeschreibung
Code

an8

M

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

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

Key

Format

CND

Description

Beschreibung

MandateIDans..35O

Predefined mandate id. The mandate itself will use this mandate id.

Pattern: ^[a-zA-Z\+\?\(\)\-\s:/.,_'0-9] {1,35}$

Vordefinierte Mandats-ID. Das Mandat selbst verwendet diese Mandats-ID.

Muster: ^[a-zA-Z\+\?\(\)\-\s:/.,_'0-9] {1,35}$

KeyFormatCNDDescriptionBeschreibung

MAC

an64

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

KeyFormatCNDDescriptionBeschreibung
UserData

ans..1024

O

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

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

KeyFormatCNDDescriptionBeschreibung
Plain

ans..50

O

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

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

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

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

KeyFormatCND

Description

Beschreibung
Custom

ans..1024

O

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

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

Please find a samples here: Custom

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

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

Hier finden Sie ein Beispiel: Custom

General result parameters for URLNotify, URLSuccess and URLFailure