Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Multiexcerpt include
SpaceWithExcerptDOCCT
MultiExcerptNameComputop Logo
PageWithExcerptPaygate DE

Integration Guide

Version 6.9

Stand 01.09.2019

Inhaltsverzeichnis

Table of Contents

Dokumenthistorie

Datum

Name

Änderung

01.09.2019

Peter Posse

Erstfassung Confluence

 


Über Hosted Payment Page

Allgemeines zur Hosted Payment Page

Die Hosted Payment Page ist ein Checkout, der nur den Schritt der Zahlungsarten-Auswahl enthält. Sie ist ein im responsiven Design gestaltetes HTML-Formular, welches auf allen Geräten korrekt dargestellt wird.

Bei Zahlungen über die Hosted Payment Page verbindet der Shop den Kunden mit dem HTML-Formular des Paygate, damit er dort die Zahlungsart auswählt. Nach dem Bestätigen der Auswahl leitet das Paygate den Kunden, je nach Zahlungsart, entweder zu einem HTML-Formular des Paygate oder zu einem Formular des externen Dienstleisters und informiert den Shop nach Abschluss über das Zahlungsergebnis.

Folgende Tabelle enthält die Zahlungsarten, die Sie über die Hosted Payment Page nutzen können:

Zahlungsart

PayType

Kreditkarte

CC

Lastschrift

EDD

PayPal

PayPal

iDEAL

iDEAL

Sofort

Sofort

giropay

giropay

paydirekt

paydirekt

Alipay

Alipay

Bancontact

BanconPP

Bank Transfer

BankTranPP

BitPay

BitPayPP

Dragonpay

DragonPP

eNETS

ENETSPP

Finland Online Bank Transfer

FinOBTPP

Indonesia ATM

IndoATMPP

Multibanco

MultibanPP

My Bank

MyBankPP

MyClear FPX

MyClearPP

Przelewy 24

P24PP

POLi

POLiPP

PostFinance

POSTFINPP

paysafecard

PSCPP

QIWI

QIWIPP

RHB Bank

RHBBankPP

SafetyPay

SafetyPPP

7-Eleven

SevenElePP

Skrill

SkrillPP

TrustPay

TrustPayPP

Apple PayApplePay
B4PaymentB4Payment
BoletoBoletoPP
CUPCUPPP
EPSEPS
WechatWechatPP



Folgende Tabelle enthält die Kartenmarken, die Sie über die Hosted Payment Page nutzen können. Bei Übergabe des Wertes CC im Parameter PayTypes werden alle für einen Händler konfigurierten Marken angezeigt. Die Auswahl bestimmter Marken ist durch die Übergabe einer Zeichenfolge der gewünschten Marken jeweils durch Pipe-Zeichen getrennt möglich.

Kreditkartenmarke, korrekte Schreibweise für CCBrand

AirPlus

AMEX

ARGENCARD

Aura

Bancontact

CABAL

Cartes Bancaires

Maestro

CBN

CENCOSUD

ComfortCard

CUP

Dankort

DINERS

Discover

Elo

Hipercard

JCB

Laser

Maestro

MasterCard

NARANJA

RuPay

SHOPPING

TOTAL

VISA


Ablauf der Zahlung

Um Zahlungen über die Hosted Payment Page auszuführen, rufen Sie folgende URL mit HTTPS GET oder HTTPS POST auf:


Alle Daten, die für eine Zahlungsabwicklung notwendig sind, werden als Parameter übergeben. Damit weder der Kunde noch ein Dritter die Daten manipulieren kann, werden die Parameter mit Blowfish verschlüsselt.

Beim Aufruf des Formulars entschlüsselt das Paygate die Parameter und zeigt die HTML-Seite mit den Zahlungsarten an. Dort wählt der Kunde die Zahlungsart aus und startet die Weiterleitung per Mausklick auf die Schaltfläche „Weiter“.

Nach Durchführung der Zahlung leitet das Paygate den Kunden per HTTPS GET auf eine Shop-Seite zurück (URLSuccess, URLFailure) und übergibt dabei das Zahlungsergebnis als Blowfish-verschlüsselte Parameter. Zusätzlich übermittelt das Paygate das Ergebnis per HTTPS POST an die Notify-Seite des Shops (URLNotify). Der Shop nimmt das Zahlungsergebnis entgegen und entschlüsselt die Daten, um den Kunden über den Status zu informieren.


Aufruf der Hosted Payment Page

Der Aufruf der Hosted Payment Page beginnt mit der korrekten Zusammenstellung der Parameter, die aus einem Schlüssel und einem Wert bestehen und durch ein Gleichheitszeichen (=) getrennt sind:

MerchantID=Test


Alle Parameter werden in einer Zeichenkette aneinandergereiht und durch das Zeichen & getrennt:

Amount=100&Currency=EUR&TransID=12345


Hinweis: Da die Zeichen "=" und "&" als Trennzeichen verwendet werden, können diese Zeichen nicht als Wert übergeben werden. Alle Werte, die Sie ohne Blowfish-Verschlüsselung übergeben, müssen URL-encoded sein.

Eine korrekte Parameter-Zeichenkette für das Paygate enthält grundsätzlich drei Parameter: MerchantID, Len und Data. Die Parameter MerchantID und Len sind unverschlüsselt. Nur der Parameter Data wird Blowfish-verschlüsselt:

MerchantID=Test&Len=67&Data=0A67FE96a65d384350F50FF1


Der Parameter Data enthält die sensiblen Zahlungsdaten wie Betrag und Währung. Die verschlüsselten Bytes sind Hex-codiert und auf zwei Zeichen von links mit einer Null aufgefüllt. Die Verschlüsselung erfolgt über Blowfish ECB und steht Ihnen als Source-Code und Komponente zur Verfügung.

Für die Entschlüsselung ist der Parameter Len sehr wichtig, der die Länge der unverschlüsselten(!) Zeichenkette im Parameter Data enthält. Da bei der Verschlüsselung mit Blowfish die zu verschlüsselnde Datenmenge auf ein Vielfaches von 8 vergrößert wird, muss bei der Entschlüsselung die korrekte Länge der Zeichenkette bekannt sein. Andernfalls tauchen am Ende der Zeichenkette zufällige Zeichen auf.

Die Übergabe der Parameter erfolgt per HTTPS POST oder HTTPS GET. Die empfohlene Übertragungsmethode ist HTTPS POST, weil die Parameterzeichenkette bei GET an die URL angehängt wird, die je nach Browser auf 2048 Bytes begrenzt ist.

Hinweis: Bitte beachten Sie, dass die maximale Länge einer Zahlungsanfrage auf 5120 Zeichen begrenzt ist. Wenn Sie längere Zeichenketten benötigen, melden Sie sich bitte beim Computop Support.

Die folgenden Listings zeigen die Entwicklung eines Zahlungsaufrufs. Das erste Listing ist die unverschlüsselte Parameterzeichenkette:


Hinweis: Bitte beachten Sie, dass jedem Parameter ein Wert zugewiesen wird. Leere Parameter dürfen nicht übergeben werden, da andernfalls die Zahlung scheitern kann.

Diese Zeichenkette wird verschlüsselt und als Parameter Data übergeben, so dass der HTTPS GET Aufruf der Hosted Payment Page so aussieht:


Hinweis: Bitte beachten Sie, dass Parameter wie Language oder URLBack unverschlüsselt übergeben werden. Eine Tabelle mit allen möglichen unverschlüsselten Parametern finden Sie ebenfalls in diesem Dokument.


Paygate-Schnittstelle

Multiexcerpt include
SpaceWithExcerptDOCCT
MultiExcerptNameDefinition
PageWithExcerptDefinition DE


Parameter der Hosted Payment Page

Diese Parameter sind für alle Zahlungsarten Pflicht und müssen Blowfisch-verschlüsselt im Parameter Data an die Hosted Payment Page gesendet werden.

Hinweis: Alle weiteren, zahlungsartspezifischen Parameter entnehmen Sie bitte dem Handbuch der jeweiligen Zahlungsart.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter

Format

CND

Beschreibung

MerchantID

ans..30

M

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

TransID

ans..64

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

ns..30

O

eindeutige Referenznummer

Amount

n..10

M

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent).

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a3

M

Währung, drei Zeichen DIN / ISO 4217

OrderDesc

ans..384

M

Beschreibung der gekauften Waren, Einzelpreise etc.

Bitte beachten Sie: Die ersten 27 Zeichen erscheinen auf dem Kontoauszug des Kunden. In Computop Analytics können Sie die kompletten Daten einsehen.

MAC

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus

UserData

ans..1024

O

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop

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.

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.

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.

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.

Parameter für Hosted Payment Page


Folgende Parameter sind optional und können unverschlüsselt an die Hosted Payment Page übergeben werden:

Parameter

Format

CND

Beschreibung

Template

ans..20

O

Name der XSLT-Datei mit Ihrem individuellen Layout für die Hosted Payment Page.

Wenn Sie keinen Wert übergeben wird das responsive Computop-Template der Hosted Payment Page angezeigt.

CCTemplate

ans..20

O

Name der XSLT-Datei mit Ihrem individuellen Layout für das Kreditkartenformular. Dies greift nur, wenn der Kunde eine Kreditkartenmarke auswählt und auf die Schaltfläche „Weiter“ klickt.

Wenn Sie keinen Wert übergeben, wird das responsive Computop-Kreditkartenformular-Template angezeigt.

SDDTemplate

ans..20

O

Name der XSLT-Datei mit Ihrem individuellen Layout für das Lastschriftenformular. Dies greift nur, wenn der Kunde Lastschrift als Zahlungsart auswählt und auf die Schaltfläche „Weiter“ klickt.

Wenn Sie keinen Wert übergeben, wird das responsive Computop-Lastschriftenformular-Template angezeigt.

Language

a2 (enum)

O

Sprachcode: <de> deutsch, <al> albanisch, <at> österreichisch, <cz/cs> tsche-chisch, <dk> dänisch, <en> englisch, <fi> finnisch, <fr> französisch, <gr> grie-chisch, <hu> ungarisch, <it> italienisch, <jp> japanisch, <nl> holländisch, <no> norwegisch, <pl> polnisch, <pt> portugiesisch, <ro> rumänisch, <ru> russisch, <es> spanisch, <se> schwedisch, <sk> slowakisch, <sl> slowenisch, <tr> tür-kisch, <zh> Simplified Chinese

Ohne Angabe ist die Sprache Deutsch.

URLBack

ans..256

O

URL für die Schaltfläche „Zurück“. Wenn Sie diesen Parameter nicht übergeben, wird die Schaltfläche auch nicht angezeigt. Wenn Sie den Parameter übergeben und der Kunde wählt als Zahlungsart Kreditkarte oder Lastschrift aus, wird dieser Parameter auch auf dem Kreditkarten- oder Lastschriftenformular für die Schaltfläche „Zurück“ verwendet.

PayTypes

ans..256

O

Mit diesem Parameter können Sie die anzuzeigenden Zahlungsarten übersteuern, d.h. sie können in diesem Parameter Pipe-getrennt entscheiden, welche der zur Verfügung stehenden Zahlungsarten angezeigt werden.

De möglichen Werte entnehmen Sie aus der Spalte PayType in der obigen Tabelle der Zahlungsarten.

Beispiel: …&PayTypes=CC|EDD|Alipay

Optionale Parameter für Hosted Payment Page



Corporate PaymentPage: XSLT-Layout für Formulare

Sie können mit dem Parameter Template ein individuelles Layout für das Formular der Hosted Payment Page nutzen, das 100%ig zu Ihrem Shop-Layout passt. Zu diesem Zweck entwirft Ihr Grafiker ein HTML-Template im Shop-Design auf Basis der XSLT-Technologie (Extensible Stylesheet Language Transformation). Der Computop Support kopiert dieses XSLT-Template auf unseren Paygate-Server. Wenn Sie den Namen Ihrer XSLT-Datei im Parameter Template übergeben, erscheint das Paygate-Formular in Ihrem Layout.

Die XSLT-Templates für das Formular der Hosted Payment Page haben gleich mehrere Vorteile:

  1. Sie können die aufwendige PCI-Sicherheitszertifizierung umgehen
  2. Die Hosted Payment Page ist responsiv, d.h. sie funktioniert auf Smartphones, Tablets oder auf dem Laptop

Allgemeine Informationen zu XSLT finden Sie unter www.w3.org.


Für die Nutzung der Corporate Paypage mit XSLT gelten die nachfolgenden Konventionen:

Dateinamen

Eine von Ihnen gestaltete XSL-Datei definiert Ihr individuelles Layout. Die zugehörige XML-Datei enthält die Texte, die auf dem Formular angezeigt werden sollen. So lässt sich problemlos eine Mehrsprachigkeit realisieren. In den Bezeichnungen der Dateien verwenden Sie stets Ihre MerchantID.

XSL-Template:             MerchantID_PaymentPage.xsl
XML-Textdatei:            MerchantID_PaymentPage.xml
Unterordner für Bilder, CSS- und JS-Dateien: Templates/imagesMerchantID_PaymentPage

Um keine Sicherheitshinweise zu erhalten, stellen Sie bitte bei externen Bildquellen sicher, dass diese über SSL aufgerufen werden.

Zum Aufruf des individuellen Layouts verwenden Sie den Parameter „Template“ mit Ihrer MerchantID und hängen ihn unverschlüsselt an den Aufruf des Formulars der Hosted Payment Page an, zum Beispiel: https://www.computop-paygate.com/paymentPage.aspx?MerchantID=IhreMID&Len=123&Data=AGSDJ…ASDF&template=IhreMerchantID

Hidden Fields

Folgende Hidden Fields müssen implementiert werden, damit die Werte beim Abschicken des Formulars weitergereicht werden können:

MerchantID:               „MerchantID“
Request-Länge:          „Len“
Request-Daten:          „Data“
Template:                   „Template“
Sprache:                     „Language“
Zurück-Button-URL:   „URLBack“
Zahlungsart:               „PaymentMethod“
Kreditkartenmarke:     „CreditCardBrand“

Sprachauswahl

Die Sprachauswahl auf dem Formular der Hosted Payment Page erfolgt automatisch anhand des Parameters Language. Die anderen Sprachbereiche werden herausgefiltert. Wenn Sie z.B. mit JavaScript auf das Feld eines anderen Sprachbereichs zugreifen wollen, ist das über den folgenden Pfad möglich: paygate/language/@name.

XML-Struktur

Mit dem Parameter „Language“ wird gesteuert, welcher Abschnitt der XML-Textdatei ausgelesen wird. Standardmäßig wird immer deutsch „de“ verwendet.

Die XML-Datei sollte folgendes Grundgerüst haben:

<?xml version="1.0" encoding="utf-16"?>

       </languages>

             <language name="de">

                    <title>Zahlung</title>

                    ...

             </language>

             <language name="en">

                    <title<Payment</title>

                    ...

             </language>

       </languages>


Die Codierung ist auch „UTF-8“ möglich.

Mit <xsl:variable name=““ select=“paygate/language/@name“/> können Sie direkt von der XSL-Datei einen XML-Sprachenabschnitt ansprechen.

Zum Überblick, welche Parameter zusätzlich von der Hosted Payment Page gerendert werden, sehen Sie sich bitte folgende Struktur an (XSL-Datei wird gegen folgenden XML-String gerendert):

strXML = "<?xml version='1.0' encoding='windows-1252'?>" & _

<paygate>

       <merchantID>...</merchantID>

       <len>257</len>

       <data>E98D4...F7065</data>

       <template>

       <urlBack><![CDATA[http://www.google.de]]></urlBack>

       <paymentMethods>

             <VISA type="CC" displayName="Visa"/>

             <MasterCard type="CC" displayName="MasterCard"/>

             <AMEX type="CC" displayName="American Express"/>

             <DINERS type="CC" displayName="Diners Club International"/>

             <Discover type="CC" displayName="Discover"/>

             <JCB type="CC" displayName="JCB"/>

             <EDD lowercase="edd">

             <PayPal lowercase=="paypal">

             <iDEAL lowercase=="ideal">

       </paymentMethods>

       <language name="de">

             <title>Zahlung</title>

             ...

       </language>

</paygate>


Auf jeden einzelnen Wert dieser XML-Struktur, welche im Backend aus der XML-Sprachdatei und zusätzlichen Werten gerendert wird, können Sie in Ihrer XSL-Datei zugreifen.

JavaScript

Sie können individuelle JavaScript-Methoden entweder direkt im HEAD-Bereich Ihrer XSL-Datei oder in der main.js-Datei welche Sie in Ihrem Images-Ordner unter Templates/imagesMerchantID_PaymentPage/js finden.

Hinweis: Bitte verwenden Sie keine externen Links auf Ihr JavaScript!