- Created by Peter Posse on 11. Jun 2024
Über EasyCollect
Allgemeines zu EasyCollect
EasyCollect ist ein System von Worldline, mit dem Sie SEPA-Mandate für Lastschriften verwalten und Lastschriftzahlungen selbst abwickeln können.
SEPA-Mandate können mit einem Einmalpasswort (OTP) genehmigt werden, das dem Kunden entweder per SMS/Textnachricht oder per E-Mail übermittelt werden kann.
Transaktionsablauf einer Lastschriftzahlung im Internet
Um per Lastschrift bezahlen zu können, muss der Kunde zunächst ein SEPA-Mandat genehmigen. Dazu muss der Kunde in der Sitzung sein und die Mandatserstellung per OTP genehmigen.
Mit diesem SEPA-Mandat kann der Händler spätere SEPA-Lastschriftzahlungen veranlassen.
Logo | |
---|---|
Info | Das Paygate ermöglicht Ihnen die Abwicklung der bei Kunden beliebten Lastschriftmandate und Zahlungen – und ist vollständig SEPA-kompatibel. |
Typ | Zahlungen per Lastschrift |
Diagramm zum Prozessablauf: Mandatsfreigabe per Formularschnittstelle / Lastschrift per Server-2-Server-Verbindung
Prozessablauf Mandatsfreigabe per Formularschnittstelle / Lastschrift per Server-2-Server-Verbindung
Paygate-Schnittstelle
Datenformate: a alphabetisch as alphabetisch mit Sonderzeichen n numerisch an alphanumerisch ans alphanumerisch mit Sonderzeichen ns numerisch mit Sonderzeichen bool Bool’scher Ausdruck (true oder false) 3 feste Länge mit 3 Stellen/Zeichen ..3 variable Länge mit maximal 3 Stellen/Zeichen enum Aufzählung erlaubter Werte dttm ISODateTime (JJJJ-MM-TTThh:mm:ss) Abkürzungen: CND Bedingung (condition) M Pflicht (mandatory) O optional C bedingt (conditional) Hinweis: Bitte beachten Sie, dass die Bezeichnungen der Parameter in Groß- oder Kleinbuchstaben zurückgegeben werden können.Definitionen
Format Beschreibung Abkürzung Beschreibung Kommentar Wenn ein Parameter Pflicht ist, dann muss er vorhanden sein Wenn ein Parameter optional ist, dann kann er vorhanden sein, ist aber nicht erforderlich Wenn ein Parameter bedingt ist, dann gibt es eine Bedingungsregel, die angibt, ob er Pflicht oder optional ist
Mandatserstellung mit Kundenfreigabe per OTP
Die Schnittstelle des Paygate-Formulars zur Freigabe eines SEPA-Mandats ist MandateForm.aspx.
https://www.computop-paygate.com/MandateForm.aspx |
Dieser Abschnitt erläutert die Parameter zur Mandatsfreigabe.
Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp. Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
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 ...
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
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..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. | 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. |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
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. |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
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 |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
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: |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
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. |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
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:
| 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. Allgemeine Hinweise:
|
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
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:
| 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. Allgemeine Hinweise:
|
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
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. |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
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:
| 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. Allgemeine Hinweise:
|
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
RefNr |
Key | Format | CND | Description | Beschreibung | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Consumer Data | Kundendaten | |||||||||||||||
ans..254 | M | Email address of the customer | E-Mail-Adresse des Kunden | |||||||||||||
FirstName | ans..50 | M | First name | Vorname | ||||||||||||
LastName | ans..50 | M | Last name | Nachname | ||||||||||||
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 | an2 | M | Country-Code, ISO-3166 | Ländercode gemäß ISO-3166 | ||||||||||||
phone | ans..50 | M | 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 | M |
|
| ||||||||||||
Mandate Data | Mandatsdaten | |||||||||||||||
creditorid | ans..50 | M | SEPA Creditor Identifier (SCI) | SEPA Creditor Identifier (SCI) | ||||||||||||
contractId | ans..50 | O | Underlying contract identifier | Kennung des zugrundeliegenden Vertrags | ||||||||||||
contractDescription | ans..50 | O | Underlying contract description | Beschreibung des zugrundeliegenden Vertrags | ||||||||||||
agreementScheme | enum | O |
|
| ||||||||||||
DocumentSignature | enum | O | The stamp is added on the last page of the mandate document.
| Der Stempel wird auf der letzten Seite des Mandatsdokuments angebracht.
| ||||||||||||
GoogleAnalyticsConsent | enum | O | Debtor consent to use google analytics
| Zustimmung des Schuldners zur Nutzung von Google Analytics
| ||||||||||||
SignatureBySca | enum | O |
|
| ||||||||||||
Sps | enum | O | Allows to identify that WS call comes from SPS
| Ermöglicht die Identifizierung, dass der WS-Aufruf von SPS kommt
| ||||||||||||
Validation | enum | O | If Validation = TRUE --> ORG / If Validation = FALSE --> OTU
| If Validation = TRUE --> ORG / If Validation = FALSE --> OTU
| ||||||||||||
customerType | enum | O | Type of customer
| Art des Kunden
|
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
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. |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
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. |
Key | Format | CND | 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 |
Allgemeine Parameter zum Anlagen neuer SEPA-Mandate mit OTP-Freigabe
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>
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate an Ihre URLSuccess, URLFailure und URLNotify übergibt. Wenn Sie den Parameter Response=encrypt angegeben haben, werden die folgenden Parameter mit Blowfish verschlüsselt an Ihr System übergeben: es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden
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 ...
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | HändlerID, die von Computop vergeben wird |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
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. |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
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 |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment | Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | OK (URLSuccess) oder FAILED (URLFailure) |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
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! |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
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 | |
---|---|---|---|---|---|
refnr | |||||
MandateId | Currently missing | Fehlt derzeit |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
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: |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
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. |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
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. |
Key | Format | CND | 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 |
Allgemeine Antwortparameter für URLNotify, URLSuccess und URLFailure
mid=MerchantId PayID=06510075c0d644c98109db1ae4c55b38 TransID=TID-1679333858022-054078670102 Status=OK XID=2c6e5f87191148318e694e04cf92a6ba Code=00000000 Description=success refnr=iwxfd0gotxf0 MAC=17411E518F197AF15157B31C1CF097C033D94DD762845C56930380ADE8ECA449