Dokumentation für die Zusatzfunktion Paycode Version 1.4

Transkript

1 Dokumentation für die Zusatzfunktion Paycode Version 1.4 Stand: PAYMENT NETWORK AG. Alle Rechte vorbehalten. Es ist untersagt, Teile dieser Dokumentation ohne schriftliche Genehmigung der Payment Network AG zu reproduzieren oder unter Verwendung elektronischer Systeme zu verarbeiten, vervielfältigen oder zu verbreiten. Die PAYMENT NETWORK AG übernimmt keine Gewähr für die Funktion einzelner Programme oder von Teilen dieser. Insbesondere wird keine Haftung für eventuell aus dem Gebrauch resultierende Folgeschäden übernommen.

2 Handbuch Paycode, Version 1.4 Seite 2 von 9 Version Änderungsgrund Autor Datum 1.0 Basisdokumentation Florian Thoma Layoutanpassung Florian Thoma Neue Parameter Florian Thoma max_usage und currency_id 1.3 Verbesserungen Florian Thoma Parameter expires_days geändert Florian Thoma

3 Handbuch Paycode, Version 1.4 Seite 3 von 9 Inhaltsverzeichnis 1. Einleitung Generierung Paycode über Webseite Generierung Paycode über HTTP-Schnittstelle Parameter Hashwert-Generierung Test-Beispiel Übersicht der generierten Codes Tipps und Tricks Support Impressum und Kontakt... 9

4 Handbuch Paycode, Version 1.4 Seite 4 von 9 1. Einleitung Mit der Funktion Paycode erhalten Sie die Möglichkeit, einen 10-stelligen Code zu generieren, mit dem Ihre Kunden eine Zahlung via sofortüberweisung.de zu einem beliebigen Zeitpunkt aufnehmen können. Im Allgemeinen gibt es zwei Varianten, über die ein Paycode generiert werden kann: Einmal über unsere Webseite und zum anderen über eine HTTP-Schnittstelle. 2. Generierung Paycode über Webseite Loggen Sie sich unter in das Kundenmenü von sofortüberweisung.de ein. Klicken Sie dann im linken Menü unter Weitere Dienste auf Paycode. Sie haben jetzt die Möglichkeit, einen Zeitraum festzulegen, für die der Paycode maximal gültig ist. Sollte dieser Zeitraum überschritten werden, wird dem Kunden ein entsprechender Hinweis kommuniziert. Im Bereich Zahlungsdaten Projekt wählen Sie als Pflichtfeld das entsprechende Projekt aus und geben optional Betrag und Verwendungszwecke an. Weitere optionale Felder sind sofern vorhanden die Kontodaten Ihres Kunden (nicht empfohlen, da Sie ansonsten Ihren Kunden keine Auswahlmöglichkeit lassen welches Konto Ihr Kunde verwenden kann). Die Eingabe des Paycode kann auf der Seite erfolgen. WICHTIG! Wir empfehlen für die Nutzung der Zusatzfunktion Paycode ein eigenes Projekt anzulegen. Als Shopsystem wählen Sie bitte Eigenes Shopsystem (selbst programmiert). Die Einstellungen Erfolgslink und Abbruchlink sollten leer bleiben, sofern Sie einen Paycode aus unserem System generieren, da ansonsten Ihre Kunden zu einer evtl. anderen Seite weitergeleitet werden. Legen Sie bitte eine -Benachrichtigung für die Zahlungsbestätigung an. Falls Sie den Paycode in Verbindung mit einem Shopsystem nutzen, können Sie natürlich Einstellungen für Erfolgs- und Abbruchlink vornehmen. Sie sollten nur sicherstellen, dass die entsprechenden Daten von Ihrem System verarbeitet werden können.

5 Handbuch Paycode, Version 1.4 Seite 5 von 9 3. Generierung Paycode über HTTP-Schnittstelle Sie haben darüber hinaus die Möglichkeit, den Paycode auch über unsere HTTP-Schnittstelle zu generieren und somit den zurück gegebenen Wert (Paycode) direkt in Ihr System einzubauen. Dazu müssen Sie einen HTTP-Request (GET-Methode) an die URL: absetzen. Die zu übergebenden Parameter entnehmen Sie bitte dem nachfolgenden Kapitel. Als Rückgabewert erhalten Sie entweder einen Paycode oder eine entsprechende Meldung mit den fehlerhaften Parametern. Die Eingabe des Paycode kann auf der Seite erfolgen. 4. Parameter Zunächst übergeben Sie die Details des Empfängerkontos. Dies können Sie über die folgenden Parameter vornehmen: Parametername Pflicht Beschreibung user_id Ja Ihre Kundennummer bei Sofortüberweisung project_id Ja Die zur Zahlung zugehörige Projektnummer amount Nein Zahlungsbetrag currency_id Nein Währung der Transaktion (EUR, CHF) reason_1 Nein Verwendungszweck 1. Zeile, max. 27 Zeichen reason_2 Nein Verwendungszweck 2. Zeile, max. 27 Zeichen sender_holder Nein Absender: Kontoinhaber sender_account_number Nein Absender: Kontonummer sender_bank_code Nein Absender: Bankleitzahl sender_country_id Nein Absender: Land (z.b. DE, AT, CH, NL, BE etc.) / 2-stellig user_variable_0 Nein Kundenvariable 0 user_variable_1 Nein Kundenvariable 1 user_variable_2 Nein Kundenvariable 2 user_variable_3 Nein Kundenvariable 3 user_variable_4 Nein Kundenvariable 4 user_variable_5 Nein Kundenvariable 5

6 Handbuch Paycode, Version 1.4 Seite 6 von 9 expires Nein Gültigkeitsdauer in Tagen (max. 90 Tage, leer für unbegrenzt) max_usage Nein Anzahl der Verwendungen language_id Nein Sprache (z.b. DE, EN) hash Ja Hash-Wert zur Authentifizierung bei Sofortüberweisung Siehe Kapitel Hashwert-Generierung 5. Hashwert-Generierung Um sich bei der Sofortüberweisung für die Generierung eines Paycodes zu authentifizieren, müssen Sie den Parameter hash an uns übergeben. Die Generierung des Parameters setzt voraus, dass ein Projekt-Passwort hinterlegt wurde. Dies können Sie ggfs. nachholen, in dem Sie sich bei Sofortüberweisung einloggen, dass entsprechende Projekt auswählen und auf Erweiterte Einstellungen und dort auf Projekt-Passwort klicken und das gewünschte Passwort hinterlegen. Um den Hashwert zu errechnen, gehen Sie bitte wie folgt vor: <?php $data = array( 'user_id' => 'USER_ID', 'project_id' => 'PROJECT_ID', 'amount' => 'AMOUNT', 'currency_id' => 'CURRENCY_ID', 'reason_1' => 'REASON_1', 'reason_2' => 'REASON_2', 'sender_holder' => 'SENDER_HOLDER', 'sender_account_number' => 'SENDER_ACCOUNT_NUMBER', 'sender_bank_code' => 'SENDER_BANK_CODE', 'sender_country_id' => 'SENDER_COUNTRY_ID', 'user_variable_0' => 'USER_VARIABLE_0', 'user_variable_1' => 'USER_VARIABLE_1', 'user_variable_2' => 'USER_VARIABLE_2', 'user_variable_3' => 'USER_VARIABLE_3', 'user_variable_4' => 'USER_VARIABLE_4', 'user_variable_5' => 'USER_VARIABLE_5', 'expires' => 'EXPIRES', 'max_usage' => 'MAX_USAGE', 'language_id' => 'LANGUAGE_ID',

7 Handbuch Paycode, Version 1.4 Seite 7 von 9 ); 'project_password' => 'PROJECT_PASSWORD' $data_implode = implode(' ', $data); $hash = sha1($data_implode); echo $hash;?> Bitte ersetzen Sie die rechts von => angegebenen Werte durch die Werte, die Sie an uns übergeben werden. 6. Test-Beispiel Nachfolgend ein kleines Script-Beispiel, um einen neuen Paycode über die HTTP-Schnittstelle anzufordern. Standard Implementierung mittels PHP: $params = array( 'user_id' => 2, 'project_id' => 2, 'hash' => $hash ); $url = ' $url.= http_build_query($params, null, '&'); $paycode = file_get_contents($url); if (strpos($paycode, 'Errors') === false) { } echo $paycode;

8 Handbuch Paycode, Version 1.4 Seite 8 von 9 7. Übersicht der generierten Codes Im Kundenmenü der Sofortüberweisung haben Sie die Möglichkeit, eine Übersicht der bis dato generierten Paycodes zu erhalten. Dazu loggen Sie sich unter ein. Klicken Sie nun im Menü unter Weitere Dienste auf Paycode und wählen dann im oberen Tab-Menü den Punkt Bisherige Codes anzeigen aus. Sie erhalten eine Liste bestehend aus Paycode, Erstellungsdatum, Empfänger, Status und Betrag. 8. Tipps und Tricks Problem: Die Funktion file_get_contents bringt nur eine Fehlermeldung. Lösung: In der PHP ini muss die extension = php_openssl.dll aktiviert sein (nicht auskommentiert). 9. Support Das Team von Sofortüberweisung steht für Sie zur Verfügung, falls Sie Support brauchen. Sie können uns entweder eine an support@payment-network.com schreiben oder unter unser Supportformular ausfüllen. Ihre Nachricht wird dann an das Sofortüberweisung Ticket-Support-System weitergeleitet, das sicherstellt, dass Ihre Frage von einem Mitarbeiter zeitnah beantwortet wird.

9 Handbuch Paycode, Version 1.4 Seite 9 von Impressum und Kontakt Payment Network AG Fussbergstr. 1 D Gauting Tel.: +49 (0) Fax: +49 (0)89 / Vorstand: Christoph Klein (Vorsitz), Andrea Anderheggen, Dr. Jens Lütcke Aufsichtsrat: Dr. Michael Riemenschneider (Vorsitz) Eingetragen beim Amtsgericht München: HRB