Diagramm zum Prozessablauf
Multiexcerpt include |
---|
PayPal-Schaltfläche
Für die Integration der Zahlungs-Schaltfläche von PayPal in den Shop nutzen Sie den Code für die Server-Integration, den Sie in der Online-Dokumentation von PayPal unter https://developer.paypal.com/demo/checkout/#/pattern/server vorfinden.
Info |
---|
Bitte ersetzen Sie |
Code Block |
---|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8"/>
</head>
<body>
<!-- Set up a container element for the button -->
<div id="paypal-button-container"></div>
<!-- Include the PayPal JavaScript SDK, Live Client ID will be provided by Paypal -->
<script type="text/javascript" src="https://www.paypal.com/sdk/js?client-id=test¤cy=EUR&disable-funding=giropay,sofort,sepa,card&intent=authorize"></script>
<!-- Initialize and show PayPal button -->
<script type="text/javascript">
let mid = "YOUR MERCHANTID";
let len = "LEN OF UNENCRYPTED BLOWFISH STRING";
let data = "BLOWFISH ENCRYPTED STRING"
if (len != '' && data != '') {
// Set the request parameter MerchantID, Len and Data
const params = new URLSearchParams({
MerchantID: mid,
Len: len,
Data: data
});
// Render the PayPal button into #paypal-button-container
paypal.Buttons({
// Call your server to set up the transaction
createOrder: function(data, actions) {
return fetch('https://www.computop-paygate.com/ExternalServices/paypalorders.aspx', {
method: 'POST',
body: params
}).then(function (res) {
return res.text();
}).then(function(orderData) {
var json = stringToObj(orderData);
return json.orderid;
});
},
// Call cbPayPal.aspx for continue sequence
onApprove: function (data, actions) {
var rd = "MerchantId=" + mid + "&PayId=" + payid + "&OrderId=" + data.orderid;
window.location = "https://www.computop-paygate.com/cbPayPal.aspx?rd=" + window.btoa(rd);
}
}).render('#paypal-button-container');
}
function stringToObj (string) {
var newobj = {};
string.split('&').forEach(function (value) {
var keypair = value.split('=');
newobj[keypair[0]] = keypair[1];
});
return newobj;
}
</script>
</body>
</html> |
Paygate-Schnittstelle
Multiexcerpt include | ||||||
---|---|---|---|---|---|---|
|
|
PayPal Prozessablauf
Konfiguration für PayPal
Damit Sie als Online-Anbieter PayPal-Transaktionen über das
abwickeln können, benötigen Sie ein Geschäftskonto bei PayPal. Sie müssen dem Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Platform-Name PageWithExcerpt Wording
auch API-Berechtigungen erteilen, um die Nutzung der PayPal-Schnittstelle über das Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Partner-Name PageWithExcerpt Wording
zu ermöglichen. Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Platform-Name PageWithExcerpt Wording
PayPal-Geschäftskonto anlegen und konfigurieren
1 Rufen Sie die URL https://developer.paypal.com auf und:
- erstellen ein neues PayPal-Geschäftskonto oder
- melden sich bei Ihrem bestehendem PayPal-Konto an und aktualisieren es auf ein PayPal-Geschäftskonto oder
- melden sich bei Ihrem bestehenden PayPal-Geschäftskonto an.
Erstellen und konfigurieren Sie eine REST-API-App und erhalten die REST-API-Zugangsdaten
1. Gehen Sie zu https://developer.paypal.com/developer/applications
2. Melden Sie sich mit Ihrem PayPal-Geschäftskonto beim Dashboard an und gehen Sie zu “My Apps & Credentials”
3. Erzeugen Sie eine REST-API-App per Klick auf die Schaltfläche “Create App”.
4. Geben Sie einen App Name ein und klicken auf die Schaltfläche “Create App”.
5. Die Webseite zeigt “Sandbox account”, “Client ID” und “Secret” für diese App.
6. Gehen Sie im Abschnitt SANDBOX zu “Accounts”.
7. Suchen Sie das Sandbox-Konto für die neu erstellte App (siehe Schritt 5), klicken dann auf die Schaltfläche “…” und wählen “View/edit account”.
8. Die Seite zeigt “Email ID” und “System Generated Password”, die später für die Anmeldung bei sandbox.paypal.com verwendet werden.
Dem Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Platform-Name PageWithExcerpt Wording
API-Berechtigungen erteilen
SpaceWithExcerpt | DE |
---|---|
MultiExcerptName | Platform-Name |
PageWithExcerpt | Wording |
1. Gehen Sie zu https://www.paypal.com/US/cgi-bin/webscr?cmd=_profile-api-grant-authorization und geben arnoldt_api1.computop.de als Third-Party Permission Username ein und klicken auf die Schaltfläche Lookup.
2. Erteilen Sie die folgenden Berechtigungen und klicken auf die Schaltfläche “Add”.
3. Nach dem Hinzufügen der Berechtigungen erscheint die folgende Seite mit einer Zusammenfassung der erteilten Berechtigungen.
Dem Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Platform-Name PageWithExcerpt Wording
auf der Sandbox API-Berechtigungen erteilen
SpaceWithExcerpt | DE |
---|---|
MultiExcerptName | Platform-Name |
PageWithExcerpt | Wording |
1. Gehen Sie zu https://sandbox.paypal.com
2. Melden Sie sich mit “Email ID” und “System Generated Password” vom Entwicklerportal an (siehe Schritt 8 oben).
3. Die Seite zeigt Ihren Testshop.
4. Unter Ihrem Konto wählen Sie in der rechten oberen Ecke “Kontoeinstellungen” und dann “Website-Zahlungslösungen”.
5. Klicken Sie auf “Bearbeiten” vor “API-Zugriff”.
6. Klicken Sie auf “API-Genehmigung erteilen”.
7. Geben Sie test_paypal_api_api1.computop.com ein und klicken auf die Schaltfläche “Nachschlagen”. Erteilen Sie auf der Seite folgende Berechtigungen und klicken auf die Schaltfläche “Hinzufügen”.
8. Nach dem Hinzufügen der Berechtigungen erscheint die folgende Seite mit einer Zusammenfassung der erteilten Berechtigungen.
Zahlungseinstellungen in der Sandbox festlegen
1. Gehen Sie zu https://sandbox.paypal.com und melden sich mittels “Email ID” und “System Generated Password” vom Entwicklerportal an (siehe Schritte 1-3 oben).
2. Unter Ihrem Konto wählen Sie in der rechten oberen Ecke “Kontoeinstellungen” und dann “Zahlungseinstellungen”.
3. Klicken Sie auf “Bearbeiten” vor “Zahlungen blockieren”. Auf der Seite wählen Sie folgende Voreinstellungen.
4. Alle Änderungen auf der Seite werden “on fly” gespeichert, zum Speichern der Änderungen ist kein Klick auf eine Schaltfläche erforderlich.
PayPal Smart Button
Einrichtung der PayPal-Schaltfläche
Auf der Client-Seite erfolgt die PayPal-Implementierung über das PayPal JavaScript SDK.
Je nach Ihrer Einrichtung können Sie das folgende Skript verwenden oder mit Hilfe der offiziellen PayPal JavaScript SDK-Dokumentation https://developer.paypal.com/sdk/js/ ein eigenes erstellen.
Info |
---|
Während Sie in der Sandbox testen, können Sie die |
Multiexcerpt include | ||||||
---|---|---|---|---|---|---|
|
Aktivierung der PayPal-Schaltfläche Später Bezahlen
Der obige Codeabschnitt enthält die folgende Zeile. In dieser Zeile können Sie festlegen, welche Finanzierungsquellen im Webshop zugelassen werden.
<script type="text/javascript" src="https://www.paypal.com/sdk/js?client-id=sb¤cy=EUR&disable-funding=giropay,sofort,sepa,card&intent=capture"></script>
Die Zeile entsprach der folgenden Schaltfläche. Standardmäßig (unter Verwendung der obigen Zeile) ist nur die PayPal-Schaltfläche verfügbar.
Wenn zusätzlich der zur standardmäßigen PayPal-Schaltfläche die Schaltfläche PayPal Später Bezahlen benötigt wird, kann die Schaltfläche durch den Parameter enable-funding wie folgt aktiviert werden.
<script type="text/javascript" src="https://www.paypal.com/sdk/js?client-id=sb¤cy=EUR&disable-funding=giropay,sofort,sepa,card&enable-funding=paylater"></script>
Im Ergebnis erscheinen folgende zwei Schaltflächen.
Die komplette List der Werte für disable-funding und enable-funding finden Sie unter nachstehendem Link.
https://developer.paypal.com/docs/regional/th/checkout/reference/customize-sdk/#components
Parameter intent
Der obige Codeabschnitt enthält die folgende Zeile.
<script type="text/javascript" src="https://www.paypal.com/sdk/js?client-id=sb¤cy=EUR&disable-funding=giropay,sofort,sepa,card&intent=capture"></script>
Das
bietet 3 mögliche Optionen für eine Zahlung. Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Platform-Kurz PageWithExcerpt EN:Wording
- SALE (wenn das
automatisch die Buchung für eine Zahlung sendet; das ist das Standardszenario, das den Anforderungen der meisten Händler entspricht)Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Platform-Kurz PageWithExcerpt EN:Wording - AUTHORIZE (wenn die Buchung später vom Händler als separater API-Aufruf gesendet werden soll)
- ORDER (wenn Autorisierung und Buchung später vom Händler als separate API-Aufrufe gesendet werden sollen)
Der Parameter intent in der obigen Zeile muss mit diesen Optionen synchron sein.
Wenn die Option SALE verwendet wird, muss der Parameter intent wie nachstehend auf "capture" gesetzt werden.
<script type="text/javascript" src="https://www.paypal.com/sdk/js?client-id=sb¤cy=EUR&disable-funding=giropay,sofort,sepa,card&intent=capture"></script>
Wenn die Option AUTHORIZE oder ORDER verwendet wird, muss der Parameter intent wie nachstehend auf "authorize" gesetzt werden.
<script type="text/javascript" src="https://www.paypal.com/sdk/js?client-id=sb¤cy=EUR&disable-funding=giropay,sofort,sepa,card&intent=authorize"></script>
Es ist wichtig, den richtigen Wert für den Parameter intent festzulegen, weil sonst ein Fehler auftritt.
Stil der PayPal-Schaltfläche
Der obige Codeabschnitt für die PayPal-Schaltfläche hat keine stilbezogenen Parameter. Dieser Codeabschnitt geht wie folgt vom standardmäßigen PayPal-Stil für die Schaltfläche aus.
PayPal erlaubt es, verschiedene Stile für die PayPal-Schaltfläche zu definieren, indem Sie die Parameter shape, color, layout und label verwenden. Eine vollständige Liste der stilbezogenen Parameter finden Sie unter dem folgenden Link.
https://developer.paypal.com/docs/checkout/advanced/style-guide/
Multiexcerpt include | ||||||
---|---|---|---|---|---|---|
|
Multiexcerpt include | ||||||
---|---|---|---|---|---|---|
|
Aufruf der Schnittstelle
Um eine PayPal-Zahlung im
-Formular abzuwickeln, nutzen Sie folgende URL und Parameter: Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Platform-Kurz PageWithExcerpt Wording
|
Mit dieser URL unterstützt das
zwei verschiedene PayPal-Methoden: Einerseits können Sie PayPal ganz normal als zusätzliche Zahlungsmethode zum Abschluss einer Bestellung anbieten. Zum anderen können Sie PayPal Express Checkout nutzen, damit der Kunde vom Warenkorb direkt zu PayPal gelangt und dort seine Liefer- und Rechnungsadresse auswählt. Dem Kunden erspart das die erneute Eingabe von Adressdaten und als Händler genießen Sie den PayPal Verkäuferschutz. Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Platform-Kurz PageWithExcerpt Wording
Das
unterstützt auch für PayPal Express Checkout das Auseinanderfallen von Autorisierung und Buchung. Sie können über das Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Platform-Kurz PageWithExcerpt Wording
über Parameter steuern, ob der Betrag auf dem PayPal-Account des Kunden geblockt oder gleich gebucht werden soll. Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Platform-Kurz PageWithExcerpt Wording
Hinweis: Damit Sie vom PayPal Verkäuferschutz profitieren, muss eine der folgenden Bedingungen erfüllt sein. Entweder der Kunde nutzt PayPal Express Checkout und wählt eine bei PayPal selbst hinterlegte Lieferadresse aus, die das
an Ihren Shop übergibt. Oder Ihr Shop übergibt die bereits bekannte Lieferadresse an PayPal. Der Verkäuferschutz gilt nur, wenn die Ware an diese angegebene Adresse geliefert wurde. Zwischen der Autorisierung des Betrags im PayPal-Konto des Kunden und der Buchung dürfen nicht mehr als 3 Tage liegen, wenn Sie vom Verkäuferschutz profitieren möchten. Das Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Platform-Kurz PageWithExcerpt Wording
unterstützt deshalb mehrere Alternativen zur Abwicklung von PayPal-Zahlungen: für eine Beratung zur Implementierung von PayPal stehen wir Ihnen gerne zur Verfügung. Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Platform-Kurz PageWithExcerpt Wording
Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Request_Intro PageWithExcerpt Reuse API
Table Filter | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
|
Parameter für PayPal-Zahlungen
Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Response_IntroURL PageWithExcerpt Reuse API
Table Filter | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
|
Ergebnis-Parameter für URLSuccess, URLFailure und URLNotify bei PayPal
Hinweis: Die Adress-Parameter werden immer an den Shop übergeben, sind aber leer, wenn keine Adressdaten ausgetauscht wurden.
Aufruf der Schnittstelle für separate Autorisierung
Für eine PayPal Zahlung kann im Prozessablauf die ORDER von der anschließenden Autorisierung und nachfolgenden Schritten getrennt werden. Eine separate Autorisierung ist nur nach erfolgten Order (TxType=Order) möglich.
Für eine separate Autorisierung bei PayPal rufen Sie folgende URL auf:
|
Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Request_Intro PageWithExcerpt Reuse API
Table Filter | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
|
Parameter für PayPal-Autorisierung
Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Response_Intro PageWithExcerpt Reuse API
Table Filter | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
|
Ergebnis-Parameter bei PayPal-Autorisierung
Aufruf der Schnittstelle für eine Buchung
Um eine Buchung (Capture) für PayPal über eine Server-zu-Server-Verbindung auszuführen, ver-wenden Sie bitte folgende URL:
|
Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Request_Intro PageWithExcerpt Reuse API
Table Filter | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
|
Parameter für PayPal-Buchungen
Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Response_Intro PageWithExcerpt Reuse API
Table Filter | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
|
Ergebnis-Parameter für PayPal-Buchungen
Aufruf der Schnittstelle für eine Gutschrift mit Referenz
Um eine Gutschrift (Credit) mit Referenztransaktion für PayPal auszuführen, verwenden Sie bitte folgende URL:
|
Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Request_Intro PageWithExcerpt Reuse API
Table Filter | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
|
Parameter für PayPal-Gutschriften mit Bezugstransaktion
Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Response_Intro PageWithExcerpt Reuse API
Table Filter | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
|
Ergebnis-Parameter für PayPal-Gutschriften mit Bezugstransaktion
Aufruf der Schnittstelle für nicht referenzierte Gutschriften
Um eine Gutschrift ohne Bezugstransaktion für PayPal abzuwickeln, verwenden Sie bitte folgende URL:
|
Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Request_Intro PageWithExcerpt Reuse API
Table Filter | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
|
Parameter für PayPal-Gutschriften ohne Bezugstransaktion
Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Response_Intro PageWithExcerpt Reuse API
Table Filter | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
|
Ergebnis-Parameter für PayPal-Gutschriften ohne Bezugstransaktion
Aufruf der Schnittstelle für Stornierungen
Um eine Transaktion bei PayPal zu stornieren, verwenden Sie bitte folgende URL:
|
Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Request_Intro PageWithExcerpt Reuse API
Table Filter | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
|
Parameter für PayPal-Stornierungen
Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Response_Intro PageWithExcerpt Reuse API
Table Filter | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
|
Ergebnis-Parameter für PayPal-Stornierungen
Batch-Nutzung der Schnittstelle
Grundsätzliche Informationen zur Arbeit mit Batch-Dateien sowie zu deren Aufbau erfahren Sie im separaten Handbuch zum Batchmanager. Im Batch-Verfahren sind nicht alle Funktionen verfügbar, die für die Online-Schnittstelle verfügbar sind.
Dieses Kapitel beschreibt die Parameter, die Sie im Datensatz (Record) für die Ausführung einer PayPal-Zahlung übergeben müssen und welche Informationen Sie der Antwort-Datei über den Status des Zahlungsvorgangs entnehmen können.
Bei den Batch-Aufrufen ist die verwendete Batch-Version zu unterscheiden, wovon die optionalen Parameter abhängen. Alle mit „2.“ beginnen Versionsbezeichnungen betreffen Aufrufe für einen Konzern. Das bedeutet, innerhalb einer Batch-Datei mit einer bestimmten MerchantID können auch Transaktionen anderer Händler mit einer abweichenden Sub-MID übertragen werden.
Folgende Tabelle gibt eine Übersicht der pro Aktion jeweils möglichen Batch-Versionen und ihrer Besonderheiten:
Table Filter | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
|
Beschreibung der möglichen Batch-Versionen
Der Aufbau für eine PayPal-Zahlung in einer einzureichenden Batch-Datei sieht folgendermaßen aus:
Multiexcerpt include | ||||||
---|---|---|---|---|---|---|
|
Beispiel für Master-MID-Funktion:
Multiexcerpt include | ||||||
---|---|---|---|---|---|---|
|
Hinweis: Bei Version 1.4 ist es auch möglich, bei einer Capture-Aktion den CompleteType zusätzlich mit zu übergeben:
PAYPAL,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>(,<CompleteType>,<TID>)
Die folgende Tabelle beschreibt die einzelnen Felder und Werte, die im Datensatz (Record) innerhalb der Batch-Datei verwendet werden:
Table Filter | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
|
Aufruf der Schnittstelle
Um eine PayPal-Zahlung im Paygate-Formular abzuwickeln, nutzen Sie folgende URL und Parameter:
https://www.computop-paygate.com/ExternalServices/paypalorders.aspx
Mit dieser URL unterstützt das Paygate zwei verschiedene PayPal-Methoden: Einerseits können Sie PayPal ganz normal als zusätzliche Zahlungsmethode zum Abschluss einer Bestellung anbieten. Zum anderen können Sie PayPal Express Checkout nutzen, damit der Kunde vom Warenkorb direkt zu PayPal gelangt und dort seine Liefer- und Rechnungsadresse auswählt. Dem Kunden erspart das die erneute Eingabe von Adressdaten und als Händler genießen Sie den PayPal Verkäuferschutz.
Das Paygate unterstützt auch für PayPal Express Checkout das Auseinanderfallen von Autorisierung und Buchung. Sie können über das Paygate über Parameter steuern, ob der Betrag auf dem PayPal-Account des Kunden geblockt oder gleich gebucht werden soll.
Hinweis: Damit Sie vom PayPal Verkäuferschutz profitieren, muss eine der folgenden Bedingungen erfüllt sein. Entweder der Kunde nutzt PayPal Express Checkout und wählt eine bei PayPal selbst hinterlegte Lieferadresse aus, die das Paygate an Ihren Shop übergibt. Oder Ihr Shop übergibt die bereits bekannte Lieferadresse an PayPal. Der Verkäuferschutz gilt nur, wenn die Ware an diese angegebene Adresse geliefert wurde. Zwischen der Autorisierung des Betrags im PayPal-Konto des Kunden und der Buchung dürfen nicht mehr als 3 Tage liegen, wenn Sie vom Verkäuferschutz profitieren möchten. Das Paygate unterstützt deshalb mehrere Alternativen zur Abwicklung von PayPal-Zahlungen: für eine Beratung zur Implementierung von PayPal stehen wir Ihnen gerne zur Verfügung.
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:
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
ans..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.
Wenn OrderDesc(n) verwendet wird, muss gelten: Amount=ItemTotal+TaxTotal+ShAmount
Currency
a3
M
Währungskürzel, drei Zeichen DIN / ISO 4217
Capture
a..6
O
Auto oder Manual: bestimmt, ob der angefragte Betrag sofort oder erst später abgebucht wird.
Wichtiger Hinweis: Bitte kontaktieren Sie den Computop Support für Manual, um die unterschiedlichen Einsatzmöglichkeiten abzuklären.
TxType
ans..5
C
Pflicht bei Capture=Manual: Transaktionstyp mit den möglichen Werten Order oder Auth
PayPalMethod
enum
O
Wert "shortcut" wählt den geänderten Transaktionsablauf, bei dem der Kunde für die Zahlungsbestätigung in den Shop zurückgeleitet wird und z.B. bei einem Ratenkauf die Ratenkaufdaten angezeigt werden, die er dann bestätigen muss.
Zum Abschließen der Bestellung muss anschließend die Schnittstelle paypalcomplete.aspx aufgerufen werden.
RTF
ans1
O
Für wiederkehrende Zahlungen (Abos):
I = Initialzahlung eines neuen Abos,
R = Wiederkehrende Zahlung (Recurring)
Hier nur RTF=I zulässig, weitere Abo-Zahlungen werden über die separate Schnittstelle paypalAbo.aspx ausgeführt.
OrderDesc
ans..127
M
Beschreibung der gekauften Waren, Einzelpreise etc.
OrderDesc(n)
ans..2048
O
Warenkorb des Kunden in der Form:
OrderDesc(n)=Name,Amount,Number,Quantity,Description,Tax
OrderDesc2 bis max. OrderDesc99 zulässig
Zur korrekten Ausführung der Darstellungsfunktion müssen alle OrderDesc(n) Amounts mit dem übergebenen Paygate-Parameter Amount übereinstimmen.
TaxTotal
n..12
C
Pflicht, wenn bei OrderDesc(n) die Beschreibung +Tax angegeben wird. Gesamtbetrag der Steuern aller einzelnen Artikel in der kleinsten Währungseinheit (z.B. EUR Cent) = Summe(Tax*Number)
ItemTotal
n..12
C
Pflicht, wenn bei OrderDesc(n) die Beschreibung +Tax angegeben wird. Gesamtbetrag der einzelnen Artikel in der kleinsten Währungseinheit (z.B. EUR Cent) = Summe(Amount*Number)
ShAmount
n..12
O
Versandkosten in der kleinsten Währungseinheit (z.B. EUR Cent). Kann nur in Verbindung mit den Parametern ItemTotal und TaxTotal verwendet werden.
MAC
an64
M
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus
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.
UserData
ans..1024
O
Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop
ReqID
ans..32
O
Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion mit derselben ReqID erneut eingereicht wird, führt das Paygate keine Zahlung aus sondern gibt nur den Status der ursprünglichen Transaktion zurück. Bitte beachten Sie, dass das Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.
Account
ans..128
O
Zur Steuerung mehrerer PayPal-Accounts, Händler-Account: ID oder E-Mail-Adresse, für die die Anfrage an PayPal gesendet werden soll
LandingPage
ans
O
Steuert, wie die PayPal-Seite angezeigt wird. Mögliche Werte „Login“ oder „Billing“
Language
an5
O
Sprachcode im Format an2 oder an5:
- an2: AU, DE, FR, IT, GB, ES, US; Standard DE
- an5: Bitte verwenden Sie den BCP-47-Code gemäß PayPal-Dokumentation: https://developer.paypal.com/docs/api/reference/locale-codes/
FirstName
ans..30
OC
(Pflicht für USA und Kanada): Entweder nur der Vorname oder Vor- und Nachname, falls ein Firmenname als Lieferadresse genutzt wird.
LastName
ans..30
OC
(Pflicht für USA und Kanada): Nachname oder Firmenbezeichnung der Lieferadresse
AddrStreet
ans..100
OC
(Pflicht für USA und Kanada): Straßenname der Lieferadresse
AddrStreet2
ans..100
O
Straßenname der Lieferadresse
AddrCity
ans..40
OC
(Pflicht für USA und Kanada): Ortsname der Lieferadresse
AddrState
ans..40
OC
(Pflicht für USA und Kanada): Bundesland (Bundesstaat) der Lieferadresse. Die in AddrCity übergebene Stadt muss im angegebenen Bundesstaat liegen, sonst lehnt PayPal die Zahlung ab. Mögliche Werte entnehmen Sie bitte der PayPal-API-Reference Dokumentation.
AddrZip
ans..20
OC
(Pflicht für USA und Kanada): Postleitzahl der Lieferadresse
AddrCountryCode
an2
O
Ländercode des Lieferlandes
Phone
n..20
O
Telefonnummer
NoShipping
n1
O
Übergabe NoShipping=1 verhindert die Anzeige der bei PayPal hinterlegten Lieferadresse
Parameter für PayPal-Zahlungen
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:
Parameter
Format
CND
Beschreibung
MID
ans..30
M
HändlerID, die von Computop vergeben wird.
PayID
an32
M
Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien
XID
an32
M
Vom Paygate vergebene ID für alle einzelnen Transaktionen (Order, Sale, Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden
TransID
ans..64
M
Transaktionsnummer des Händlers
Status
a..30
M
OK, AUTHORIZE_REQUEST oder Timeout (nur bei Capture=Manual) auf der URLSuccess-Seite oder FAILED auf der URLFailure-Seite.
AUTHORIZE_REQUEST – Wird nur beim Aufrufparameter "TxType=auth" bzw. "PayPalMethod=shortcut" aktiv versendet. Bei Verwendung von TxType=auth oder ohne TxType wird direkt der abschließende Status gemeldet.
Timeout – Alle offenen Zahlungsvorgänge im Status AUTHORIZE_REQUEST werden nach ~ 3h automatisiert geschlossen und als Timeout gemeldet.
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!
Code
n8
M
Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)
MAC
an64
M
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus
RefNr
ans..30
O
Referenznummer des Händlers
UserData
ans..1024
O
Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop
CodeExt
n..10
O
Fehlercode von PayPal, wenn mit Computop Support abgesprochen
Name
ans..32
M
Vorname und Nachname zusammengenommen
FirstName
ans..30
M
Vorname vom Bezahler (PayerInfo, kann vom Account-Namen abweichen)
LastName
ans..30
M
Nachname vom Bezahler (PayerInfo, kann vom Account-Namen abweichen)
ans..100
M
E-Mail-Adresse des Käufers.
AddrStreet
ans..100
O
Straßenname der Lieferadresse
AddrStreet2
ans..100
O
2. Straßenname der Lieferadresse, wenn mit Computop abgestimmt
AddrCity
ans..40
O
Ortsname der Lieferadresse
AddrState
ans..40
O
Bundesland (Bundesstaat) der Lieferadresse
AddrZIP
ans..20
O
Postleitzahl der Lieferadresse
AddrCountryCode
an2
O
Ländercode des Lieferlandes
Phone
n..20
O
Telefonnummer
BillingName
ans..32
O
Vorname und Nachname zusammengenommen
BillingAddrStreet
ans..100
O
Straßenname der bei PayPal hinterlegten Rechnungsadresse
BillingAddrStreet2
ans..100
O
2. Straßenname der bei PayPal hinterlegten Rechnungsadresse, wenn mit Computop abgestimmt
BillingAddrCity
ans..40
O
Ortsname der bei PayPal hinterlegten Rechnungsadresse
BillingAddrState
ans..40
O
Bundesland der bei PayPal hinterlegten Rechnungsadresse
BillingAddrZIP
ans..20
O
Postleitzahl der bei PayPal hinterlegten Rechnungsadresse
BillingAddrCountryCode
an2
O
Ländercode des Lieferlandes
InfoText
ans..255
M
Nachricht an den Händler
PayerID
ans..13
O
(wenn Rückgabe aktiviert ist): Eindeutige Identifikationsnummer des Kundenkontos bei PayPal
GrossAmount
an..9
O
Endgültig berechneter Betrag einschließlich Lieferkosten und Steuern von Ihrem Händlerprofil
FeeAmount
an..9
O
Betrag der für die Transaktion berechneten PayPal-Gebühr
SettleAmount
an..9
O
Ihrem PayPal-Konto nach einer Währungsumrechnung gutgeschriebener Betrag
TaxAmount
an..9
O
Für die Transaktion berechnete Steuer
ExchangeRate
an..17
O
Wechselkurs bei einer Währungsumrechnung. Nur relevant, wenn die Rechnung nicht in der primären Währung ausgestellt ist. Wenn der Käufer in einer anderen als der nicht primären Währung bezahlt, erfolgt die Umrechnung im Händlerkonto.
mc_fee
an..9
C
Nur bei separatem Notify von PayPal: Transaktionsgebühr für die Zahlung. mc_gross minus mc_fee entspricht dem Betrag, der dem Empfängerkonto gutgeschrieben wird. Ist äquivalent zur payment_fee bei Zahlung in US-Dollar. Ein negativer Betrag signalisiert ein Storno oder eine Gutschrift. Beide Zahlungs-Status können für den vollständigen oder teilweisen Betrag der ursprünglichen Transaktionsgebühr sein.
mc_gross
an..9
C
Nur bei separatem Notify von PayPal: Gesamtbetrag der Zahlung des Kunden vor Abzug der Transaktionsgebühr. Ist äquivalent zu payment_gross bei Zahlung in US-Dollar. Ein negativer Betrag signalisiert ein Storno oder eine Gutschrift. Beide Zahlungs-Status können für den vollständigen oder teilweisen Betrag der ursprünglichen Transaktionsgebühr sein.
Ergebnis-Parameter für URLSuccess, URLFailure und URLNotify bei PayPal
Hinweis: Die Adress-Parameter werden immer an den Shop übergeben, sind aber leer, wenn keine Adressdaten ausgetauscht wurden.
Aufruf der Schnittstelle für Methode "shortcut"
Die PayPal-Methode "shortcut" ermöglicht einen geänderten Transaktionsablauf, bei dem der Kunde für die Zahlungsbestätigung in den Shop zurückgeleitet wird und z.B. bei Ratenkauf die Ratenkaufdaten angezeigt werden, die er dann bestätigen muss. Um im nächsten Schritt diese PayPal-Zahlung abzuschließen, nutzen Sie folgende URL und Parameter:
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.
PayID
an32
M
Vom Paygate vergebene ID für die Zahlung. Übergeben Sie hier die PayID aus der Antwort von paypal.aspx im bisherigen Transaktionsablauf erhalten haben.
TransID
ans..64
M
TransaktionsID, die für jede Zahlung eindeutig sein muss
RefNr
ans..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.
Wenn OrderDesc(n) verwendet wird, muss gelten:
Amount=ItemTotal+TaxTotal+ShAmount
Hinweis: Bei Änderung von OrderDesc(n) muss auch der Amount angepasst werden.
Currency
a3
M
Währungskürzel, drei Zeichen DIN / ISO 4217
OrderDesc(n)
ans..2048
O
Warenkorb des Kunden in der Form:
OrderDesc(n)=Name,Amount,Number,Quantity,Description,Tax
OrderDesc2 bis max. OrderDesc99 zulässig
Zur korrekten Ausführung der Darstellungsfunktion müssen alle OrderDesc(n) Amounts mit dem übergebenen Paygate-Parameter Amount übereinstimmen.
Adressinformationen. Durch Übergabe dieser Werte ist auch eine Adress-Änderung möglich.
Hinweis: Wenn FirstName übergeben wird, sollten auch alle anderen Werte übergeben werden. Wenn FirstName nicht übergeben wird, werden andere Adressparameter nicht berücksichtigt.
FirstName
ans..30
C
Pflicht, um Adressangaben zu übermitteln: Entweder nur der Vorname oder Vor- und Nachname, falls ein Firmenname als Lieferadresse genutzt wird.
LastName
ans..30
C
Pflicht, wenn FirstName übergeben wird: Nachname oder Firmenbezeichnung der Lieferadresse
AddrStreet
ans..100
C
Pflicht, wenn FirstName übergeben wird: Straßenname der Lieferadresse
AddrStreet2
ans..100
C
Pflicht, wenn FirstName übergeben wird: Straßenname der Lieferadresse
AddrCity
ans..40
C
Pflicht, wenn FirstName übergeben wird: Ortsname der Lieferadresse
AddrState
ans..40
C
Pflicht, wenn FirstName übergeben wird: Bundesland (Bundesstaat) der Lieferadresse. Die in AddrCity übergebene Stadt muss im angegebenen Bundesstaat liegen, sonst lehnt PayPal die Zahlung ab. Mögliche Werte entnehmen Sie bitte der PayPal-API-Reference Dokumentation.
AddrZip
ans..20
C
Pflicht, wenn FirstName übergeben wird: Postleitzahl der Lieferadresse
AddrCountryCode
an2
C
Pflicht, wenn FirstName übergeben wird: Ländercode des Lieferlandes
Phone
n..20
C
Pflicht, wenn FirstName übergeben wird: Telefonnummer
Parameter für PayPal-Zahlungen mit Methode "shortcut"
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort zurückgibt:
Parameter
Format
CND
Beschreibung
MID
ans..30
M
HändlerID, die von Computop vergeben wird.
PayID
an32
M
Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien
XID
an32
M
Vom Paygate vergebene ID für alle einzelnen Transaktionen (Order, Sale, Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden
TransID
ans..64
M
Transaktionsnummer des Händlers
Status
a..30
M
OK oder FAILED
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!
Code
n8
M
Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)
RefNr
ans..30
O
Referenznummer des Händlers
CodeExt
n..10
O
Fehlercode von PayPal, wenn mit Computop Support abgesprochen
Ergebnis-Parameter bei PayPal mit Methode "shortcut"
Aufruf der Schnittstelle für separate Autorisierung
Für eine PayPal Zahlung kann im Prozessablauf die ORDER von der anschließenden Autorisierung und nachfolgenden Schritten getrennt werden. Eine separate Autorisierung ist nur nach erfolgten Order (TxType=Order) möglich.
Für eine separate Autorisierung bei PayPal rufen Sie folgende URL auf:
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.
PayID
an32
M
vom Paygate vergebene ID für die Zahlung
TransID
ans..64
M
TransaktionsID, die für jede Zahlung eindeutig sein muss
TxType
ans..5
M
Transaktionstyp Auth
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ährungskürzel, drei Zeichen DIN / ISO 4217
FirstName
ans..30
O
Entweder nur der Vorname oder Vor- und Nachname, falls ein Firmenname als Lieferadresse genutzt wird.
LastName
ans..30
O
Nachname oder Firmenbezeichnung der Lieferadresse
AddrStreet
ans..100
O
Straßenname der Lieferadresse
AddrStreet2
ans..100
O
2. Straßenname der Lieferadresse, wenn mit Computop abgestimmt
AddrCity
ans..40
O
Ortsname der Lieferadresse
AddrState
ans..40
O
Bundesland (Bundesstaat) der Lieferadresse. Die in AddrCity übergebene Stadt muss im angegebenen Bundesstaat liegen, sonst lehnt PayPal die Zahlung ab. Mögliche Werte entnehmen Sie bitte der PayPal-API-Reference Dokumentation.
AddrZip
ans..20
O
Postleitzahl der Lieferadresse
AddrCountryCode
an2
O
Ländercode des Lieferlandes
Phone
n..20
O
Telefonnummer
Parameter für PayPal-Autorisierung
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort zurückgibt:
Parameter
Format
CND
Beschreibung
MID
ans..30
M
HändlerID, die von Computop vergeben wird.
PayID
an32
M
Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien
XID
an32
M
Vom Paygate vergebene ID für alle einzelnen Transaktionen (Order, Sale, Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden
TransID
ans..64
M
Transaktionsnummer des Händlers
Status
a..30
M
OK oder FAILED
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!
Code
n8
M
Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)
CodeExt
n..10
O
Fehlercode von PayPal, wenn mit Computop Support abgesprochen
Ergebnis-Parameter bei PayPal-Autorisierung
Aufruf der Schnittstelle für eine Buchung
Um eine Buchung (Capture) für PayPal über eine Server-zu-Server-Verbindung auszuführen, ver-wenden Sie bitte folgende URL:
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:
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.
PayID
an32
M
Vom Paygate vergebene ID für die zu buchende Transaktion
TransID
ans..64
M
Vom Händler initial vergebene ID für den zu buchenden Zahlungsvorgang
MAC
an64
M
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus
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
a..3
M
Währungskürzel, drei Zeichen DIN / ISO 4217
RefNr
ans..30
O
Referenznummer des Händlers: hier kann eine separate Referenznummer wie z.B. Rechnungsnummer übergeben werden
TID
ans..17
O
Eindeutige Transaktionsnummer bei PayPal. Notwendig bei Teilbuchungen auf vorangegangene Autorisierungen.
CompleteType
ans..3
O
Wird <YES> übergeben, wird bei der Buchung die mögliche offene Order von PayPal geschlossen. (Hintergrund: seitens PayPal ist eine 115% Buchung zulässig. Bei Buchung ab 100% sendet das Paygate automatisch einen Aufruf zum Schließen der Zahlung an PayPal.)
Parameter für PayPal-Buchungen
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort zurückgibt:
Parameter
Format
CND
Beschreibung
MID
ans..30
M
HändlerID, die von Computop vergeben wird
PayID
an32
M
Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien
XID
an32
M
Vom Paygate vergebene ID für alle einzelnen Transaktionen (Order, Sale, Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden
TransID
ans..64
M
Transaktionsnummer des Händlers
Status
a..30
M
OK oder FAILED
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!
Code
n8
M
Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)
TID
ans..17
O
Eindeutige Transaktionsnummer bei PayPal. Notwendig bei Teilbuchungen auf vorangegangene Autorisierungen.
CodeExt
n..10
O
Fehlercode von PayPal, wenn mit Computop Support abgesprochen
Ergebnis-Parameter für PayPal-Buchungen
Aufruf der Schnittstelle für eine Gutschrift mit Referenz
Um eine Gutschrift (Credit) mit Referenztransaktion für PayPal auszuführen, verwenden Sie bitte folgende URL:
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:
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.
PayID
an32
M
Vom Paygate vergebene ID für die gutzuschreibende Transaktion
TransID
ans..64
M
Vom Händler initial vergebene ID für den gutzuschreibenden Zahlungsvorgang
MAC
an64
M
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus
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
a..3
M
Währungskürzel, drei Zeichen DIN / ISO 4217
RefNr
ans..30
O
Referenznummer des Händlers: hier kann eine separate Referenznummer wie z.B. Rechnungsnummer übergeben werden
TID
ans..17
O
Eindeutige Transaktionsnummer bei PayPal. Notwendig bei Teilgutschriften auf vorangegangene Teilbuchungen.
Note
ans..768
C
Hinweistext für Empfänger
Subject
ans..255
C
MassPay: Betreff für E-Mail an Empfänger
Parameter für PayPal-Gutschriften mit Bezugstransaktion
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort zurückgibt:
Parameter
Format
CND
Beschreibung
MID
ans..30
M
HändlerID, die von Computop vergeben wird
PayID
an32
M
Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien
XID
an32
M
Vom Paygate vergebene ID für alle einzelnen Transaktionen (Order, Sale, Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden
TransID
ans..64
M
Transaktionsnummer des Händlers
Status
a..30
M
OK oder FAILED
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!
Code
n8
M
Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)
TID
ans..17
O
Eindeutige Transaktionsnummer bei PayPal. Notwendig bei Teilgutschriften auf vorangegangene Teilbuchungen.
CodeExt
n..10
O
Fehlercode von PayPal, wenn mit Computop Support abgesprochen
FeeRefundAmount
n..10
O
Gutgeschriebener Betrag der PayPal-Transaktionsgebühren. Notwendig bei Teilgutschriften auf vorangegangene Teilbuchungen.
GrossRefundAmount
n..10
O
Gutgeschriebener Betrag an den Käufer bei dieser Gutschrift. Notwendig bei Teilgutschriften auf vorangegangene Teilbuchungen.
NetRefundAmount
n..10
O
Von ihrem PayPal-Konto abgezogener Betrag, um diese Gutschrift auszuführen. Notwendig bei Teilgutschriften auf vorangegangene Teilbuchungen.
Ergebnis-Parameter für PayPal-Gutschriften mit Bezugstransaktion
Aufruf der Schnittstelle für nicht referenzierte Gutschriften
Um eine Gutschrift ohne Bezugstransaktion für PayPal abzuwickeln, nutzen Sie folgende URL und Parameter:
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
ans..30
O
Referenznummer des Händlers
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
a..3
M
Währungskürzel, drei Zeichen DIN / ISO 4217
PayerID
ans..13
O
Eindeutige Identifikationsnummer des Kundenkontos bei PayPal
Account
ans..128
O
Zur Steuerung mehrerer PayPal-Accounts, Händler-Account: ID oder E-Mail-Adresse, für die die Anfrage an PayPal gesendet werden soll
Note
ans..768
C
MassPay: Hinweistext für Empfänger
Subject
ans..255
C
MassPay: Betreff für E-Mail an Empfänger
Payer
ans..100
O
MassPay: E-Mail-Adresse des Käufers
Parameter für PayPal-Gutschriften ohne Bezugstransaktion
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort zurückgibt:
Parameter
Format
CND
Beschreibung
MID
ans..30
M
HändlerID, die von Computop vergeben wird
PayID
an32
M
Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien
XID
an32
M
Vom Paygate vergebene ID für alle einzelnen Transaktionen (Order, Sale, Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden
TransID
ans..64
M
Transaktionsnummer des Händlers
Status
a..30
M
OK oder FAILED
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!
Code
n8
M
Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)
CodeExt
n..10
O
Fehlercode von PayPal, wenn mit Computop Support abgesprochen
FeeRefundAmount
n..10
O
Gutgeschriebener Betrag der PayPal-Transaktionsgebühren. Notwendig bei Teilgutschriften auf vorangegangene Teilbuchungen.
GrossRefundAmount
n..10
O
Gutgeschriebener Betrag an den Käufer bei dieser Gutschrift. Notwendig bei Teilgutschriften auf vorangegangene Teilbuchungen.
NetRefundAmount
n..10
O
Von ihrem PayPal-Konto abgezogener Betrag, um diese Gutschrift auszuführen. Notwendig bei Teilgutschriften auf vorangegangene Teilbuchungen.
Ergebnis-Parameter für PayPal-Gutschriften ohne Bezugstransaktion
Aufruf der Schnittstelle für Stornierungen
Um eine Transaktion bei PayPal zu stornieren, nutzen Sie folgende URL und Parameter:
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.
PayID
an32
M
ID des Paygate zur Identifizierung einer Zahlung
TransID
ans..64
M
ID des Händlers zur Identifizierung des zu stornierenden Zahlungsvorgangs
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
a..3
M
Währungskürzel, drei Zeichen DIN / ISO 4217
MAC
an64
M
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus
TID
ans..17
O
Eindeutige Transaktionsnummer bei PayPal. Notwendig bei Teilstornierungen auf vorangegangene Teilautorisierungen.
Parameter für PayPal-Stornierungen
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort zurückgibt:
Parameter
Format
CND
Beschreibung
MID
ans..30
M
HändlerID, die von Computop vergeben wird
PayID
an32
M
Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien
XID
an32
M
Vom Paygate vergebene ID für alle einzelnen Transaktionen (Order, Sale, Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden
TransID
ans..64
M
Transaktionsnummer des Händlers
Status
a..30
M
OK oder FAILED
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!
Code
n8
M
Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)
TID
ans..17
O
Eindeutige Transaktionsnummer bei PayPal. Notwendig bei Teilstornierungen auf vorangegangene Teilautorisierungen.
CodeExt
n..10
O
Fehlercode von PayPal, wenn mit Computop Support abgesprochen
Ergebnis-Parameter für PayPal-Stornierungen
Batch-Nutzung der Schnittstelle
Grundsätzliche Informationen zur Arbeit mit Batch-Dateien sowie zu deren Aufbau erfahren Sie im separaten Handbuch zum Batchmanager. Im Batch-Verfahren sind nicht alle Funktionen verfügbar, die für die Online-Schnittstelle verfügbar sind.
Dieses Kapitel beschreibt die Parameter, die Sie im Datensatz (Record) für die Ausführung einer PayPal-Zahlung übergeben müssen und welche Informationen Sie der Antwort-Datei über den Status des Zahlungsvorgangs entnehmen können.
Bei den Batch-Aufrufen ist die verwendete Batch-Version zu unterscheiden, wovon die optionalen Parameter abhängen. Alle mit „2.“ beginnen Versionsbezeichnungen betreffen Aufrufe für einen Konzern. Das bedeutet, innerhalb einer Batch-Datei mit einer bestimmten MerchantID können auch Transaktionen anderer Händler mit einer abweichenden Sub-MID übertragen werden.
Folgende Tabelle gibt eine Übersicht der pro Aktion jeweils möglichen Batch-Versionen und ihrer Besonderheiten:
Aktion
Version
Beschreibung
Authorize
1.0 / 2.0
Standardversion ohne Rückgabe von Code
1.4 / 2.4
mit TID
Capture
1.0 / 2.0
Standardversion ohne Rückgabe von Code
1.x / 2.x
mit RefNr (gilt für alle Versionen außer 1.0)
1.4 / 2.4
mit TID
Credit
1.0 / 2.0
Standardversion ohne Rückgabe von Code
1.x / 2.x
mit RefNr (gilt für alle Versionen außer 1.0)
1.4 / 2.4
mit TID
CreditEx
1.0 / 2.0
Standardversion ohne Rückgabe von Code
1.x / 2.x
mit RefNr (gilt für alle Versionen außer 1.0)
Reverse
1.0 / 2.0
Standardversion ohne Rückgabe von Code
1.4 / 2.4
mit TID
Abo
1.0 / 2.0
Standardversion ohne Rückgabe von Code
1.x / 2.x
mit RefNr (gilt für alle Versionen außer 1.0)
Beschreibung der möglichen Batch-Versionen
Der Aufbau für eine PayPal-Zahlung in einer einzureichenden Batch-Datei sieht folgendermaßen aus:
HEAD,<MerchantID>,<Date>,<Version>
PAYPAL,Authorize,<Amount>,<Currency>,<TransID>,<PayID>
PAYPAL,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>(,<TID>)
PAYPAL,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>(,<TID>)
PAYPAL,CreditEx,<TransID>,(<RefNr>,)<Amount>,<Currency>,<payer>,<note>
PAYPAL,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>(,<TID>)
Beispiel für Master MID Funktion:
Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action)
FOOT,CountRecords,SumAmount
Hinweis: Bei Version 1.4 ist es auch möglich, bei einer Capture-Aktion den CompleteType zusätzlich mit zu übergeben:
PAYPAL,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>(,<CompleteType>,<TID>)
Die folgende Tabelle beschreibt die einzelnen Felder und Werte, die im Datensatz (Record) innerhalb der Batch-Datei verwendet werden:
Parameter
Format
CND
Beschreibung
Type
a..11
M
HEAD für Header, FOOT für Footer, PAYPAL für PayPal
Action
a..20
M
Der Action-Parameter definiert die Art der Transaktion:
Authorize (Autorisierung)
Capture (Buchung)
Credit (Gutschrift)
CreditEx (Gutschrift ohne vorherige Buchung; bitte stimmen sie sich hierzu vorher mit dem Computop Support ab)
Reverse (Storno)
Abo (Abonnement)
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ährungskürzel, drei Zeichen DIN / ISO 4217
TransID
ans..64
M
TransaktionsID, die für jede Zahlung eindeutig sein muss
RefNr
ans..30
O
eindeutige Referenznummer
payer
ans..100
O
MassPay: E-Mail-Adresse des Käufers: Übergeben Sie hier den erhaltenen Parameter E-Mail aus der Response
note
ans..758
O
Hinweistext für Empfänger
PayID
an32
M
Vom Paygate vergebene ID für diese Transaktion
TID
ans..17
O
Eindeutige Transaktionsnummer bei PayPal. Notwendig bei mehreren Autorisierungen oder Teilbuchungen, Teilgutschriften, Teilstornierungen.
OrderDesc
ans..127
O
Beschreibung der gekauften Waren, Einzelpreise etc.
Capture
a..6
O
Auto oder Manual: bestimmt, ob der angefragte Betrag sofort oder erst später abgebucht wird.
TxType
ans..5
OC
Beschreibung der Felder im Datensatz von Batch-Dateien
Der Record-Bereich in der Antwort-Datei zu Batch-Transaktionen sieht folgendermaßen aus:
HEAD,<MerchantID>,<Date>,<Version>
PAYPAL,Authorize,<Amount>,<Currency>,<TransID>,<PayID>,<Status>,<Code>,<CodeExt>
PAYPAL,Capture,<Betrag>,<Währung>,<TransID>,(<RefNr>,)<PayID>,(TID,)<Status>,<Code>,<CodeExt>
PAYPAL,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,(TID,)<Status>,<Code>,<CodeExt>
PAYPAL,CreditEx,<TransID>,(<RefNr>,)<Amount>,<Currency>,<payer>,<note>,<Status>,<Code>,<CodeExt>
PAYPAL,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>,<CodeExt>
Datei zu Batch-Transaktionen sieht folgendermaßen aus:
Multiexcerpt include | ||||||
---|---|---|---|---|---|---|
|
Die folgende Tabelle beschreibt die Antwort-Parameter, die der Batch-Manager im Record-Bereich zu jeder Transaktion speichert (hier nicht erklärte Standardparameter wie etwa <TransID> oder <RefNR> und Aufrufparameter , werden unverändert zum Aufruf wieder zurückgegeben und sind vorstehend beschrieben):
Parameter
Format
CND
Beschreibung
Action
a..20
M
Der Action-Parameter definiert die Art der Transaktion wie Capture (Buchung) oder Credit (Gutschrift).
PayID
an32
M
Vom Paygate vergebene ID für diese Transaktion
Status
a..50
M
OK oder FAILED
Code
n8
M
Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)
Table Filter | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
|
CodeExt
n..10
O
Beschreibung der Ergebnis-Parameter im Datensatz von Batch-Dateien