EASY COLLECT UND DAS TRANSAKTIONSMANAGER INTERFACE
←
→
Transkription von Seiteninhalten
Wenn Ihr Browser die Seite nicht korrekt rendert, bitte, lesen Sie den Inhalt der Seite unten
Easy Collect und das
Transaktionsmanager
Interface
Inhaltsverzeichnis
1 Easy Collect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.1. Konfiguration Ihres Kontos für Easy Collect. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.1.1. Erstellen der Easy Collect ID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.1.1.1. Transaktionsmanager Passwort. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.1.2. Konstruktion Ihrer ClickandBuy Easy Collect URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.1.3. MD5 Verschlüsselung. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.2. Erteilen der Online Easy Collect Autorisierung. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.3. Erteilen der Offline Easy Collect Autorisierung . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.4. Widerrufen von Easy Collect Autorisierungen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2 Transaktionsmanager Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
2.1. Transaktionsmanager Interface WSDL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
2.1.1. Interfaces und Ihre Methoden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
2.2. Transaktionen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
2.2.1. Einzelne Transaktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
2.2.2. Multiple Transaktionen per Batchjob. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
2.2.2.1. placeEasyCollectMulti . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
2.2.2.2. partialEasyCollect. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
2.3. Statusabfragen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
2.3.1. Transaktionsgarantie . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
2.3.2. Status einzelner Transaktionen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
2.3.3. Kundenstatusabfragen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
2.3.4. Jobstatusabfragen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
2.3.5. Transaktionsmanager Interface Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
2.3.6. Stornierung von Abonnements eines Kunden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
2.4. Ecommerce Transaktionen (Reserve / Capture). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
2.4.1. Erstellen einer Reservierung. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
2.4.2. Einlösen einer Reservierung (Capture) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
2.4.3. Stornierung einer Reservierung. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
2.4.4. Reservierungsstatus-abfragen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
2.5. Umgang mit Fehlercodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
3 Transaktionsmanager in der Service Area. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
3.1. Transaktionen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
3.1.1. Einzelabrechnung (Debit). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
3.1.2. Einzelgutschrift (Credit). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
3.1.2.1. Gutschriften via E-Mail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
3.1.3. Stornierungen (Cancel). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Easy Collect und das Transaktionsmanager Interface – Seite 1
3.1.4. Transaktionsverarbeitung per Batch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
3.1.4.1. Syntax für „Abrechnen“ (debit). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
3.1.4.2. Syntax für „Gutschreiben“ (credit) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
3.1.4.3. Syntax für „GutschrIFTEN VIA e-MAIL“ (EMAILcredit). . . . . . . . . . . . . . 55
3.1.4.4. Syntax für „Stornieren“ (cancel). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
3.2. Statusabfragen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
3.3. Kundenregistrierung. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
3.4. Verwalten des Transaktionsmanagers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
4 Anhang . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
4.1. Komplexe Typen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
4.1.1. Easy Collect. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
4.1.2. Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
4.1.3. Payment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
4.1.4. Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
4.1.5. ECommerce. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
4.2. Soap Beispiele. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
4.2.1. Beispiel 1: getEasyCollectSingle660 (DEBIT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
4.2.2. Beispiel 2: isExternalBDRIDCommitted. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
4.2.3. Beispiel 3: rcCreateReservation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
4.3. Dokumentierte Fehlercodes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
4.4. Reservierte Parameternamen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
4.5. Nationcodes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
4.6. Währungscodes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
5 Hilfe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
6 Impressum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Easy Collect und das Transaktionsmanager Interface – Seite 2
Über diese Dokumentation
Diese Dokumentation beschreibt die Funktionsweise von ClickandBuy Easy Collect und dem Transaktions-
manager Interface und hilft Anbietern bei dessen Anbindung.
Zielgruppe
Diese Dokumentation richtet sich an Anbieter und Entwickler, die das ClickandBuy Transaktionsmanager
Interface implementieren und Ihre Anbindung vor der produktiven Verwendung testen möchten.
Easy Collect und das Transaktionsmanager Interface – Seite 3
1 Easy Collect
ClickandBuy Easy Collect ermöglicht es dem Anbieter, einen Kundenaccount zu einem späteren Zeitpunkt zu
belasten, ohne dass der Kunde wie üblich aktiv der Transaktion auf einer ClickandBuy Bezahlseite zustimmen
muss.
Das Prinzip von Easy Collect ist, dass der Kunde vom Anbieter einmalig auf eine ClickandBuy Easy Collect Au-
torisierungsseite geführt wird, wo er für spätere Zahlungen seine Erlaubnis erteilt. Eine erfolgreiche Autorisie-
rung übermittelt die ClickandBuy Kundenreferenznummer zum Anbietersystem, wo diese ggf. überprüft und
in einer Datenbank gespeichert werden kann. Der Anbieter ist nun befähigt, den Kundenaccount zu gegebener
Zeit in nahezu beliebiger Höhe mittels Transaktionsmanager Interface (TMI) zu belasten. Eine weitere Über-
führung zum bzw. Kundeninteraktion mit dem ClickandBuy System ist nicht notwendig.
Diese Integrationsmethode ist ideal für Anbieter, die Offline-Applikationen verwenden oder webbasierte
Systeme mit asynchronen Workflows betreiben.
1.1. Konfiguration Ihres Kontos
für Easy Collect
Um Easy Collect verwenden zu können muss zunächst das Transaktionsmanager Interface (TMI) seitens
ClickandBuy aktiviert werden.
1.1.1. Erstellen der Easy Collect ID
Damit Sie Ihren Kunden eine Autorisierung zur Belastung durch Easy Collect anbieten können müssen Sie ein
Skript auf einem frei zugänglichen Webserver hosten, damit Sie die Easy Collect Autorisierungsantwort vom
ClickandBuy System empfangen können. Die Ziel-URL des Skripts muss als URL eines Easy Collect Links im
Anbieteraccount wie folgt hinterlegt werden:
1. Wechseln Sie auf die Seite www.clickandbuy.com.
2. Loggen Sie sich ein mit ClickandBuy Benutzernamen und Passwort.
3. Wechseln Sie zu „Easy Collect“ in der entsprechenden Domain.
4. Klicken Sie den Button [Erzeugen].
Sie gelangen nun auf die Übersicht „Easy Collect ID“:
Easy Collect und das Transaktionsmanager Interface – Seite 4
Abbildung 1-a: Erstellen der Easy Collect ID
Die zu definierenden Optionen sind in der nachstehenden Tabelle näher beschrieben:
Easy Collect Ihr Transaktionsmanager Passwort (tmpassword), min. 6-stellig, alphanumerisch. Sie
Autorisierungs- werden zur Vergabe dieses Passwortes nur dann bei der Erstellung der ersten Easy Coll-
passwort ect ID aufgefordert, wenn es nicht bereits vorher definiert wurde (siehe Kapitel 1.1.1.1).
Ziellink Die Ziel-URL Ihres Easy Collect Skriptes bzw. Applikation. Die Antwort einer erfolg-
reichen Easy Collect Autorisierung wird auf dieses Skript gesendet.
Name Standardname des Angebots; wird auf den Easy Collect Autorisierungsseiten angezeigt.
Info Kurzbeschreibung des Angebots; wird auf den Easy Collect Autorisierungsseiten angezeigt.
MD5 Eingabe des Schlüssels, um per MD5 Verfahren verifizieren zu können, ob die Kommuni-
Verschlüsselung kation tatsächlich mit dem ClickandBuy System stattfindet (siehe Kapitel 1.1.3).
Tabelle 1-a: Konfiguration einer Easy Collect ID
Klicken Sie auf [Speichern], um eine neue Easy Collect ID zu speichern.
Easy Collect und das Transaktionsmanager Interface – Seite 5
1.1.1.1. Transaktionsmanager
Passwort
Das Transaktionsmanager Passwort wird für die Ausführung aller Transaktionsmanager Interface (TMI)
Methoden benötigt. Es ist nicht das selbe Passwort, welches Sie für den Login auf www.clickandbuy.com
verwenden.
Bei der Erstellung einer Easy Collect ID und beim Aufruf des Transaktionsmanagers werden Sie zur Definition
des Transaktionsmanager Passwortes aufgefordert, sofern es bislang noch nicht definiert wurde.
Sie können das Passwort jederzeit über [Transaktionsmanager >> Verwalten >> Passwort ändern] unter
Eingabe des aktuellen Passwortes ändern.
Abbildung 1-b: Zurücksetzen des Transaktionsmanager Passwortes
! HINWEIS:
Wenn Sie sich zum Reset des Transaktionsmanager Passwortes entschließen stellen Sie bitte sicher, dass
alle Skripte aktualisiert werden, die das tmPassword enthalten. Andernfalls ist die Kommunikation zu allen
ClickandBuy TMI Methoden gestört und Sie erhalten stets als Fehlermeldung den Code „41:BadPassword“
(siehe Anhang für komplette Fehlerliste).
Easy Collect und das Transaktionsmanager Interface – Seite 6
1.1.2. Konstruktion Ihrer
ClickandBuy Easy Collect URL
Um die URL Ihres Easy Collect Links zu erhalten, auf die Sie den Kunden zwecks Autorisierung leiten müssen
klicken Sie innerhalb des „Easy Collect“ Menüs auf [Autorisierungsseite einbauen]. Dadurch öffnet sich ein
Popup Fenster, das den genauen Premiumlink enthält.
Abbildung 1-c: Obtain your Easy Collect URL
Die Kommunikation zum ClickandBuy System wird für eine Easy Collect Autorisierung per HTTP GET vollzogen.
Sie können einen Query String mitsamt ClickandBuy-eigenen Systemparametern konstruieren, mit dem z.B.
Name und Info des Angebots angezeigt werden können. Zudem haben Sie die Möglichkeit, eigene Parameter
zu übermitteln, die Sie für die Zuordnung in Ihrem System benötigen.
Ein Beispiel mittels eines einfachen HTTP Web Forms könnte so aussehen:
…
…
Easy Collect und das Transaktionsmanager Interface – Seite 7
Nachfolgend finden Sie eine Auflistung der dynamischen Parameter, die Sie in den Query String einfügen und
die Kommunikation mit ClickandBuy so steuern können. Achten Sie bitte darauf, dass die Parameter in der
korrekten Groß- und Kleinschreibung verwendet werden.
Name Beschreibung
cb_content_name_utf Füllt dynamisch das Feld Name des Links auf Autorisierungs-seite und Rechnung.
cb_content_info_utf Füllt dynamisch das Feld Info des Easy Collect Links auf der Autorisierungsseite
cb_billing_Nation Zweistelliger Nation Code
HINWEIS:
Es existieren Unterschiede zum ISO 3166 (z.B. entspricht ISO3166 GB bei ClickandBuy UK). Ggf. müssen Sie die ent-
sprechenden Nationen also noch “übersetzen”. Eine Auflistung der gültigen Werte finden Sie im Anhang, Kapitel 4.
Das ClickandBuy System unterstützt die folgenden Sprachen mit den jeweilig zu
verwendenden Parametern:
cs (tschechisch)
da (dänisch)
de (deutsch)
en (englisch)
es (spanisch)
lang fi (finnisch)
fr (französisch)
it (italienisch)
nl (niederländisch)
no (norwegisch)
pl (polnisch)
pt (portugiesisch)
sv (schwedisch)
tr (türkisch)
HINWEIS:
Für nicht-unterstützte Sprachen wird als Standardsprache „englisch“ (en) verwendet. Achten Sie darauf, dass
immer Nation und lang zusammen übergeben werden!
Tabelle 1-b: ClickandBuy dynamische Transaktionsparameter
Ein beispielhafter Easy Collect Autorisierungslink mit allen dynamischen Parametern könnte wie folgt aussehen:
https://eu.clickandbuy.com/newauth/http://premium-6ss9n1whhoff96.u.clickandbuy.
com/skript.php?cb_content_name_utf=Mywebsite.com+Autorisierung&cb_content_
info_utf=Autorisierung+Beschreibung&cb_billing_Nation=DE&lang=de
Der vom Anbieter übermittelte Query String wird innerhalb des ClickandBuy Easy Collect Autorisierungsprozesses
gänzlich an das Zielskript übermittelt, damit die enthaltenen Werte überprüft und ggf. in die Anbieterdatenbank
gespeichert werden können. Der Anbieter kann eigene Parameter übermitteln, die ebenfalls vollständig zurück
zum Anbietersystem zurückgegeben werden (z.B. die Kundennummer o.ä.).
Easy Collect und das Transaktionsmanager Interface – Seite 8
Weitere eindeutige Parameter, die Sie an den Easy Collect Link anhängen und so das Registrierungsformular
für neue ClickandBuy Kunden vorausfüllen können, sind:
Name Beschreibung
Email E-Mail-Adresse
cb_billing_FirstName Vorname
cb_billing_MiddleName Zweiter Vorname (optional)
cb_billing_LastName Nachname
Company Firma
cb_billing_Street Straße
cb_billing_HouseNumber Hausnummer (soweit nicht enthalten in Straße)
cb_billing_Street2 Weitere Adressdetails (optional)
cb_billing_ZIP Postleitzahl
cb_billing_City Stadt
cb_billing_Nation Land
Phone Telefonnummer
Gender Anrede des Kunden. Erwartete Werte sind „M“ oder „F“.
DateOfBirth Geburtsdatum; kann in den folgenden Formaten übergeben werden:
DD/MM/YYYY
DD.MM.YYY
YYYYDDMM
Tabelle 1-c: ClickandBuy dynamische Registrierungsparameter
HINWEIS:
! Eine Liste von verbotenen (da vom System reservierten) Parametern befindet sich im Anhang.
Easy Collect und das Transaktionsmanager Interface – Seite 91.1.3. MD5 Verschlüsselung
Die MD5 Funktion, die Sie bei Erstellung einer Easy Collect ID verwenden können, ist ein optionales Zusatz-
feature, mit dem Sie überprüfen können, ob der Aufruf des Easy Collect Autorisierungsskripts tatsächlich von
ClickandBuy kommt und sichert so die Kommunikation.
Diese Funktion arbeitet folgendermaßen:
1. Ein Schlüsselwert wird für die jeweilige Easy Collect ID hinterlegt.
2. Das Zielskript des Anbieters errechnet einen MD5 Hash des gesamten zurückgegebenen Query Strings
(anbietereigene HTTP GET Parameter und die ClickandBuy HTTP GET Antwortparameter “cusrefno”
und “nationCode”).
3. ClickandBuy generiert denselben Hash und fügt diesen mithilfe des zusätzlichen HTTP GET Parameters
“cb_key” an den Query String, so dass dieser von Ihrem Autorisierungsskript aufgenommen und evaluiert
werden kann.
4. Das Anbieterskript muss sicherstellen, dass der eigens errechnete Hash mit dem per Parameter “cb_key”
übergebenen Wert übereinstimmt. Eine Abweichung deutet auf eine Manipulation des Skriptaufrufs hin.
// Merchant HTTP GET variables
$merchantParameter = $_GET['merchantParameter'];
// ClickandBuy HTTP GET variables
$cusrefno = $_GET['cusrefno'];
$nationCode = $_GET['nationCode'];
// ClickandBuy return hash
$cb_key = $_GET['cb_key'];
// Create hash
$key = ‟MD5SecretKey“;
$parameters = ‟merchantParameter=“ . $merchantParameter . ‟&cusrefno=“
. $cusrefno . ‟&nationCode=“ . $nationCode;
$my_key = md5($key . $parameters);
// Evaluation
if ($my_key !=$cb_key) {
$errorworkflow;
} else {
$successWorkflow;
}
Abbildung 1-d: Beispiel einer MD5 Hash- Erstellung und -Evaluierung in PHP
Easy Collect und das Transaktionsmanager Interface – Seite 101.2. Erteilen der Online
Easy Collect Autorisierung
Wird der Kunde auf die Easy Collect URL geleitet beginnt der ClickandBuy Autorisierungsprozess, wobei der
Kunde stets die Wahl hat, sich entweder neu bei ClickandBuy zu registrieren oder sich mit seinen Logindaten
zu authentifizieren, sofern er bereits registrierter ClickandBuy Kunde ist. Direkt im Anschluss an eine mögliche
Registrierung kann der Kunde in Echtzeit die Easy Collect Autorisierung erteilen.
Abbildung 1-e: Easy Collect Autorisierung aus Kundensicht
Klickt der Kunde auf [Bestätigen] wird er durch ClickandBuy auf die Ziel-URL des jeweiligen Easy Collect Links
geleitet, wobei gleichzeitig per HTTP GET die Antwortparameter übermittelt werden.
Der Empfang der folgenden Werte und das Speichern an den jeweiligen Kundendatensatz müssen vom Anbie-
tersystem garantiert werden.
HTTP GET Parameter Beschreibung
cusrefno ClickandBuy User-ID
nationCode Der Ländercode des ClickandBuy Kunden
cb_key MD5 Hash der ClickandBuy Antwort. Wird für die Authentizitätsüberprüfung
der Kommunikation mit dem ClickandBuy System verwendet.
*nur, wenn diese Funktion aktiviert wurde.
Tabelle 1-d: ClickandBuy Easy Collect Antwort
Easy Collect und das Transaktionsmanager Interface – Seite 11! HINWEIS:
Wie Sie einen Überblick über aktive und widerrufene Easy Collect Autorisierungen erlangen können
erläutert Kapitel 3.4.
Das folgende Diagramm illustriert den gesamten Easy Collect Autorisierungsworkflow:
ANBIETER-
KUNDE SYSTEM CLICKANDBUY
Kunde
Anmeldung Leitet Kunden registriert sich/
für den Service auf Easy Collect loggt sich ein
eines Anbieters Link bei ClickandBuy
Anzeige einer Empfang c
Erfolgsmeldung/ usrefno = und Easy Collect
OK
Weiterleitung nationCode = Autorisierung
auf den Inhalt
NOK
Kunde erhält
ClickandBuy
Fehlermeldung
Abbildung 1-f: Easy Collect Autorisierungsworkflow
Deutlich hervorzuheben ist, dass eine Easy Collect Autorisierung noch keine Zahlung des Kunden ist. Eine Zah-
lung muss nach erfolgreicher Autorisierung in einem zweiten Schritt über das Transaktionsmanager Interface
angestoßen werden.
! HINWEIS:
Nach erteilter Autorisierung erhält der ClickandBuy Kunde eine Bestätigung per E-Mail.
Easy Collect und das Transaktionsmanager Interface – Seite 121.3. Erteilen der Offline
Easy Collect Autorisierung
Sie haben die Möglichkeit, eine Easy Collect Autorisierung im Namen des Kunden zu erteilen. Voraussetzung
dafür ist, dass der Kunde einen ClickandBuy Kundenaccount besitzt.
Abbildung 1-g: Anbieter Service Area – Easy Collect einrichten
Per Klick auf [Autorisieren] erscheint das folgende Popup Fenster:
Abbildung 1-h: Easy Collect Autorisierung erteilen – offline
Easy Collect und das Transaktionsmanager Interface – Seite 13Die nachstehenden Informationen müssen von Ihnen eingegeben werden, um eine Easy Collect Autorisierung
im Namen des Kunden offline erteilen zu können.
Transaktionsmanager Ihr Transaktionsmanager Passwort (tmpassword), min. 6-stellig, alphanume-
Passwort risch. Sie werden zur Vergabe dieses Passwortes nur dann bei der Erstellung
der ersten Easy Collect ID aufgefordert, wenn es nicht bereits vorher definiert
wurde (siehe Kapitel 1.1.1.1).
Username/Customer Eindeutige Kundenreferenznummer im ClickandBuy System.
Reference Number
Easy Collect ID Sofern noch nicht vorausgefüllt geben Sie bitte hier die Easy Collect ID an,
für die eine Autorisierung erteilt werden soll.
Zip code Postleitzahl, die im Kundenaccount hinterlegt wurde.
Tabelle 1-e: Pflichtfelder bei einer Offline – Autorisierung.
Nach der erfolgreichen Autorisierung erhalten Sie eine Bestätigungsnachricht und können ab sofort den
Kundenaccount per Transaktionsmanager Interface belasten.
Abbildung 1-i: Meldung erfolgreiche Easy Collect Autorisierungserteilung – offline
! HINWEIS:
Eine offline erteilte Easy Collect Autorisierung speichert nicht die Kundendaten in die Anbieterdatenbank.
Sofern diese Daten für Sie als Anbieter von Belang sind muss ein manueller Datenabgleich stattfinden.
Easy Collect und das Transaktionsmanager Interface – Seite 141.4. Widerrufen von
Easy Collect Autorisierungen
Der Kunde kann seine Easy Collect Autorisierung in seinem Kundenaccount unter www.clickandbuy.com
widerrufen.
Nachdem er dies getan hat bleibt die Autorisierung für eine Frist von 7 Tagen aktiv, damit der Anbieter offene
Beträge einziehen kann.
! HINWEIS:
Der Anbieter erhält eine Bestätigungs-E-Mail im Fall des Widerrufs der Autorisierung. Zudem wird diese Infor-
mation auch per XML über den ClickandBuy Event Messaging Service (EMS) zur Verfügung gestellt.
Easy Collect und das Transaktionsmanager Interface – Seite 152 Transaktionsmanager Interface
Das Transaktionsmanager Interface (TMI) ist ein XML Webservice. Um mit dem Transaktionsmanager Interface
kommunizieren zu können benötigen Sie das Standard- Webprotokoll SOAP (Simple Object Access Protocol).
Das Transaktionsmanager Interface benötigt ein SOAP 1.2 Interface (XML Schema Definition: Part 2-20010502).
2.1. Transaktionsmanager
Interface WSDL
Die genaue Beschreibung des Transaktionsmanager Interface ist in der WSDL (Web Services Description
Language) enthalten.
Die originale WSDL ist an folgendem Ort erhältlich:
http://wsdl.[system-id].clickandbuy.com/TMI/1.4/
TransactionManagerbinding.wsdl
TransactionManager.wsdl
TransactionManager.xsd
Wenn Sie ASP.NET verwenden:
http://wsdl.[system-id].clickandbuy.com/TMI/1.4/
TransactionManager_dotNET.wsdl
Dabei steht [system-id] in der URL für einen zweistelligen ISO-Ländercode. „eu“ steht dabei für alle euro-
päischen Länder, „us“ für die Vereinigten Staaten, „uk“ für Großbritannien usw. Dies ist derselbe Ländercode,
der auch in Ihrem Transaktionslink auftaucht.
Um eine Anfrage abzusetzen muss die Struktur der WSDL eingehalten werden. Verwenden Sie für Parameter
oder Textfelder den UTF-8 Zeichensatz.
Easy Collect und das Transaktionsmanager Interface – Seite 162.1.1. Interfaces und Ihre Methoden
Der Transaktionsmanager verwendet die folgenden Interfaces:
Payment
Status
Ecommerce
Tabelle 2-a gibt einen kurzen Überblick über die Methoden, die für jedes Interface zur Verfügung stehen. Eine
jeweils genauere Beschreibung finden Sie in den folgenden Kapiteln.
Eine erfolgreich ausgeführte Methode wird typischerweise innerhalb von 5 Sekunden bearbeitet, die maximale
Antwortzeit von TMI ist 15 Sekunden für Payment und Status Methoden sowie 60 Sekunden für Ecommerce
Methoden. Danach erfolgt je ein Timeout.
Interface Methode Beschreibung
Payment getEasyCollectSingle Erstellen einer einzigen Belastung (debit), Gutschrift (credit),
Gutschrift via E-Mail (emailcredit) oder Stornierung (cancel).
placeEasyCollectMulti Simultane Übertragung mehrerer Debit-, Credit- und Stor-
nierungsanfragen. Die Transaktionen werden als Batchjob
ver-arbeitet (max 1.000 Anfragen pro Job).
partialEasyCollectBegin Eröffnet einen partiellen Easy Collect Job.
partialEasyCollectAddSingleItem Fügt dem partiellen Job ein einzelnes “Item” (Transaktion) zu.
partialEasyCollectAddItems Fügt dem partiellen Job mehrere “Items” (Transaktionen) zu.
partialEasyCollectFinish Schließt und startet so einen partiellen Easy Collect Job.
Status isBDRIDcommitted Mit dieser Methode können Sie anhand ihrer ID (BDRID
– Billing Data Record ID) prüfen, ob eine Transaktion auf
dem ClickandBuy System existiert bzw. gebucht wurde. Die
Methode antwortet in Echtzeit mit einem bool’schen Wert.
isExternalBDRIDcommitted Mit dieser Methode können Sie anhand ihrer externen ID
(externalBDRID – anbietereigene TransaktionsID) prüfen,
ob eine Transaktion auf dem ClickandBuy System existiert
bzw. gebucht wurde. Die Methode antwortet in Echtzeit mit
einem bool’schen Wert.
getBDRStatusByBDRID Diese Methode erlaubt es Ihnen den Status einer verbuch-
ten Transaktion (Zahlungsstatus und BDR Details) anhand
der BDRID abzufragen.
Easy Collect und das Transaktionsmanager Interface – Seite 17Interface Methode Beschreibung
getBDRStatusByExternalBDRID Diese Methode erlaubt es Ihnen den Status einer verbuch-
ten Transaktion (Zahlungsstatus und BDR Details) anhand
der externalBDRID abzufragen.
getCustomerTransactionStatus Abfrage der Transaktionsdaten eines bestimmten Kunden in
einem definierten Zeitraum.
getTransactionStatusByJobID Abfrage des Status eines aufgegebenen Batchjobs anhand
dessen ID und einer actionID (ID des Batch Items, also der
einzelnen Transaktion).
getTransactionStatusBy Abfrage des Status eines aufgegebenen Batchjobs anhand
ExternalBDRID der externalBDRID.
getCustomerStatusByCRN Abfrage des Kundenstatus anhand der eindeutigen Kunden-
referenznummer (crn).
getCustomerStatusByMSISDN Abfrage des Kundenstatus anhand seiner Mobilfunktelefon-
nummer (MSISDN).
getInterfaceStatus Abfrage des Transaktionsmanager Interface Status (an oder aus).
getJobStatusByJobID Abfrage des Status eines Jobs anhand der JobID.
getJobStatusByExtJobID Abfrage des Status eines Jobs anhand der externen JobID.
getJobItemsStatusByJobID Abfrage des Status einzelner Transaktionen (Items) inner-
halb eines Jobs anhand der JobID.
getJobItemsStatusByExtJobID Abfrage des Status einzelner Transaktionen (Items) inner-
halb eines Jobs anhand der externen JobID.
ECommerce rcCreateReservation Erstellt eine Reservierung auf den vollen übergebenen Betrag.
rcCaptureReservation Führt ein Capture (Einlösen der Reservierung) auf den vollen
oder partiellen Reservierungsbetrag aus.
rcCancelReservation Storniert eine Reservierung.
rcStatusReservation Statusabfrage über Reservierungs-/BDRID.
Tabelle 2-a: Überblick der TMI Methoden
In den nachfolgenden Kapiteln werden die Methoden einzeln erläutert, die Ausführungen zu den komplexen
Typen hingegen finden Sie im Kapitel 4.1.
Easy Collect und das Transaktionsmanager Interface – Seite 182.2. Transaktionen
Das Zahlungsinterface unterstützt die folgenden Transaktionstypen aus Anbietersicht:
DEBIT (Belastung des Kundenkontos),
CREDIT (Gutschrift des Kundenkontos),
CANCEL (Stornierung einer Transaktion).
Nach erfolgreicher Easy Collect Autorisierung durch den Kunden sollte vor dem Anstoßen von Zahlungstransak-
tionen der unten beschriebene Workflow beachtet werden, der den Kunden als „kreditwürdig“ bestätigt, bevor
die eigentliche Transaktion erfolgt und bevor der Zugriff auf den Dienst bzw. auf die erworbenen Güter erfolgt.
Dies kann durch die Statusmethode getCustomerStatusByCRN (vgl. Kapitel 2.4.3) erreicht werden.
ANBIETERSYSTEM CLICKANDBUY ANBIETERSYSTEM
Kunde
Status ist OK kann kaufen –
und Easy Collect Durchführung einer
Autorisierung TMI Zahlungs-
ist aktiv. transaktion.
Kunde
wird gebeten,
Kunde betritt seinen ClickandBuy
Überprüfung Status
den Shop und Account zu aktuali-
des ClickandBuy ist NOK.
möchte einen Kauf sieren oder eine an-
Kundenaccounts.
durchführen. dere Zahlmethode
STATUS- zu wählen.
Abfrage
Kunde wird auf
Keine aktive
den Easy Collect
Easy Collect
Autorisierungs-
Autorisierung.
workflow geführt.
Abbildung 2-a: Optimaler Kaufprozess aus Kundensicht bei Easy Collect
HINWEIS:
! Für eine erfolgreiche DEBIT (Belastungs-) Transaktion wird eine aktive Easy Collect Autorisierung benötigt.
Für CREDIT (Gutschrifts-) und CANCEL (Stornierungs-) Transaktionen wird diese nicht benötigt.
Easy Collect und das Transaktionsmanager Interface – Seite 192.2.1. Einzelne Transaktionen
Die Methode getEasyCollectSingle660 erlaubt es dem Anbieter, einzelne Debit oder Credit Transaktionen durch-
zuführen und zuvor durchgeführte Transaktionen einzeln zu stornieren (Gutschriften sind nicht stornierbar!).
getEasyCollectSingle660
NAME TYP
input sRequest TransactionManager.Payment.SingleRequest660
output TransactionManager.Payment.PaymentResponse660
exception TransactionManager.Payment.PaymentException
Tabelle 2-b: TransactionManager.Payment – getEasyCollectSingle660
2.2.2. Multiple Transaktionen
per Batchjob
Die EasyCollectMulti und PartialEasyCollect Methoden können dafür verwendet werden, mehrere Transaktionen
zur selben Zeit abzusetzen. Bei jeder Methode werden die Transaktionen zu sog. Jobs zusammengeführt. Die
einzelnen Jobelemente („Items“) werden sequenziell bearbeitet, wobei das Maximum bei 1000 Transaktionen
pro Job liegt. Die Bearbeitungszeit eines Jobs richtet sich nach der Anzahl der enthaltenen Einzeltransaktionen,
die typischerweise 5 Sekunden beanspruchen.
2.2.2.1. placeEasyCollectMulti
Die Methode placeEasyCollectMulti ist eine einfache allein stehende Methode, mit der eine Liste an Transak-
tionen mit einem einzigen Methodenaufruf übermittelt werden können. Jede Transaktion ist dabei ein sog.
„Item“ der Sequenz „PaymentRegItems“.
placeEasyCollectMulti660
NAME TYP
input sRequest TransactionManager.Payment.placeEasyCollectMulti660
output TransactionManager.Payment.placeEasyCollectMultiResponse
exception TransactionManager.Payment.PaymentException
Tabelle 2-c: TransactionManager.Payment – placeEasyCollectMulti660
Easy Collect und das Transaktionsmanager Interface – Seite 202.2.2.2. partialEasyCollect
Die PartialEasyCollect- Methoden sind ein spezieller Satz an Methoden, die im gemeinsamen Zusammenspiel
genutzt werden müssen.
Mit den PartialEasyCollect- Methoden können Sie mehrere Gruppen von Transaktionen durch mehrfache Metho-
denaufrufe in einem Job zusammenführen, ohne alle Items in einem einzigen Aufruf übermitteln zu müssen.
Zunächst muss die Methode partialEasyCollectBegin660 aufgerufen werden. Als Antwort erhalten Sie eine
eindeutige ClickandBuy System JobID, auf die Sie sich beim Hinzufügen von Transaktionen (Items) beziehen
müssen.
partialEasyCollectBegin
NAME TYP Format Beschreibung
Input sellerID Long Automatisch vom Dies ist Ihre eindeutige Account Referenz-
ClickandBuy System nummer im ClickandBuy System. Sie wird
generiert. Wertebereich auch als Merchant ID in den Stammdaten
long: 0, 12678967543233 Ihres Accounts geführt.
tmPassword String ISO 8859-1, Das Transaktionsmanager-passwort wird für
wenigstens 6, maximal alle Webservice Calls verwendet. Es kann in
10 Stellen Ihrem Anbieteraccount unter “Transaktions-
manager -> Verwalten” geändert werden.
extJobID Long ISO 8859-1, Anbieter-eigene JobID (optional).
maximal 10 Stellen
Output Long ClickandBuy JobID
Exception TransactionManager.Payment.PaymentException
Tabelle 2-c: TransactionManager.Payment – partialEasyCollectBegin
Easy Collect und das Transaktionsmanager Interface – Seite 21Um ein einzelnes Item zu einer existierenden Jobliste hinzuzufügen verwenden Sie dann die Methode
partialEasyCollectAddSingleItem660.
partialEasyCollectAddSingleItem660
NAME TYP Format Beschreibung
Input sellerID Long Automatisch vom Dies ist Ihre eindeutige Account Referenz-
ClickandBuy System ge- nummer im ClickandBuy System. Sie wird
neriert. Wertebereich: 0, auch als Merchant ID in den Stammdaten
12678967543233 Ihres Accounts geführt.
tmPassword String ISO 8859-1, Das Transaktionsmanager-passwort wird für
wenigstens 6, maximal alle Webservice Calls verwendet. Es kann in
10 Stellen Ihrem Anbieteraccount unter “Transaktions-
manager -> Verwalten” geändert werden.
mJobID Long Automatisch vom ClickandBuy JobID, die Sie zu Beginn nach der
ClickandBuy System ge- Initialisierung des Jobs als Antwort erhalten
neriert, maximal 8 Stellen haben.
item TransactionManager.Payment.PaymentRequest660
Output Long Automatisch vom ClickandBuy JobID
ClickandBuy System ge-
neriert, maximal 8 Stellen
Exception TransactionManager.Payment.PaymentException
Tabelle 2-d: TransactionManager.Payment – partialEasyCollectAddSingleItem660
Easy Collect und das Transaktionsmanager Interface – Seite 22Um multiple Items zu einer existierenden Jobliste hinzuzufügen verwenden Sie die Methode
partialEasyCollectAddItems660.
partialEasyCollectAddItems660
NAME TYP Format Beschreibung
Input sellerID Long Automatisch vom Dies ist Ihre eindeutige Account Referenz-
ClickandBuy System ge- nummer im ClickandBuy System. Sie wird
neriert. Wertebereich: 0, auch als Merchant ID in den Stammdaten
12678967543233 Ihres Accounts geführt.
tmPassword String ISO 8859-1, Das Transaktionsmanager-passwort wird für
wenigstens 6, alle Webservice Calls verwendet. Es kann in
maximal 10 Stellen Ihrem Anbieteraccount unter “Transaktions-
manager -> Verwalten” geändert werden.
mJobID Long Automatisch vom ClickandBuy JobID, die Sie zu Beginn nach der
ClickandBuy System ge- Initialisierung des Jobs als Antwort erhalten
neriert, maximal 8 Stellen haben.
mItem TransactionManager.Payment.PaymentReqItems660
Output Long Automatisch vom ClickandBuy JobID
ClickandBuy System ge-
neriert, maximal 8 Stellen
Exception TransactionManager.Payment.PaymentException
Tabelle 2-e: TransactionManager.Payment – partialEasyCollectAddItems660
Easy Collect und das Transaktionsmanager Interface – Seite 23Sind alle Items zu einem Job hinzugefügt worden muss die Methode partialEasyCollectFinish aufgerufen wer-
den. Dies schließt den Job, wodurch keine weiteren Transaktionen mehr in den Job aufgenommen werden und
der Transaktionsmanager beginnt mit der Bearbeitung des Jobs.
partialEasyCollectFinish
NAME TYP Format Beschreibung
Input sellerID Long Automatisch vom Dies ist Ihre eindeutige Account Referenz-
ClickandBuy System ge- nummer im ClickandBuy System. Sie wird
neriert. Wertebereich: 0, auch als Merchant ID in den Stammdaten
12678967543233 Ihres Accounts geführt.
tmPassword String ISO 8859-1, Das Transaktionsmanager-passwort wird für
wenigstens 6, maximal alle Webservice Calls verwendet. Es kann in
10 Stellen Ihrem Anbieteraccount unter “Transaktions-
manager -> Verwalten” geändert werden.
mJobID Long Automatisch vom ClickandBuy JobID, die Sie zu Beginn nach der
ClickandBuy System ge- Initialisierung des Jobs als Antwort erhalten
neriert, maximal 8 Stellen haben.
Output Long Automatisch vom ClickandBuy JobID
ClickandBuy System ge-
neriert, maximal 8 Stellen
Exception TransactionManager.Payment.PaymentException
Tabelle 2-f: TransactionManager.Payment – partialEasyCollectFinish
2.3. Statusabfragen
Die Methoden zur Statusabfrage dienen der einfachen Gewinnung von exakten Informationen zu Zahlungstrans-
aktionen, Kundenstatus sowie zu Status von Batchjobs.
Mit diesen Methoden können Sie konkret die folgenden Informationen gewinnen:
Wurde eine Transaktion erfolgreich verbucht?
Aktueller Status eines Kundenaccounts?
Aktueller Status einer Transaktion?
Aktueller Status eines Jobs?
Kaufhistorie eines Kunden in einem bestimmten Zeitfenster?
Einzelne Status von Items innerhalb eines Batchjobs.
Easy Collect und das Transaktionsmanager Interface – Seite 242.3.1. Transaktionsgarantie
Die hier aufgeführten Methoden ermöglichen es Ihnen in Echtzeit zu überprüfen, ob eine Transaktion (BDR,
Billing Detail Record) erfolgreich auf dem ClickandBuy System erstellt und verbucht wurde.
Typischerweise werden sie als Second Transaction Handshake (zweiter Transaktions-Handschlag, auch Second
Confirmation genannt) als Teil des ClickandBuy Transaktionssystems verwendet, um Einzelzahlungen zu vali-
dieren. Die Methoden bestätigen die korrekte Verbuchung der Transaktion auf dem ClickandBuy System, bevor
der Anbieter seinerseits die Transaktion als erfolgreich speichert. Dies verhindert eine mögliche Inkonsistenz
zwischen beiden Systemen im Fall eines Timeouts bzw. eines Systemausfalls.
! HINWEIS:
Diese Methoden dienen der reinen Statusermittlung und garantieren in keiner Weise die Sicherheit einer Zahlung.
isBDRIDCommitted
NAME TYP Format Beschreibung
Input sellerID Long Automatisch vom Dies ist Ihre eindeutige Account Referenz-
ClickandBuy System ge- nummer im ClickandBuy System. Sie wird
neriert. Wertebereich: 0, auch als Merchant ID in den Stammdaten
12678967543233 Ihres Accounts geführt.
tmPassword String ISO 8859-1, Das Transaktionsmanager-passwort wird für
wenigstens 6, maximal alle Webservice Calls verwendet. Es kann in
10 Stellen Ihrem Anbieteraccount unter “Transaktions-
manager -> Verwalten” geändert werden.
slaveMer- Long Automatisch vom Die slaveMerchantIDs sind die SellerIDs
chantID ClickandBuy System Ihrer Sub-merchantaccounts. Standardmäßig
generiert. Wertebereich setzen Sie diese bitte auf 0.
long: 0, 12678967543233
BDRID Long Automatisch vom ClickandBuy TransaktionsID
ClickandBuy System ge-
neriert. Wertebereich: 0,
12678967543233
Output ClickAndBuy.Transaction.BDRProcessingState
Exception TransactionManager.Status.StatusException
Tabelle 2-g: TransactionManager.Status – isBDRIDCommitted
Easy Collect und das Transaktionsmanager Interface – Seite 25isExternalBDRIDCommitted
NAME TYP Format Beschreibung
Input sellerID Long Automatisch vom Dies ist Ihre eindeutige Account Referenz-
ClickandBuy System ge- nummer im ClickandBuy System. Sie wird
neriert. Wertebereich: 0, auch als Merchant ID in den Stammdaten
12678967543233 Ihres Accounts geführt.
tmPassword String ISO 8859-1, Das Transaktionsmanager-passwort wird für
wenigstens 6, alle Webservice Calls verwendet. Es kann in
maximal 10 Stellen Ihrem Anbieteraccount unter “Transaktions-
manager -> Verwalten” geändert werden.
slaveMer- Long Automatisch vom Die slaveMerchantIDs sind die SellerIDs
chantID ClickandBuy System Ihrer Sub-merchantaccounts. Standardmäßig
generiert. Wertebereich setzen Sie diese bitte auf 0.
long: 0, 12678967543233
external- String ISO 8859-1, maximal Transaktionsnummer des Anbieters.
BDRID 64 Stellen.
Output ClickAndBuy.Transaction.BDRProcessingState
Exception TransactionManager.Status.StatusException
Tabelle 2-h: TransactionManager.Status – isExternalBDRIDCommitted
Easy Collect und das Transaktionsmanager Interface – Seite 262.3.2. Status einzelner
Transaktionen
Die folgenden Methoden erlauben es, den Status einer Transaktion anhand ihrer ClickandBuy BDRID oder
anhand der externalBDRID in Echtzeit zu erfragen.
HINWEIS:
! Damit Sie die vollständigen Details einer Transaktion als Antwort dieser Methoden erhalten muss der Clickand-
Buy Abrechnungsserver die Transaktion bearbeitet haben. Dies kann bis zu 30 Minuten nach erfolgreicher Trans-
aktionsverbuchung dauern.
getBDRStatusByBDRID
NAME TYP Format Beschreibung
Input sellerID Long Automatisch vom Dies ist Ihre eindeutige Account Referenz-
ClickandBuy System ge- nummer im ClickandBuy System. Sie wird
neriert. Wertebereich: 0, auch als Merchant ID in den Stammdaten
12678967543233 Ihres Accounts geführt.
tmPassword String ISO 8859-1, Das Transaktionsmanagerpasswort wird für
wenigstens 6, maximal alle Webservice Calls verwendet. Es kann in
10 Stellen Ihrem Anbieteraccount unter „Transaktion-
manager -> Verwalten“ geändert werden.
slaveMer- Long Automatisch vom Die slaveMerchantIDs sind die SellerIDs
chantID ClickandBuy System Ihrer Sub-merchantaccounts. Standardmäßig
generiert. Wertebereich setzen Sie diese bitte auf 0.
long: 0, 12678967543233
BDRID Long Automatisch vom ClickandBuy TransaktionsID
ClickandBuy System ge-
neriert. Wertebereich: 0,
12678967543233
Output ClickAndBuy.Transaction.BDRStatus
Exception TransactionManager.Status.StatusException
Tabelle 2-i: TransactionManager.Status – getBDRStatusByBDRID
Easy Collect und das Transaktionsmanager Interface – Seite 27getBDRStatusByExternalBDRID
NAME TYP Format Beschreibung
Input sellerID Long Automatisch vom Dies ist Ihre eindeutige Account Referenz-
ClickandBuy System ge- nummer im ClickandBuy System. Sie wird
neriert. Wertebereich: 0, auch als Merchant ID in den Stammdaten
12678967543233 Ihres Accounts geführt.
tmPassword String ISO 8859-1, Das Transaktionsmanager-passwort wird für
wenigstens 6, maximal alle Webservice Calls verwendet. Es kann in
10 Stellen Ihrem Anbieteraccount unter “Transaktions-
manager -> Verwalten” geändert werden.
slaveMer- Long Automatisch vom Die slaveMerchantIDs sind die SellerIDs
chantID ClickandBuy System Ihrer Sub-merchantaccounts. Standardmäßig
generiert. Wertebereich setzen Sie diese bitte auf 0.
long: 0, 12678967543233
external- String ISO 8859-1, maximal Transaktionsnummer des Anbieters.
BDRID 64 Stellen.
Output ClickAndBuy.Transaction.BDRStatus
Exception TransactionManager.Status.StatusException
Tabelle 2-j: TransactionManager.Status – getBDRStatusByExternalBDRID
Easy Collect und das Transaktionsmanager Interface – Seite 28getCustomerTransactionStatus
NAME TYP Format Beschreibung
Input sellerID Long Automatisch vom Dies ist Ihre eindeutige Account Referenz-
ClickandBuy System ge- nummer im ClickandBuy System. Sie wird
neriert. Wertebereich: 0, auch als Merchant ID in den Stammdaten
12678967543233 Ihres Accounts geführt.
tmPassword String ISO 8859-1, Das Transaktionsmanager-passwort wird für
wenigstens 6, maximal alle Webservice Calls verwendet. Es kann in
10 Stellen Ihrem Anbieteraccount unter “Transaktions-
manager -> Verwalten” geändert werden.
slave- Long Automatisch vom Die slaveMerchantIDs sind die SellerIDs
MerchantID ClickandBuy System Ihrer Sub-merchantaccounts. Standardmäßig
generiert. Wertebereich setzen Sie diese bitte auf 0.
long: 0, 12678967543233
crn String Automatisch vom Kundenreferenznummer; eindeutige Nummer
ClickandBuy System ge- eines Kunden im ClickandBuy System.
neriert. Wertebereich: 0,
12678967543233
startDate- String YYYYMMDDHH24MISS Startdatum und -uhrzeit des Zeitraums.
Time (UTC)
endDateTime String YYYYMMDDHH24MISS Enddatum und -uhrzeit des Zeitraums.
(UTC)
Output ClickAndBuy.Transaction.BDRStatusList
Exception TransactionManager.Status.StatusException
Tabelle 2-k: TransactionManager.Status – getCustomerTransactionStatus
Easy Collect und das Transaktionsmanager Interface – Seite 29getTransactionStatusByJobID
NAME TYP Format Beschreibung
Input sellerID Long Automatisch vom Dies ist Ihre eindeutige Account Referenz-
ClickandBuy System ge- nummer im ClickandBuy System. Sie wird
neriert. Wertebereich: 0, auch als Merchant ID in den Stammdaten
12678967543233 Ihres Accounts geführt.
tmPassword String ISO 8859-1, Das Transaktionsmanager-passwort wird für
wenigstens 6, maximal alle Webservice Calls verwendet. Es kann in
10 Stellen Ihrem Anbieteraccount unter “Transaktions-
manager -> Verwalten” geändert werden.
jobID Long Automatisch vom ClickandBuy JobID
ClickandBuy System ge-
neriert, maximal 8 Stellen
actionID Long 5 Stellen, minimum Die ActionID bestimmt einen bestimmten
00001, maximum 10000 Satz innerhalb eines Jobs.
Output ClickAndBuy.Transaction.TransStatusResponse
Exception TransactionManager.Status.StatusException
Tabelle 2-j: TransactionManager.Status – getTransactionStatusByJobID
! HINWEIS:
Diese Methode kann nur für Transaktionen eines Batchjobs verwendet werden.
Easy Collect und das Transaktionsmanager Interface – Seite 30getEmailCreditStatus
NAME TYP Format Beschreibung
Input sellerID Long Automatisch vom Dies ist Ihre eindeutige Account Referenz-
ClickandBuy System ge- nummer im ClickandBuy System. Sie wird
neriert. Wertebereich: 0, auch als Merchant ID in den Stammdaten
12678967543233 Ihres Accounts geführt.
tmPassword String ISO 8859-1, Das Transaktionsmanager-passwort wird für
wenigstens 6, maximal alle Webservice Calls verwendet. Es kann in
10 Stellen Ihrem Anbieteraccount unter “Transaktions-
manager -> Verwalten” geändert werden.
slave- Long Automatisch vom Die slaveMerchantIDs sind die SellerIDs
MerchantID ClickandBuy System Ihrer Sub-merchantaccounts. Standardmäßig
generiert. Wertebereich setzen Sie diese bitte auf 0.
long: 0, 12678967543233
transactionID Long Automatisch vom Die transactionID ist eine temporäre ID einer
ClickandBuy System Gutschrift an eine E-Mail-Adresse.
generiert. Wertebereich
long: 0, 12678967543233
external- ISO 8859-1, maximal Transaktionsnummer des Anbieters.
BDRID 64 Stellen.
Output TransactionManager.Status.getEmailCreditStatusResponse
Exception TransactionManager.Status.StatusException
Tabelle 2-k: TransactionManager.Status – getEmailCreditStatus
Easy Collect und das Transaktionsmanager Interface – Seite 312.3.3. Kundenstatusabfragen
Die nachstehenden Abfragemethoden können dafür verwendet werden, sich der Eignung eines ClickandBuy
Endkundenaccounts für die Belastung durch Easy Collect zu vergewissern.
getCustomerStatusByCRN
NAME TYP Format Beschreibung
Input sellerID Long Automatisch vom Dies ist Ihre eindeutige Account Referenz-
ClickandBuy System ge- nummer im ClickandBuy System. Sie wird
neriert. Wertebereich: 0, auch als Merchant ID in den Stammdaten
12678967543233 Ihres Accounts geführt.
tmPassword String ISO 8859-1, Das Transaktionsmanager-passwort wird für
wenigstens 6, maximal alle Webservice Calls verwendet. Es kann in
10 Stellen Ihrem Anbieteraccount unter “Transaktions-
manager -> Verwalten” geändert werden.
slave- Long Automatisch vom Die slaveMerchantIDs sind die SellerIDs
MerchantID ClickandBuy System Ihrer Sub-merchantaccounts. Standardmäßig
generiert. Wertebereich setzen Sie diese bitte auf 0.
long: 0, 12678967543233
crn String Automatisch vom Kundenreferenznummer; eindeutige Nummer
ClickandBuy System ge- eines Kunden im ClickandBuy System.
neriert. Wertebereich: 0,
12678967543233
easyCollectID Long Automatisch vom Dies ist die Easy Collect ID, welche im
ClickandBuy System ge- ClickandBuy System jeden Easy Collect Link
neriert. Wertebereich: 0, eindeutig ausweist.
12678967543233
Output ClickAndBuy.Transaction.CustomerStatus
Exception TransactionManager.Status.StatusException
Tabelle 2-k: TransactionManager.Status – getCustomerStatusByCRN
Easy Collect und das Transaktionsmanager Interface – Seite 32getCustomerStatusByMSISDN
NAME TYP Format Beschreibung
Input sellerID Long Automatisch vom Dies ist Ihre eindeutige Account Referenz-
ClickandBuy System ge- nummer im ClickandBuy System. Sie wird
neriert. Wertebereich: 0, auch als Merchant ID in den Stammdaten
12678967543233 Ihres Accounts geführt.
tmPassword String ISO 8859-1, Das Transaktionsmanager-passwort wird für
wenigstens 6, maximal alle Webservice Calls verwendet. Es kann in
10 Stellen Ihrem Anbieteraccount unter “Transaktions-
manager -> Verwalten” geändert werden.
slave- Long Automatisch vom Die slaveMerchantIDs sind die SellerIDs
MerchantID ClickandBuy System Ihrer Sub-merchantaccounts. Standardmäßig
generiert. Wertebereich setzen Sie diese bitte auf 0.
long: 0, 12678967543233
MSISDN Long Bei Registrierung ange- Im Kundenaccount hinterlegte mobile
gebene Telefonnummer Telefonnummer
easyCollectID Long Automatisch vom Dies ist die Easy Collect ID, welche im
ClickandBuy System ge- ClickandBuy System jeden Easy Collect Link
neriert. Wertebereich: 0, eindeutig ausweist.
12678967543233
Output ClickAndBuy.Transaction.CustomerStatus
Exception TransactionManager.Status.StatusException
Tabelle 2-l: TransactionManager.Status – getCustomerStatusByMSISDN
HINWEIS:
! Die “Mobile Subscriber Integrated Services Digital Network Number” (MSISDN) ist eine vom Kunden
auswählbare Mobilfunknummer, die er bei der Registrierung angeben kann.
Easy Collect und das Transaktionsmanager Interface – Seite 332.3.4. Jobstatusabfragen
Die nachfolgenden Methoden erlauben es, den Status eines beendeten Batchjobs und der enthaltenen Items in
Nahzeit anzufragen.
getJobStatusByJobID
NAME TYP Format Beschreibung
Input sellerID Long Automatisch vom Dies ist Ihre eindeutige Account Referenz-
ClickandBuy System ge- nummer im ClickandBuy System. Sie wird
neriert. Wertebereich: 0, auch als Merchant ID in den Stammdaten
12678967543233 Ihres Accounts geführt.
tmPassword String ISO 8859-1, Das Transaktionsmanager-passwort wird für
wenigstens 6, maximal alle Webservice Calls verwendet. Es kann in
10 Stellen Ihrem Anbieteraccount unter “Transaktions-
manager -> Verwalten” geändert werden.
jobID Long Automatisch vom ClickandBuy JobID
ClickandBuy System ge-
neriert, maximal 8 Stellen
Output ClickAndBuy.Transaction.JobStatusResponse
Exception TransactionManager.Status.StatusException
Tabelle 2-m: TransactionManager.Status – getJobStatusByJobID
getJobStatusByExtJobID
NAME TYP Format Beschreibung
Input sellerID Long Automatisch vom Dies ist Ihre eindeutige Account Referenz-
ClickandBuy System ge- nummer im ClickandBuy System. Sie wird
neriert. Wertebereich: 0, auch als Merchant ID in den Stammdaten
12678967543233 Ihres Accounts geführt.
tmPassword String ISO 8859-1, Das Transaktionsmanager-passwort wird für
wenigstens 6, maximal alle Webservice Calls verwendet. Es kann in
10 Stellen Ihrem Anbieteraccount unter “Transaktions-
manager -> Verwalten” geändert werden.
extJobID Long ISO 8859-1, maximal 10 Anbieter-eigene JobID (optional).
Stellen
Output ClickAndBuy.Transaction.JobDetailResponse
Exception TransactionManager.Status.StatusException
Tabelle 2-n: TransactionManager.Status – getJobStatusByExtJobID
Easy Collect und das Transaktionsmanager Interface – Seite 34getJobItemsStatusByJobID
NAME TYP Format Beschreibung
Input sellerID Long Automatisch vom Dies ist Ihre eindeutige Account Referenz-
ClickandBuy System ge- nummer im ClickandBuy System. Sie wird
neriert. Wertebereich: 0, auch als Merchant ID in den Stammdaten
12678967543233 Ihres Accounts geführt.
tmPassword String ISO 8859-1, Das Transaktionsmanagerpasswort wird für
wenigstens 6, maximal alle Webservice Calls verwendet. Es kann in
10 Stellen Ihrem Anbieteraccount unter „Transaktions-
manager -> Verwalten“ geändert werden.
jobID Long Automatisch vom ClickandBuy JobID
ClickandBuy System ge-
neriert, maximal 8 Stellen
Output ClickAndBuy.Transaction.JobStatusResponse
Exception TransactionManager.Status.StatusException
Tabelle 2-o: TransactionManager.Status – getJobItemsStatusByJobID
getJobItemsStatusByExtJobID
NAME TYP Format Beschreibung
Input sellerID Long Automatisch vom Dies ist Ihre eindeutige Account Referenz-
ClickandBuy System ge- nummer im ClickandBuy System. Sie wird
neriert. Wertebereich: 0, auch als Merchant ID in den Stammdaten
12678967543233 Ihres Accounts geführt.
tmPassword String ISO 8859-1, Das Transaktionsmanagerpasswort wird für
wenigstens 6, maximal alle Webservice Calls verwendet. Es kann in
10 Stellen Ihrem Anbieteraccount unter „Transaktions-
manager -> Verwalten“ geändert werden.
extJobID Long ISO 8859-1, maximal Anbieter-eigene JobID (optional).
10 Stellen
Output ClickAndBuy.Transaction.JobDetailResponse
Exception TransactionManager.Status.StatusException
Tabelle 2-p: TransactionManager.Status – getJobItemsStatusByExtJobID
Easy Collect und das Transaktionsmanager Interface – Seite 352.3.5. Transaktionsmanager
Interface Status
Mit dieser Methode können Sie den aktuellen Status hinsichtlich der technischen Erreichbarkeit des Transaktions-
manager Interfaces erfragen (an/aus).
getInterfaceStatus
NAME TYP Format Beschreibung
Input sellerID Long Automatisch vom Dies ist Ihre eindeutige Account Referenz-
ClickandBuy System ge- nummer im ClickandBuy System. Sie wird
neriert. Wertebereich: 0, auch als Merchant ID in den Stammdaten
12678967543233 Ihres Accounts geführt.
tmPassword String ISO 8859-1, Das Transaktionsmanagerpasswort wird für
wenigstens 6, maximal alle Webservice Calls verwendet. Es kann in
10 Stellen Ihrem Anbieteraccount unter „Transaktions-
manager -> Verwalten“ geändert werden.
Output Boolean
Exception TransactionManager.Status.StatusException
Tabelle 2-q: TransactionManager.Status – getInterfaceStatus
Easy Collect und das Transaktionsmanager Interface – Seite 362.3.6. Stornierung von
Abonnements eines Kunden
Sofern Sie das ClickandBuy Abonnementmodul verwenden haben Sie Möglichkeit, Abonnements über das
Transaktionsmanager Interface zu stornieren.
cancelSubscription
NAME TYP Format Beschreibung
Input sellerID Long Automatisch vom ClickandBuy Dies ist Ihre eindeutige Account Referenznummer
System generiert. Wertebe- im ClickandBuy System. Sie wird auch als Merchant
reich: 0, 12678967543233 ID in den Stammdaten Ihres Accounts geführt.
tmPass- String ISO 8859-1, wenigstens 6, Das Transaktionsmanagerpasswort wird für alle
word maximal 10 Stellen Webservice Calls verwendet. Es kann in Ihrem
Anbieteraccount unter „Transaktionsmanager ->
Verwalten“ geändert werden.
slave- Long Automatisch vom ClickandBuy Die slaveMerchantIDs sind die SellerIDs
Merchant- System generiert. Wertebe- Ihrer Submerchantaccounts. Standardmäßig
ID reich long: 0, 12678967543233 setzen Sie diese bitte auf 0.
subscrip- Long Wertebereich long: 0, vgl. subscribeID. Eindeutige ID des Abonnenten.
tionID 12678967543233
when string ISO 8859-1 siehe unten
Output TransactionManager.Subscription.cancelSubscriptionResponse
Exception TransactionManager.Subscription.SubscriptionException
Tabelle 2-r: TransactionManager.Subscription – cancelSubscription
when
WERT Beschreibung
ToEndOfSubs- Das Abonnement wird unter Berücksichtigung der Kündigungsfrist zum nächstmöglichen
CancelPeriod Zeitpunkt gekündigt. Ist also die Frist bereits verstrichen wird das Abonnement bis zum
übernächsten Wechsel fortgeführt.
ToEndOfCurrent- Das Abonnement wird unter Außerachtlassung der Kündigungsfrist zum nächstmöglichen
PaymentInterval Zeitpunkt gekündigt. Es ist also egal, ob eine Frist eventuell überschritten wurde. Das
Abonnement wird zum nächsten Gebührenwechsel gekündigt.
Now Das Abonnement wird ohne Einhaltung etwaiger Fristen unverzüglich und zu sofort gekündigt.
Tabelle 2-r: TransactionManager.Subscription – cancelSubscription
! HINWEIS:
Sollten Sie weitere Fragen zum Abonnementmodul haben fordern Sie bitte das aktuelle Handbuch an.
Easy Collect und das Transaktionsmanager Interface – Seite 37Sie können auch lesen
