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.
Type	Payments by Direct Debit

Cookie-/session - handling

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

eyJleHRTcnZJbnRlZ1R5cGUiOiIiLCJnQ2xpZW50SWQiOiIiLCJjcmVhdG9yTmFtZSI6IkFkbWluIiwib3V0cHV0VHlwZSI6ImJsb2NrIiwibGFzdE1vZGlmaWVyTmFtZSI6IkFkbWluIiwibGFuZ3VhZ2UiOiJlbiIsInVpQ29uZmlnIjoie1wiY3VzdG9tUHJlc2V0Q29sb3JzXCI6W1wiMTQxOTMyXCIsXCIwMDVhOTZcIixcIjAwOWVmZlwiLFwiZTQwMDAwXCIsXCJhNWY3MjlcIixcImZmYjcwMFwiXSxcImRlZmF1bHRDdXN0b21MaWJyYXJpZXNcIjpbXCJBMVwiXSxcInZlcnNpb25cIjpcIjEuMFwifSIsImRpYWdyYW1EaXNwbGF5TmFtZSI6IiIsInNGaWxlSWQiOiIiLCJhdHRJZCI6IjE3OTk2MjYwNyIsImRpYWdyYW1OYW1lIjoiRWFzeUNvbGxlY3QtQ1QiLCJhc3BlY3QiOiIiLCJsaW5rcyI6ImF1dG8iLCJjZW9OYW1lIjoiRWFzeUNvbGxlY3QiLCJ0YnN0eWxlIjoidG9wIiwiY2FuQ29tbWVudCI6ZmFsc2UsImRpYWdyYW1VcmwiOiIiLCJjc3ZGaWxlVXJsIjoiIiwiYm9yZGVyIjp0cnVlLCJtYXhTY2FsZSI6IjEiLCJvd25pbmdQYWdlSWQiOjg2NTQwODQ1LCJlZGl0YWJsZSI6ZmFsc2UsImNlb0lkIjoxNzk5NjQyOTYsInBhZ2VJZCI6IiIsImxib3giOnRydWUsInNlcnZlckNvbmZpZyI6eyJlbWFpbHByZXZpZXciOiIxIn0sIm9kcml2ZUlkIjoiIiwicmV2aXNpb24iOjAsIm1hY3JvSWQiOiIzZDM4MDdhOC0yMjdlLTRkNTYtODgyZi0zMDMyOTM0MTJjOWQiLCJwcmV2aWV3TmFtZSI6IkVhc3lDb2xsZWN0LUNULnBuZyIsImxpY2Vuc2VTdGF0dXMiOiJPSyIsInNlcnZpY2UiOiIiLCJpc1RlbXBsYXRlIjoiIiwid2lkdGgiOiIxMjAzIiwic2ltcGxlVmlld2VyIjpmYWxzZSwibGFzdE1vZGlmaWVkIjoiSnVuIDIzLCAyMDI1LCA5OjU1OjQxIEFNIiwiZXhjZWVkUGFnZVdpZHRoIjpmYWxzZSwib0NsaWVudElkIjoiIn0=

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.

https://www.computop-paygate.com/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.

Key	Format	CND	Description
MerchantID	ans..30	M	MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

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.

Key	Format	CND	Description
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).

Key	Format	CND	Description
Currency	a3	M	Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Key Format CND Description
MAC
an64
M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
HMAC Authentication (Request)
HMAC Authentication (Notify)

Key	Format	CND	Description
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.

Key	Format	CND	Description
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. 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.

Key	Format	CND	Description
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. 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.

Key	Format	CND	Description
Response	a7	O	Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.

Key	Format	CND	Description
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. Common notes: Before follow-up actions (capture / credit / reversal) are carried out on an existing transaction, the first Notify must have been answered by the shop. 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.

Key

Format

CND

Description

Beschreibung

Consumer Data

Kundendaten

EMail

ans..254

O

Email address of the customer

E-Mail-Adresse des Kunden

FirstName

ans..50

O

First name

Vorname

LastName

ans..50

O

Last name

Nachname

companyName

ans..50

O

Name of the company

Name des Unternehmens

bdStreet

ans..50

M

Street

Straße

bdStreetNr

ans..50

M

Street number

Hausnummer

bdZip

ans..50

M

Postcode

Postleitzahl

bdCity

ans..50

M

Town

Ort

bdCountryCode

a..3

M

Country code 2 or 3 characters according to ISO 3166

Ländercode zwei- oder dreistellig gemäß ISO 3166

phone

ans..50

O

Mobile phone of the customer; an OTP value is sent to this mobile number in case agreementScheme=SMS is used

Mobiltelefon des Kunden; an diese Mobiltelefonnummer wird ein OTP-Wert gesendet, falls agreementScheme=SMS verwendet wird

bdGender

a1

O

M=Male
F=Female

M=männlich
F=weiblich

Mandate Data

Mandatsdaten

contractId

ans..50

O

Underlying contract identifier

Kennung des zugrundeliegenden Vertrags

contractDescription

ans..50

O

Underlying contract description

Beschreibung des zugrundeliegenden Vertrags

businessIdentifier

ans..50

O

Unique SIREN Id of the merchant

Eindeutige SIREN-ID des Händlers

agreementScheme

enum

O

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

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

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

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

DocumentSignature

enum

O

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.
false	No 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.
false	Es wird kein Stempel hinzugefügt

GoogleAnalyticsConsent

enum

O

Debtor consent to use google analytics

Value
true (default)
false

Zustimmung des Schuldners zur Nutzung von Google Analytics

Wert
true (Standardwert)
false

SignatureBySca

enum

O

If "true" customer will be authenticated by AccountIdentificationService.

Value
true
false (default)

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

Wert
true
false (Standardwert)

Sps

enum

O

Allows to identify that WS call comes from SPS

Value
true (default)	WS call comes from SPS
false	WS 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
false	WS-Aufruf kommt nicht von SPS

Validation

enum

O

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

Value
true (default)
false

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

Wert
true (Standardwert)
false

customerType

enum

O

Type of customer

Value
KNOWN	Known customer
PROSPECT	Unknown customer

Art des Kunden

Wert
KNOWN	Bekannter Kunde
PROSPECT	Unbekannter Kunde

MandateID

ans..35

O

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

MdtSeqType

enum

O

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
OOFF	one-off mandate
RCUR	recurring 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
OOFF	einmaliges Mandat
RCUR	wiederkehrendes Mandat

MdtType

enum

O

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
B2B	Business-to-business mandate
CORE	Base 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
B2B	Business-to-Business-Mandat
CORE	Basismandat (Customer-to-Business)

EventToken

enum

O

Creates a new mandate and first direct debit transaction simultaneously.

Value
Mandate	Creates only a mandate, no payment
Payment	Creates mandate and payment simultaneously

Erzeugt gleichzeitig ein neues Mandat und die erste Lastschrifttransaktion.

Wert
Mandate	Erzeugt nur ein Mandat, keine Zahlung
Payment	Erzeugt Mandat und Zahlung gleichzeitig

DueDate

ans10

O

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

CustomerId

an1..64

O

Customer identifier submitted by the merchant during a payment

Vom Händler bei einer Zahlung übermittelte Kundenkennung

RemittanceInfo

ans..50

O

The RemittanceInfo parameter is required for reconciliation purposes, providing essential customer-visible information on customer bank statements for better tracking and reporting.

Allowed characters: A..Za..z0..9 / - ? : ( ) . , +
Diactrics like äöüÄÖÜ, áéíóú, àèìòù, âêîôû, ... are not allowed

Der Parameter „RemittanceInfo“ wird für Abstimmungszwecke benötigt und stellt wichtige, für den Kunden sichtbare Informationen auf Kundenkontoauszügen bereit, um eine bessere Nachverfolgung und Berichterstattung zu ermöglichen.

Erlaubte Zeichen: A..Za..z0..9 / - ? : ( ) . , +
Umlaute wie äöüÄÖÜ, áéíóú, àèìòù, âêîôû, ... sind nicht zulässig

signerPositionOccupied

ans..70

O

Title of the signatory's position in the company

Titel der Position des Unterzeichners im Unternehmen

template

ans..20

O

Name of a XSLT template to get an individual layout for your EasyCollect form which matches with your shop layout. Details are available here: Corporate PayPage and templates.

Name einer XSLT-Vorlage für ein individuelles Layout Ihres EasyCollect-Formulars, das zu Ihrem Shop-Layout passt. Details finden Sie hier: Corporate Paypage und Templates.

Key	Format	CND	Description
UserData	ans..1024	O	If specified at request, Paygate forwards the parameter with the payment result to the shop.

Key	Format	CND	Description
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.

Key	Format	CND	Description
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.

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:

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

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.

Key Format CND Description
mid
ans..30
M
MerchantID, assigned by Computop

Key Format CND Description
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.

Key Format CND Description
XID
an32
M
ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Key Format CND Description
TransID
ans..64
M TransactionID provided by you which should be unique for each payment

Key Format CND Description
Status
a..50
M
OK (URLSuccess) or FAILED (URLFailure)

Key Format CND Description
Description
ans..1024
M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Key Format CND Description
Code
an8
M
Error code according to Paygate Response Codes (A4 Error codes)

Key

Format

CND

Description

Beschreibung

MandateID

ans..35

O

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

Key Format CND Description
MAC
an64
M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
HMAC Authentication (Request)
HMAC Authentication (Notify)

Key Format CND Description
UserData
ans..1024
O
If specified at request, Paygate forwards the parameter with the payment result to the shop.

Key Format CND Description
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.

Key Format CND
Description
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.

General result parameters for URLNotify, URLSuccess and URLFailure

Space shortcuts

Page tree

About EasyCollect

General information about EasyCollect

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

Paygate interface

Definitions

Data formats

Abbreviations

Mandate creation with customer approval via OTP

Paygate

Computop

Help

Intranet Tools