Versions Compared

Key

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

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


Page properties
Logo

Info
Excerpt

The

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
enables you to handle the direct debit mandates and payments popular with customers – and is fully compatible with SEPA.

TypePayments by Direct Debit
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameLink_CookieSessionHandling
DisableCachingtrue
PageWithExcerptReuse API


Table of Contents



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

Multiexcerpt
MultiExcerptNameProcessFlow_Form

draw.io Diagram
bordertrue
diagramNameEasyCollect-CT
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth1203

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


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
interface

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameDefinition
PageWithExcerptDefinition EN


Mandate creation with customer approval via OTP

The interface of the

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
form to approve a SEPA mandate is MandateForm.aspx.

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
MandateForm.aspx

This section explains the parameters for Mandate Approval.


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

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

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Key

Format

CND

Description

Beschreibung

TransID

ans..

64

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.

Account

ans.

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

.12

O

Within

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

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Table Excerpt Include
statictrue
nameURLSuccess
pageURLSuccess
typepage

Table Excerpt Include
statictrue
nameURLFailure
pageURLFailure
typepage

Table Excerpt Include
statictrue
nameResponse
pageResponse
typepage

Table Excerpt Include
statictrue
nameURLNotify
pageURLNotify
typepage-descendants

Key

Format

CND

Description

Beschreibung

Key

Format

CND

Description

Beschreibung




Consumer Data
Kundendaten
EMailans..254
M
OEmail address of the customer
E-Mail-Adresse des Kunden
FirstNameans..50
M
OFirst name
Vorname
LastNameans..50
M
OLast name
Nachname
companyNameans..50OName of the company
bdStreetans..50MStreet
Straße
bdStreetNrans..50MStreet number
Hausnummer
bdZipans..50MPostcode
Postleitzahl
bdCityans..50MTown
Ort
bdCountryCode
an2
a..3MCountry
-Code, ISO-3166Ländercode gemäß ISO-3166
code 2 or 3 characters according to ISO 3166
phoneans..50
M
OMobile 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
bdGendera1
M
O
  • M=Male
  • F=Female
  • M=männlich
  • F=weiblich



    Mandate Data
    Mandatsdaten
    contractId
    creditoridcontractId
    ans..50
    M

    SEPA Creditor Identifier (SCI)

    SEPA Creditor Identifier (SCI)
    O

    Underlying contract identifier

    contractDescription
    ans..50OUnderlying contract
    identifierKennung des zugrundeliegenden Vertrags
    description
    businessIdentifier
    contractDescription
    ans..50O
    Underlying contract descriptionBeschreibung des zugrundeliegenden VertragsEMAIL
    Unique SIREN Id of the merchant
    agreementSchemeenumO

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

    Value
    SMS (default)Given phone number (phone)
    EMAIL
    WertSMS (Standardwert)
    Given email address (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.

    Werttrue (Standardwert)Auf der letzten Seite des Dokuments befindet sich in der Mitte der Stempel.falseEs wird kein Stempel hinzugefügtWerttrue (Standardwert)false
    GoogleAnalyticsConsentenumO

    Debtor consent to use google analytics

    Value
    true (default)
    false

    Zustimmung des Schuldners zur Nutzung von Google Analytics


    SignatureByScaenumO

    If "true" customer will be authenticated by AccountIdentificationService.

    Value
    true
    (default)

    false
    Werttrue
    (
    Standardwert
    default)
    false

    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

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


    customerTypeenumO

    Type of customer

    Value
    KNOWNKnown customer
    PROSPECTUnknown customer
    MandateIDans..35O

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

    Pattern: ^[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
    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)
    EventTokenenumO

    Creates a new mandate and first direct debit transaction simultaneously.

    Value
    MandateCreates only a mandate, no payment
    PaymentCreates mandate and payment simultaneously
    DueDateans10O

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

    Pattern: YYYY-MM-DD

    CustomerIdan1..64O

    Customer identifier submitted by the merchant during a payment

    RemittanceInfoans..50O

    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
    signerPositionOccupiedans..70O

    Title of the signatory's position in the company

    templateans..20O

    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.

    Werttrue (Standardwert)falsecustomerTypeenumO

    Type of customer

    ValueKNOWNKnown customerPROSPECTUnknown customer

    Art des Kunden

    WertKNOWNBekannter KundePROSPECTUnbekannter Kunde

    Table Excerpt Include
    statictrue
    nameUserData
    pageUserData
    typepage

    Table Excerpt Include
    statictrue
    namePlain
    pagePlain
    typepage

    Table Excerpt Include
    statictrue
    nameCustom
    pageCustom
    typepage

    General parameters to create new SEPA Mandates approved with OTP

    code



    titleSample (Request)
    collapsetrue
    MerchantID=MerchantID
    TransID=TID-1679346326918-086560626017
    RefNr=iwxfd0gotxf0
    CustomerId=customerId123126
    EMail=email@email.com
    bdeMail=email@email.com
    Amount=123
    Currency=EUR
    URLSuccess=https://www.domain.com/ct-test-1/success.php
    URLFailure=https://www.domain.com/ct-test-1/failure.php
    URLNotify=https://www.domain.com/ct-test-1/notify.php
    OrderDesc=OrderDesc OrderDesc
    FirstName=Max
    bdFirstName=Mustermann
    LastName=Mustermann
    bdLastName=Mustermann
    creditorId=AXEPTA Merchant1
    contractDescription=ContractDescription
    contractId=ContractId123123
    bdStreet=Streetname
    bdStreetNr=1a
    bdZip=10010
    bdCity=Berlin
    bdCountryCode=DE
    phone=+491231234567
    bdPhone=+491231234567
    bdGender=M
    agreementScheme=SMS
    DocumentSignature=false
    GoogleAnalyticsConsent=false
    SignatureBySca=true
    Sps=false
    Validation=true
    customerType=KNOWN
    Language=en
    MAC=<MAC>

    Multiexcerpt include
    SpaceWithExcerptEN
    MultiExcerptNameResponse_IntroURL
    PageWithExcerptReuse API

    Table FilterdefaultBeschreibung

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

    Table Excerpt Include
    statictrue
    nameMID
    pagemid
    typepage

    Table Excerpt Include
    statictrue
    namePayID
    pagePayID
    typepage

    Table Excerpt Include
    statictrue
    nameXID
    pageXID
    typepage

    Table Excerpt Include
    statictrue
    nameTransID
    pageTransID
    typepage

    Table Excerpt Include
    statictrue
    nameStatus_OK_FAILED
    pageStatus
    typepage

    Table Excerpt Include
    statictrue
    nameDescription
    pageDescription
    typepage-children

    Table Excerpt Include
    statictrue
    nameCode
    pageCode
    typepage

    Key

    Format

    CND

    Description

    Beschreibung

    refnrMandateIdCurrently missing
    MandateIDans..35O

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

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

    Table Excerpt Include
    statictrue
    nameMAC
    pageMAC
    typepage

    Table Excerpt Include
    statictrue
    nameUserData
    pageUserData
    typepage

    Table Excerpt Include
    statictrue
    namePlain
    pagePlain
    typepage

    Table Excerpt Include
    statictrue
    nameCustom
    pageCustom
    typepage

    General results result parameters for URLNotify, URLSuccess and URLFailure

    Code Block
    titleSample (Response Success)
    collapsetrue
    mid=MerchantId PayID=06510075c0d644c98109db1ae4c55b38 TransID=TID-1679333858022-054078670102 Status=OK XID=2c6e5f87191148318e694e04cf92a6ba Code=00000000 Description=success refnr=iwxfd0gotxf0 MAC=17411E518F197AF15157B31C1CF097C033D94DD762845C56930380ADE8ECA449