Über Paytweak
Allgemeines zu Paytweak
Paytweak PayByLink-Lösung per E-Mail und SMS. Der von Paytweak generierte Zahlungslink ist direkt mit 500 Banken und PSPs weltweit verbunden. Es sichert, beschleunigt und beseitigt Reibungsverluste bei allen eingehenden Zahlungen.
Weitere Informationen finden Sie auf der Webseite von Paytweak (https://www.paytweak.com/).
Diagramm zum Prozessablauf
Prozessablauf Paytweak
Paygate-Schnittstelle
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) 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
Datenformate
Format Beschreibung Abkürzungen
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
Aufruf der Schnittstelle für Paytweak
Um eine Zahlung mit Paytweak auszuführen, verwenden Sie bitte folgende URL:
https://www.computop-paygate.com/paybylinkexternal.aspx |
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:
| Key | Format | CND | Beschreibung |
|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| TransID | ans..64 | M | Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Amount | n..10 | M | 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 | Beschreibung |
|---|---|---|---|
| Currency | a3 | M | Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: |
Key | Format | CND | Beschreibung |
|---|---|---|---|
bdEmail | ans..32 | M | E-Mail-Adresse des Kunden. Falls Pay By Link per E-Mail versendet wird, erfolgt der Versand an diese Adresse. |
bdPhone | n..16 | M | Telefonnummer des Kunden. Falls der Pay-By-Link per SMS gesendet wird, wird er an diese Nummer gesendet. |
bdFirstName | ans..32 | O | Vorname des Kunden |
bdLastName | ans..32 | O | Nachname des Kunden |
Gender | a1 | O | Geschlecht |
bdStreet | ans..100 | O | Straßenname |
bdStreetNr | ans..30 | O | Hausnummer |
bdStreet2 | ans..100 | O | Zusätzliche Adressinformationen |
bdZIP | n..9 | M | Postleitzahl |
bdCity | ans..20 | O | Ort |
bdCountryCode | a2 | M | Ländercode der Adresse des Kontoinhabers, 2 Zeichen gemäß ISO 3166 |
OrderId | ans..30 | O | Vertrags-ID (BNP-spezifisch) |
InvoiceId | ans..30 | O | Rechnungs-ID (BNP-spezifisch) |
partialPayment | bool | O | Gibt an, ob die Zahlung teilweise erfolgt oder nicht. Wird bei der Duplikatsprüfung verwendet. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| URLSuccess | ans..256 | M | 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.
|
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| URLFailure | ans..256 | M | Vollständige URL, die das Paygate aufruft, 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.
|
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Response | a7 | O | 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 | Beschreibung |
|---|---|---|---|
| URLNotify | ans..256 | M | 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.
|
Key | Format | CND | Beschreibung |
|---|---|---|---|
Service | a..16 | M | Dieser Wert dient zur Identifizierung der Versandmethode für den Zahlungslink an den Kunden. Mögliche Werte:
|
language | a2 | O | Sprache der Zahlungsseite (falls aktiviert, auch Sprache der Bestätigungs-E-Mail und der Bestätigungsseite). Zusätzlich Sprache der E-Mail/SMS mit dem Bezahllink. |
externalTemplate | ans..32 | C | Name der für E-Mail oder SMS zu verwendenden Vorlage. Obligatorisch für den Dienst SMS/E-Mail |
Expiration | n..3 | O | Ablaufdatum von "Pay by link" (in Tagen) |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Plain | ans..50 | O | 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 | Beschreibung |
|---|---|---|---|
| Custom | ans..1024 | O | 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. |
Parameter für Zahlungen mit Paytweak
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. mid, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden
| Key | Format | CND | Beschreibung |
|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| TransID | ans..64 | M | Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) oder FAILED (URLFailure) |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Description | ans..1024 | M | 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 | Beschreibung |
|---|---|---|---|
| Code | an8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: |
Key | Format | CND | Beschreibung | |
|---|---|---|---|---|
redirecturl | ans..256 | M | Enthält die URL der Computop-Zahlungsseite. Diese dient nur als Referenz. Geben Sie sie nicht an den Kunden weiter. | |
externalresponse | ans..256 | M | Enthält die URL des Bezahllinks und die Bestellnummer als Referenz. Der QR-Code ist ein Platzhalter und wird in Zukunft verwendet. | |
externallink | ans..128 | M | Enthält die URL zum Bezahlen per Link. Diese URL wird vom Kunden für die Zahlung verwendet. | |
linkchannel | a..16 | M | Enthält Informationen darüber, wie der Link an den Kunden gesendet wird, per E-Mail, SMS oder manuell vom Händler | |
linkexpiry | ans..32 | M | Datums-/Zeitstempel, wann der Link abläuft und nicht mehr verwendet werden kann | |
linkcreated | ans..32 | M | Datums-/Zeitstempel, wann der Link erzeugt wurde | |
Ergebnis-Parameter für URLNotify, URLSuccess und URLFailure bei Paytweak