Diagramm zum Prozessablauf
Konfiguration für PayPal
PayPal Sandbox-Testkonto
Wenn Sie die Integration testen möchten, bevor Sie live gehen, und noch über kein PayPal Sandbox-Testkonto verfügen, bitten wir Sie im ersten Schritt, ein PayPal Sandbox-Testkonto zu erstellen.
1. Melden Sie sich bei https://developer.paypal.com/ an und gehen Sie zu „Testing Tools“ => „Sandbox Accounts“
2. Klicken Sie auf „Konto erstellen“ und wählen Sie „Geschäftlich (Händlerkonto)“ und „Deutschland“ als „Land / Region“ aus.
3. Wählen Sie „Konto anzeigen/bearbeiten“
4. Nehmen Sie „E-Mail-ID“ und „vom System generiertes Passwort“ und verwenden Sie diese im nächsten Schritt als Login/Pass für Sandbox.
Dem Computop Paygate API-Berechtigungen erteilen
Damit Computop Transaktionen in Ihrem Namen verarbeiten darf, bitten wir Sie, Computop die entsprechenden Berechtigungen zu erteilen.
Berechtigungen können Computop unter Ihrem PayPal-Konto erteilt werden. Bitte verwenden Sie die folgenden Links, um sich bei Ihrem PayPal-Konto anzumelden, und folgen Sie den Schritten.
PayerID an Computop Merchant Services senden
Um die Händlereinrichtung auf Computop-Seite abzuschließen, bitten wir Sie, die PayerID an Computop Merchant Services zu senden.
PayPal Sandbox
1. Melden Sie sich bei https://developer.paypal.com/dashboard an und gehen zu "Testing tools" --> "Sandbox Accounts".
2. Select the appropriate Sandbox merchant account and notify Merchant Services about "Account ID".
PayPal Live-Umgebung
Die PayerID finden Sie unter Ihrem PayPal-Konto unter https://paypal.com/myaccount/settings/ wie angegeben. Durch die PayerID wird der Händler eindeutig bei PayPal identifiziert.
PayPal Smart Button
Es gibt zwei Möglichkeiten zur Integration von PayPal V2 über Computop. Die erste Möglichkeit ist die Nutzung des Computop JavaScript-Moduls. Eine andere besteht darin, eine PayPal-Schaltfläche durch Kopieren und Einfügen des unten dargestellten JavaScript-Codes einzurichten.
Computop JavaScript-Modul
Das Computop PayPal JavaScript-Modul bietet clientseitige Technologie zur Ergänzung der Integration von PayPal V2 über Computop.
- Das Modul lässt sich schnell mit nur einem Befehl installieren
- Die Konfiguration erfolgt zentral
- Geeignet für alle Plattformen mit JS-Unterstützung
Das Modul und die Installationsanweisungen finden Sie unter Readme.
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.
Während Sie in der Sandbox testen, können Sie die client-id verwenden, die zu Ihrer Test-App vom PayPal-Webentwicklerportal passt. Wenn Sie live gehen, ersetzen Sie diese mit der live client-id.
<!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 -->
<!-- While you are testing in sandbox, you can use client-id that matches your test app from PayPal web developer portal. When going live, replace this with the live client-id provided by Paypal -->
<script type="text/javascript" src="https://www.paypal.com/sdk/js?client-id=myClientID¤cy=EUR&intent=capture"></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";
let payid;
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({
// Choose either 'paypal.FUNDING.PAYPAL' or 'paypal.FUNDING.PAYLATER'
fundingSource: paypal.FUNDING.PAYPAL,
// Call your server to set up the transaction
createOrder: function(data, actions) {
return fetch('https://paymentpage.axepta.bnpparibas/ExternalServices/paypalorders.aspx', {
method: 'POST',
body: params
}).then(function (res) {
return res.text();
}).then(function(orderData) {
var json = stringToObj(orderData);
payid = json.PayID;
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://epayment.axepta.bnpparibas/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>
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 Platform bietet 3 mögliche Optionen für eine Zahlung.
- SALE (capture=Auto) (wenn das Platform automatisch die Buchung für eine Zahlung sendet; das ist das Standardszenario, das den Anforderungen der meisten Händler entspricht)
- AUTHORIZE (capture=Manual + txtype=Auth) (wenn die Buchung später vom Händler als separater API-Aufruf gesendet werden soll)
- ORDER (capture=Manual + txtype=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.
Banner
Es ist möglich, direkt unter der Schaltfläche „Später bezahlen“ ein Banner mit zusätzlichen Details zur Verwendung der Option „Später bezahlen“ anzuzeigen.
Hierzu sollte der folgende Code zum Hauptteil der Produktseite hinzugefügt und der Parameter „data-pp-amount“ mit dem tatsächlichen Betragswert aktualisiert werden.
<div data-pp-message data-pp-style-layout="text" data-pp-style-logo-type="inline" data-pp-style-text-color="black" data-pp-style-text-size="12" data-pp-amount=<amount-value> data-pp-placement="product" </div>
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/
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
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:
| 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 |
|---|---|---|---|
| refnr | ans..30 | O | Eindeutige Referenznummer des Händlers |
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. Falls OrderDesc(n) verwendet wird, muss gelten: Amount=ItemTotal+TaxTotal+SHAmount |
| 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. Bitte beachten Sie die weltweit von PayPal unterstützten Währungen unter https://developer.paypal.com/api/rest/reference/currency-codes/. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: |
Key | Format | CND | Beschreibung |
|---|---|---|---|
Capture | a..6 | O | Auto oder Manual: bestimmt, ob der angeforderte Betrag sofort oder später abgerechnet wird. Wichtiger Hinweis: Bitte wenden Sie sich an den Computop Helpdesk für Manual, um verschiedene Möglichkeiten der Nutzung zu besprechen. Wichtiger Hinweis: Bei einer Multi-Seller-Zahlung (Marktplatzfunktionalität) ist nur Auto möglich. |
TxType | ans..5 | C | Pflicht bei Capture=Manual: Transaktionstyp mit den möglichen Werten Order oder Auth. Für die erste Billing Agreement transaction TxType=BAID. Im Fall TxType=BAID sind alle Parameter außer den folgenden optional. RefNr MUSS für jede Transaktion zur Erstellung einer Billing Agreement eindeutig sein.
|
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. Zum Abschließen der Bestellung muss anschließend die Schnittstelle paypalcomplete.aspx aufgerufen werden. |
RTF | ans1 | O | Für zukünftige Verwendung reserviert |
OrderDesc | ans..127 | M | Beschreibung der gekauften Waren, Einzelpreise usw. |
OrderDesc(n) | ans..127 | O | Warenkorb des Kunden im Format: OrderDesc(n)=Name,Amount,Number,Quantity,Description,Tax OrderDesc2 bis max. OrderDesc99 zulässig. Weitere Informationen finden Sie bei PayPal unter https://developer.paypal.com/docs/api/orders/v2/#orders_create!ct=application/json&path=purchase_units/items&t=request. Zur korrekten Ausführung der Anzeigefunktion müssen alle OrderDesc(n) Amounts gleich dem Paygate-Parameter Amount sein. Beispiel zur Übergabe aller Varianten: Amount=1600 Beispiel zusätzlich mit Rabatt / Discount: Amount=400 |
TaxTotal | n..10 | C | Pflicht, wenn +Tax in der Beschreibung von OrderDesc(n) angegeben ist: Gesamtbetrag der Steuern aller Einzelartikel in der kleinsten Währungseinheit (z.B. EUR Cent) = Sum(Tax*Number) |
ItemTotal | n..10 | C | Pflicht, wenn +Tax in der Beschreibung von OrderDesc(n) angegeben ist: Bruttobetrag aller Einzelartikel in der kleinsten Währungseinheit (z.B. EUR Cent) = Sum(Amount*Number) |
ShAmount | n..10 | C | Lieferkosten in der kleinsten Währungseinheit (z.B. EUR Cent). Kann nur verwendet werden, wenn ShAmount <> 0 und in Verbindung mit den Parametern ItemTotal und TaxTotal. |
| 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 |
|---|---|---|---|
| UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| ReqId | ans..32 | O | Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück. Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht. |
Key | Format | CND | Beschreibung |
|---|---|---|---|
Account | ans..128 | O | Für die Verwaltung mehrerer PayPal-Konten, Händlerkonto: ID oder E-Mail-Adresse, für die die Anfrage an PayPal gesendet werden soll |
| Language | ans5 | O | Sprache. Bitte verwenden Sie ausschließlich die von PayPal in der Dokumentation unter https://developer.paypal.com/reference/locale-codes/ bereitgestellten Language-Werte aus der Spalte "BCP-47 code for REST APIs", zum Beispiel de-DE. Wenn Sie die Sprache für den Kunden auf der PayPal-Anmeldeseite steuern möchten, beachten Sie bitte den Ablauf der Prüfungen bei PayPal und wie Sie die Sprache entsprechend beeinflussen können.
|
FirstName | ans..50 | OC | (Pflicht für USA und Kanada): Entweder nur der Vorname oder Vor- und Nachname, wenn ein Firmenname als Lieferadresse verwendet wird. |
LastName | ans..50 | OC | (Pflicht für USA und Kanada): Nachname oder Firmenname der Lieferadresse |
AddrStreet | ans..100 | OC | (Pflicht für USA und Kanada): Straßenname in der Lieferadresse |
AddrStreet2 | ans..100 | O | 2. Straßenname in der Lieferadresse, der weitere Informationen zu Packstation o.ä. enthält. Damit dieser Parameter in der Antwort zurückgeliefert werden kann, muss dieser separat vom Computop Helpdesk aktiviert werden. |
AddrCity | ans..40 | OC | (Pflicht für USA und Kanada): Ort in der Lieferadresse |
AddrState | ans..40 | OC | (Pflicht für USA und Kanada): Bundesstaat der Lieferadresse. Der in AddrCity hinterlegte Ort muss im angegebenen Bundesland liegen, ansonsten lehnt PayPal diese Zahlung ab. Mögliche Werte entnehmen Sie bitte der PayPal-API-Referenzdokumentation. |
AddrZip | ans..20 | OC | (Pflicht für USA und Kanada): Postleitzahl in der Lieferadresse |
AddrCountryCode | an2 | O | Ländercode in der Lieferadresse |
Phone | n..20 | O | Telefonnummer |
NoShipping | n1 | O | Die Übergabe von NoShipping=1 verhindert, dass die bei Paypal hinterlegte Lieferadresse angezeigt wird. Zusätzlich bietet das Computop Paygate die Variante an, dass wir an Ihrer MID die Unterdrückung der Adresse fest für Sie hinterlegen. Bitte beachten Sie, dass die Lieferadresse nur im Fall digitaler Güter unterdrückt werden sollte, da daran auch der Verkäuferschutz geknüpft ist. Bitte wenden Sie sich dafür an den Computop Helpdesk. |
| RiskEvaluation | ans..2048 | O | Array von Key-Value-Paaren (Base64-codiert). Die Liste der Schlüssel muss vor der Verwendung des Parameters RiskEvaluation mit PayPal vereinbart werden (kann bei verschiedenen Händlern unterschiedlich sein). Beispiel: {
"additional_data": [
{
"key": "sender_first_name",
"value": "John"
},
{
"key": "sender_last_name",
"value": "Doe"
}
]
}
|
PaymentUnit(n) | ans..2048 | O | Bei einer Multi-Seller-Zahlung (Marktplatzfunktionalität) bezieht sich jede PaymentUnit(n) auf einen separaten Verkäufer (Händler innerhalb des Marktplatzes) und enthält ein JSON-Objekt (Base64-codiert) mit dem folgenden Format. Beispiel: {
merchantemailaddress: "merchant@example.com",
merchantid: "XVRKM94GQDXB2",
amount: "11000",
itemtotal: "8000",
taxtotal: "2000",
shippingamount: "1000",
invoiceid: "xxxxx",
orderdescription: "yyyyy",
orderitems: [
{
name: "zzzzz",
quantity: "1",
unitamount: "3000",
tax: "1000",
description: "xxxx",
category: "PHYSICAL_GOODS"
},
{
name: "xxxxx",
quantity: "2",
unitamount: "2500",
tax: "500",
description: "yyyyy",
category: "DIGITAL_GOODS"
}
]
}
|
| mode | an8 | O | Wenn mode="redirect" gesendet wird, bedeutet dies, dass der Händler den PayPal Smart Button nicht verwendet und Paygate den Kunden zu PayPal weiterleiten sollte. Wenn mode nicht gesendet wird (oder mit einem anderen Wert außer „redirect“ gesendet wird), bedeutet dies, dass der Händler den PayPal Smart Button verwendet und Paygate den Kunden nicht zu PayPal weiterleitet (die Umleitung wird über den PayPal Smart Button abgewickelt).
|
| CustomerID | ans..10 | O | Wird nur im Zusammenhang mit PayPal Vault verwendet (Funktionsbeschreibung siehe unten). Von PayPal generierte eindeutige Kunden-ID (Beispiel: CwCmvBGJhW). Wenn PayPal Vault auf Händlerebene bei Computop aktiviert ist und der Parameter CustomeriD in der Anfrage angegeben ist, zeigt der PayPal-Minibrowser bereits gespeicherte Zahlungsoptionen an. |
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: 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, AUTHORIZE_REQUEST oder Timeout (nur bei Capture=Manual) auf der URLSuccess-Seite oder FAILED auf der URLFailure-Seite. AUTHORIZE_REQUEST – wird nur bei Anfrageparameter „TxType=auth“ oder „PayPalMethod=shortcut“ aktiv zurückgegeben. Bei Verwendung von TxType=auth oder ohne TxType wird direkt der finale Status zurückgegeben. Timeout – alle offenen Zahlungen mit Status AUTHORIZE_REQUEST werden etwa 3 Stunden später automatisch geschlossen und als Timeout gemeldet |
| 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 |
|---|---|---|---|
| refnr | ans..30 | O | Eindeutige Referenznummer des Händlers |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| CodeExt | ans..128 | O | Fehlercode (SCREAMING_SNAKE_CASE) von PayPal, wenn mit Computop Helpdesk abgesprochen |
| ErrorText | ans..512 | O | Fehlerbeschreibung von PayPal, wenn mit Computop Helpdesk abgesprochen |
| Name | ans..50 | M | Vorname und Nachname zusammen |
FirstName | ans..50 | M | Vorname des Zahlers (PayerInfo, kann vom Kontonamen abweichen) |
LastName | ans..50 | M | Nachname des Zahlers (PayerInfo, kann vom Kontonamen abweichen) |
| ans..100 | M | E-Mail-Adresse des Käufers | |
AddrStreet | ans..100 | O | Straßenname in der Lieferadresse |
AddrStreet2 | ans..100 | O | 2. Straßenname in der Lieferadresse, der weitere Informationen zu Packstation o.ä. enthält. Damit dieser Parameter in der Antwort zurückgeliefert werden kann, muss dieser separat vom Computop Helpdesk aktiviert werden. |
AddrCity | ans..40 | O | Ort in der Lieferadresse |
AddrState | ans..40 | O | Bundesstaat in der Lieferadresse |
AddrZip | ans..20 | O | Postleitzahl in der Lieferadresse |
AddrCountryCode | an2 | O | Ländercode in der Lieferadresse |
Phone | n..20 | O | Telefonnummer |
| BillingAgreementID | ans..19 | O | Billing Agreement, die für nachfolgende Transaktionen basierend auf dieser Billing Agreement verwendet werden kann. |
BillingName | ans..32 | O | Vorname und Nachname zusammen |
BillingAddrStreet | ans..100 | O | Straßenname der bei PayPal hinterlegten Rechnungsadresse |
BillingAddrStreet2 | ans..100 | O | 2. Straßenname der bei PayPal hinterlegten Rechnungsadresse, der weitere Informationen zu Packstation o.ä. enthält. Damit dieser Parameter in der Antwort zurückgeliefert werden kann, muss dieser separat vom Computop Helpdesk aktiviert werden. Für die Rückgabe von Billing-Daten wenden Sie sich bitte direkt an Ihre Ansprechpartner bei PayPal, welche die Rückgabe sowohl für den Live- als auch den Sandbox-Account aktivieren müssen. |
BillingAddrCity | ans..40 | O | Ortsname der bei PayPal hinterlegten Rechnungsadresse. Für die Rückgabe von Billing-Daten wenden Sie sich bitte direkt an Ihre Ansprechpartner bei PayPal, welche die Rückgabe sowohl für den Live- als auch den Sandbox-Account aktivieren müssen. |
BillingAddrState | ans..40 | O | Bundesstaat der bei PayPal hinterlegten Rechnungsadresse. Für die Rückgabe von Billing-Daten wenden Sie sich bitte direkt an Ihre Ansprechpartner bei PayPal, welche die Rückgabe sowohl für den Live- als auch den Sandbox-Account aktivieren müssen. |
BillingAddrZIP | ans..20 | O | Postleitzahl der bei PayPal hinterlegten Rechnungsadresse. Für die Rückgabe von Billing-Daten wenden Sie sich bitte direkt an Ihre Ansprechpartner bei PayPal, welche die Rückgabe sowohl für den Live- als auch den Sandbox-Account aktivieren müssen. |
BillingAddrCountryCode | an2 | O | Ländercode in der Rechnungsadresse. Für die Rückgabe von Billing-Daten wenden Sie sich bitte direkt an Ihre Ansprechpartner bei PayPal, welche die Rückgabe sowohl für den Live- als auch den Sandbox-Account aktivieren müssen. |
| payerStatus | an..10 | O | Status des Käufers mit den möglichen Werten "verified" oder "unverified" |
InfoText | ans..255 | M | Nachricht an den Händler |
PayerID | ans..13 | O | (falls Antwort aktiviert ist): Eindeutige Identifikationsnummer des Kundenkontos bei PayPal |
GrossAmount | an..9 | O | Abgerechneter Endbetrag, einschließlich Versandkosten und Steuern aus Ihrem Händlerprofil |
FeeAmount | an..9 | O | Für die Transaktion berechneter Betrag der PayPal-Gebühr |
SettleAmount | an..9 | O | Auf Ihrem PayPal-Konto nach einer Währungsumrechnung eingezahlter Betrag |
TaxAmount | an..9 | O | Auf die Transaktion erhobene Steuer |
ExchangeRate | an..17 | O | Wechselkurs, falls eine Währungsumrechnung stattgefunden hat. Nur relevant, wenn Sie in ihrer Nicht-Hauptwährung abrechnen. Wenn der Käufer mit einer anderen Währung als der Nicht-Primärwährung bezahlt, erfolgt die Umrechnung im Konto des Käufers. |
mc_fee | an..9 | C | Nur bei einem separaten Notify von PayPal: Transaktionsgebühr im Zusammenhang mit der Zahlung. mc_gross minus mc_fee entspricht dem Betrag, der auf das Konto receiver_email eingezahlt wurde. Entspricht Payment_fee für USD-Zahlungen. Wenn dieser Betrag negativ ist, bedeutet dies eine Rückerstattung oder Stornierung, und jeder dieser Zahlungsstatus kann für den vollen oder einen Teilbetrag der ursprünglichen Transaktionsgebühr gelten. |
mc_gross | an..9 | C | Nur bei einem separaten Notify von PayPal: Gesamtbetrag der Zahlung des Kunden vor Abzug der Transaktionsgebühr. Äquivalent zu payment_gross für USD-Zahlungen. Wenn dieser Betrag negativ ist, bedeutet dies eine Rückerstattung oder Stornierung, und jeder dieser Zahlungsstatus kann für den gesamten oder einen Teilbetrag der ursprünglichen Transaktion gelten. |
| OrderStatus(n) | ans..255 | O | Bei einer Multi-Seller-Zahlung (Funktionalität Marketplace) enthält jeder OrderStatus(n) den Status und die Capture-ID (bei einer Gutschrift zu verwenden) für die entsprechenden in der Anfrage gesendeten OrderDesc(n). JSON-Objekt (Base64-codiert) mit dem folgenden Format. Beispiele: {"status":"COMPLETED", "id":"3C679366HH908993F1", "invoiceid":"PU1_20230812"}
{"status":"FAILED", "id":"na", "invoiceid":""}
Der Status wurde analysiert, da ein Kunde nicht genug Geld für alle Händler haben könnte. In diesem Fall genehmigt PayPal nur einige OrderDesc(n) (nur für einige Händler). |
| TID | ans..17 | O | Bei SALE enthält der Parameter eine eindeutige, von PayPal generierte Capture-ID. Bei AUTH enthält der Parameter eine eindeutige, von PayPal generierte Autorisierungs-ID. |
| TransactionID | ans..17 | O | The parameter contains unique PayPal-generated Order ID |
| CustomerID | ans..10 | O | Wird nur im Zusammenhang mit PayPal Vault verwendet (Funktionsbeschreibung siehe unten). Von PayPal generierte eindeutige Kunden-ID (Beispiel: CwCmvBGJhW). Wenn PayPal Vault auf Händlerebene bei Computop aktiviert ist und der Kunde im PayPal-Minibrowser die Speicherung der Zahlungsmethode gewählt oder einer Abrechnungsvereinbarung mit dem Händler zugestimmt hat (dem Händler die Berechtigung erteilt hat, in Zukunft Zahlungen ohne Kundenbeteiligung zu generieren). |
| VaultID | ans..17 | O | Wird nur im Zusammenhang mit PayPal Vault verwendet (Funktionsbeschreibung siehe unten). Von PayPal generierte eindeutige Vault-ID (Beispiel: 6xc41489mf360280l). Wenn PayPal Vault auf Händlerebene bei Computop aktiviert ist und der Kunde im PayPal-Minibrowser die Speicherung der Zahlungsmethode gewählt oder einer Abrechnungsvereinbarung mit dem Händler zugestimmt hat (dem Händler die Berechtigung erteilt hat, in Zukunft Zahlungen ohne Kundenbeteiligung zu generieren). |
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.
Funktion PayPal Vault
Die Funktion PayPal Vault bietet zwei Anwendungsfälle.
Anwendungsfall 1: Anzeige gespeicherter Zahlungsmethoden im PayPal Minibrowser
Wenn PayPal Vault auf Händlerebene bei Computop aktiviert ist und der Parameter CustomerID in der Anfrage angegeben ist, zeigt der PayPal-Minibrowser die bereits gespeicherten Zahlungsoptionen wie folgt an.
So funktioniert es:
- Der Händler ist bei Computop für PayPal Vault konfiguriert.
- In diesem Fall sendet Computop durch Aufruf von paypalorders.aspx ein Flag an PayPal, um dem Kunden die Option „Zahlungsmethode für weitere Verwendung speichern“ im PayPal-Minibrowser anzubieten.
- Falls der Kunde der Option zustimmt, erhält der Händler als Antwort die Parameter CustomerID und VaultID.
- Wenn der Händler beim nächsten Mal die CustomerID in einer Anfrage an paypayorders.aspx sendet, werden dem Kunden die zuvor gespeicherten Zahlungsmethoden angezeigt (siehe Abbildung oben).
Anwendungsfall 2: Referenztransaktionen (oder Abrechnungsvereinbarung)
So funktioniert es:
- Der Händler ist bei Computop für PayPal Vault konfiguriert.
- In diesem Fall sendet Computop durch Aufruf von paypalorders.aspx ein Flag an PayPal, dass es sich um die erste Zahlung in einer Reihe von Zahlungen handelt. PayPal fordert den Kunden auf, die Transaktionen im PayPal-Browser zu bestätigen.
- Falls der Kunde dem zustimmt, erhält der Händler als Antwort die Parameter CustomerID und VaultID.
- Um die nächste Zahlung (aus der Reihe der bestätigten Zahlungen) einzuleiten, ruft der Händler paypalvault.aspx auf und sendet die VaultID im Parameter BillingAgreementID.
Wichtiger Hinweis
In beiden Anwendungsfällen werden zwei Benachrichtigungen für die Anfrage paypalorders.aspx an URLNotify gesendet. Dies liegt daran, dass PayPal die Anfrage im Fall von PayPal Vault in zwei Schritten verarbeitet. Im ersten Schritt wird auf PayPal-Seite ein Vault erstellt. Dabei konnten die Parameter CustomerID und VaultID nicht zurückgegeben werden. Im zweiten Schritt wird der Vault auf PayPal-Seite genehmigt. Dabei werden die Parameter CustomerID und VaultID erstellt und zurückgegeben.
Es ist daher möglich, dass die Parameter CustomerID und VaultID in der ersten Benachrichtigung fehlen. Warten Sie in diesem Fall bitte auf die zweite Benachrichtigung (in den meisten Fällen erfolgt diese innerhalb von 5-10 Sekunden).
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. Um im nächsten Schritt diese PayPal-Zahlung abzuschließen, nutzen Sie folgende URL und Parameter:
https://www.computop-paygate.com/paypalComplete.aspx |
Bitte beachten Sie nachfolgende Prozessbeschreibung welche durch das Senden "PayPalMethod=shortcut" ausgelöst wird.
Durch das Senden "PayPalMethod=shortcut" wird der Endkunde zu PayPal geleitet, dort führt dieser eine Vorabbestätigung aus (hier handelt es sich noch nicht um die abschließende Zahlungsbestätigung) und der Kunde wird zurück in den Shop geleitet.
Der Redirect / Rücksprung wird hier auf die URLFailure mit den nachfolgenden Response Parametern ausgeführt. Bitte beachten Sie, dass es hier eine Änderung zur älteren PayPal Classic API gibt. Für diese wird der Redirect / Rücksprung auf die URLSuccess prozessiert und via Response wird der offene Status wie folgt gemeldet "Status=AUTHORIZE_REQUEST&Code=00000000&Description=REQUEST".
Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie als Händler den Redirect auf die URLSuccess prozessieren möchten und Code und Description "Status=AUTHORIZE_REQUEST&Code=00000000&Description=REQUEST" lauten sollen.
PayPal V2 Response Parameter - offener Status:
- Status=AUTHORIZE_REQUEST
- Code=21500985
- Description=PENDING
Des weiteren ist auch zu beachten, dass der Händler nach dem Rücksprung des Kunden zum offenen Status den Betrag für den paypalComplete Request verändern kann. Hier existieren allerdings PayPal eigene Restriktionen damit der Betrag nicht X beliebig nach oben hin verändert werden kann. Genauere Details zu dem Thema besprechen Sie bitte mit Ihrem PayPal Account Manager.
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. Bitte beachten Sie die weltweit von PayPal unterstützten Währungen unter https://developer.paypal.com/api/rest/reference/currency-codes/. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| refnr | ans..30 | O | Eindeutige Referenznummer des Händlers |
Key | Format | CND | Beschreibung |
|---|---|---|---|
PayID | an32 | M | Vom Platform vergebene ID für die Zahlung. Übergeben Sie hier die PayID aus der Antwort von paypal.aspx, die Sie im bisherigen Transaktionsablauf erhalten haben. |
FirstName | ans..50 | C | Pflicht, um Adressangaben zu übermitteln: Entweder nur der Vorname oder Vor- und Nachname, falls ein Firmenname als Lieferadresse genutzt wird. |
LastName | ans..50 | 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: 2. Straßenname in der Lieferadresse, der weitere Informationen zu Packstation o.ä. enthält. Damit dieser Parameter in der Antwort zurückgeliefert werden kann, muss dieser separat vom Computop Helpdesk aktiviert werden. |
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 Parameter, die das Paygate als Antwort zurückgibt: 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 |
|---|---|---|---|
| refnr | ans..30 | O | Eindeutige Referenznummer des Händlers |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| CodeExt | n..10 | O | Fehlercode des externen Partners, wenn mit dem Computop Helpdesk 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 verwenden Sie bitte URL:
https://www.computop-paygate.com/Authorize.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 |
|---|---|---|---|
| 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 |
|---|---|---|---|
| TransID | ans..64 | M | Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss |
Key | Format | CND | Description | Beschreibung |
|---|---|---|---|---|
| TxType | ans..5 | M | Transaction type Auth | Transaktionstyp Auth |
| 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. Bitte beachten Sie die weltweit von PayPal unterstützten Währungen unter https://developer.paypal.com/api/rest/reference/currency-codes/. |
Key | Format | CND | Beschreibung |
|---|---|---|---|
FirstName | ans..50 | O | Entweder nur der Vorname oder Vor- und Nachname, wenn ein Firmenname als Lieferadresse verwendet wird |
LastName | ans..50 | O | Nachname oder Firmenname der Lieferadresse |
AddrStreet | ans..100 | O | Straßenname in der Lieferadresse |
AddrStreet2 | ans..100 | O | 2. Straßenname in der Lieferadresse, der weitere Informationen zu Packstation o.ä. enthält. Damit dieser Parameter in der Antwort zurückgeliefert werden kann, muss dieser separat vom Computop Helpdesk aktiviert werden. |
AddrCity | ans..40 | O | Ort in der Lieferadresse |
AddrState | ans..40 | O | Bundesstaat der Lieferadresse. Der in AddrCity hinterlegte Ort muss im angegebenen Bundesland liegen, ansonsten lehnt PayPal diese Zahlung ab. Mögliche Werte entnehmen Sie bitte der PayPal-API-Referenzdokumentation. |
AddrZip | ans..20 | O | Postleitzahl in der Lieferadresse |
AddrCountryCode | an2 | O | Ländercode in der Lieferadresse |
Phone | n..20 | O | Telefonnummer |
Parameter für PayPal-Autorisierung
Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt: 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 |
|---|---|---|---|
| CodeExt | ans..128 | O | Fehlercode (SCREAMING_SNAKE_CASE) von PayPal, wenn mit Computop Helpdesk abgesprochen |
| ErrorText | ans..512 | O | Fehlerbeschreibung von PayPal, wenn mit Computop Helpdesk abgesprochen |
Ergebnis-Parameter bei PayPal-Autorisierung
Buchung
Um eine Buchung (Capture) für PayPal über eine Server-zu-Server-Verbindung auszuführen, verwenden Sie bitte folgende URL:
https://www.computop-paygate.com/capture.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:
Parameter für PayPal-Buchungen
Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt: 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 |
|---|---|---|---|
| CodeExt | ans..128 | O | Fehlercode (SCREAMING_SNAKE_CASE) von PayPal, wenn mit Computop Helpdesk abgesprochen |
| ErrorText | ans..512 | O | Fehlerbeschreibung von PayPal, wenn mit Computop Helpdesk abgesprochen |
Ergebnis-Parameter für PayPal-Buchungen
Gutschrift mit Referenz
Um eine Gutschrift (Credit) mit Referenztransaktion für PayPal auszuführen, verwenden Sie bitte folgende URL:
https://www.computop-paygate.com/credit.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 |
|---|---|---|---|
| PayID | an32 | M | Vom Paygate vergebene ID für die gutzuschreibende Zahlung |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| TransID | ans..64 | M | Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: |
| 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. Bitte beachten Sie die weltweit von PayPal unterstützten Währungen unter https://developer.paypal.com/api/rest/reference/currency-codes/. |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| RefNr | ans..30 | O | Referenznummer des Händlers: hier kann eine separate Referenznummer übertragen werden, z.B. eine Rechnungsnummer |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| ReqId | ans..32 | O | Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück. Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht. |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| TID | ans..17 | O | Eindeutige, von PayPal generierte Capture-ID. Der Wert wird für eine Rückerstattung nach mehreren Teilbuchungen benötigt. Beispiel: Ein Händler hat 3 Teilbuchungen für eine Autorisierung durchgeführt. Für jede Buchung wird eine eindeutige, von PayPal generierte Capture-ID in der TID zurückgegeben (z. B. TID=111, TID=222, TID=333). Dann sollte eine Rückerstattung für die zweite Buchung erfolgen. In diesem Fall muss der Händler TID=222 in der Anfrage der Rückerstattung senden. |
| Note | ans..768 | C | Erläuterungstext für den Empfänger |
| Subject | ans..255 | C | MassPay: E-Mail-Betreff an den Empfänger Wenn Sie die MassPay-Funktionalität nutzen möchten, wenden Sie sich bitte an den Computop Helpdesk, um diese Funktion für Sie zu aktivieren. |
Parameter für PayPal-Gutschriften mit Bezugstransaktion
Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt: 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 |
|---|---|---|---|
| CodeExt | ans..128 | O | Fehlercode (SCREAMING_SNAKE_CASE) von PayPal, wenn mit Computop Helpdesk abgesprochen |
| ErrorText | ans..512 | O | Fehlerbeschreibung von PayPal, wenn mit Computop Helpdesk abgesprochen |
FeeRefundAmount | n..10 | O | Der erstattete Betrag der PayPal-Transaktionsgebühren. Erforderlich für Teilgutschriften zu früheren Teilbuchungen. |
GrossRefundAmount | n..10 | O | Betrag, der dem Käufer bei dieser Gutschrift erstattet wird. Erforderlich für Teilgutschriften zu früheren Teilbuchungen. |
NetRefundAmount | n..10 | O | Betrag, der von Ihrem PayPal-Konto abgezogen wird, um diese Gutschrift vorzunehmen. Erforderlich für Teilgutschriften zu früheren Teilbuchungen. |
Ergebnis-Parameter für PayPal-Gutschriften mit Bezugstransaktion
Storno
Um eine Transaktion bei PayPal zu stornieren, verwenden Sie bitte folgende URL:
https://www.computop-paygate.com/reverse.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 |
|---|---|---|---|
| PayID | an32 | M | Vom Paygate vergebene ID für die zu stornierende Zahlung |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| TransID | ans..64 | M | Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: |
| 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. Bitte beachten Sie die weltweit von PayPal unterstützten Währungen unter https://developer.paypal.com/api/rest/reference/currency-codes/. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| ReqId | ans..32 | O | Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück. Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht. |
Parameter für PayPal-Stornierungen
Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt: 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 |
|---|---|---|---|
| CodeExt | ans..128 | O | Fehlercode (SCREAMING_SNAKE_CASE) von PayPal, wenn mit Computop Helpdesk abgesprochen |
| ErrorText | ans..512 | O | Fehlerbeschreibung von PayPal, wenn mit Computop Helpdesk abgesprochen |
Ergebnis-Parameter für PayPal-Stornierungen
Referenztransaktionen
Voraussetzungen
- Die Option "Referenztransaktionen“ muss in Ihrem PayPal-Konto aktiviert sein. Beantragen Sie die Aktivierung bitte direkt bei PayPal.
Prozess
Der Prozess umfasst zwei Schritte.
Einrichten einer Abrechnungsvereinbarung (Anfangstransaktion der Abrechnungsvereinbarung)
- Rufen Sie PayPalOrders.aspx mit TxType=BAID auf (siehe ). Als Antwort gibt das Paygate die URL zurück. Alle Parameter außer den folgenden sind im Fall von TxType=BAID optional.
- Über die URL meldet sich der Kunde im PayPal-Konto an und genehmigt die Abrechnungsvereinbarung.
- Sobald die Abrechnungsvereinbarung vom Kunden genehmigt ist, wird die Billing Agreement ID über URLNotify gesendet.
Nutzung der Abrechnungsvereinbarung
- Rufen Sie PayPalRefTrans.aspx auf (unten als Server-zu-Server-Anfrage beschrieben) mit BillingAgreementID="Billing Agreement ID", die im vorigen Schritt erzeugt wurde. Der Kunde muss sich zur Genehmigung der Transaktion nicht mehr am PayPal-Konto anmelden.
Widerruf der Abrechnungsvereinbarung
- Ein Kunde kann die Billing Agreement ID in seinem eigenen PayPal-Konto widerrufen.
- Wenn ein Kunde die Billing Agreement ID widerruft, sind keine weiteren Referenztransaktionen (unter Verwendung dieser Billing Agreement ID) mehr möglich. Diese Billing Agreement ID kann auch nicht wieder reaktiviert werden.
Anfrage
Um eine PayPal-Abonnementzahlung zu veranlassen, verwenden Sie bitte folgende URL:
https://www.computop-paygate.com/paypalreftrans.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. Bitte beachten Sie die weltweit von PayPal unterstützten Währungen unter https://developer.paypal.com/api/rest/reference/currency-codes/. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| refnr | ans..30 | O | Eindeutige Referenznummer des Händlers |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| OrderDesc | ans..30 | O | Beschreibung der gekauften Waren, Einzelpreise usw. |
| BillingAgreementID | an19 | M | Identifikationsnummer der Rechnungsvereinbarung. Wenn der Käufer die Rechnungsvereinbarung bestätigt, wird diese validiert und bleibt gültig, bis sie vom Käufer widerrufen wird. |
Parameter für PayPal-Referenztransaktionen
Antwort
Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt: 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 |
|---|---|---|---|
| CodeExt | ans..128 | O | Fehlercode (SCREAMING_SNAKE_CASE) von PayPal, wenn mit Computop Helpdesk abgesprochen |
| ErrorText | ans..512 | O | Fehlerbeschreibung von PayPal, wenn mit Computop Helpdesk abgesprochen |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| refnr | ans..30 | O | Eindeutige Referenznummer des Händlers |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| OrderID | ans..17 | O | Eindeutige, von PayPal generierte OrderID |
| TID | ans..17 | O | Eindeutige, von PayPal generierte CaptureID |
| Name | ans..32 | O | Vor- und Nachname zusammengefügt |
FirstName | ans..50 | O | Vorname des Zahlers (PayerInfo, kann vom Kontonamen abweichen) |
LastName | ans..50 | O | Nachname des Zahlers (PayerInfo, kann vom Kontonamen abweichen) |
| ans..100 | O | E-Mail-Adresse des Käufers | |
BillingName | ans..32 | O | Vor- und Nachname zusammengefügt |
BillingAddrCountryCode | an2 | O | Ländercode der Rechnungsadresse |
PayerID | ans..13 | O | (bei aktivierter Antwort): Eindeutige ID des Kundenkontos bei PayPal |
Ergebnis-Parameter für PayPal-Referenztransaktionen
Vault
Voraussetzungen
- Die Option "Vault“ muss in Ihrem PayPal-Konto aktiviert sein. Beantragen Sie die Aktivierung bitte direkt bei PayPal.
Prozess
Der Prozess umfasst zwei Schritte.
Einrichten eines Vault (Anfangstransaktion des Vault)
- Rufen Sie PayPalOrders.aspx auf. Falls die Funktion für Ihre MID aktiviert ist, gibt Paypal/Computop Paygate die VaultID zurück.
- Über die URL meldet sich der Kunde im PayPal-Konto an und genehmigt den Vault.
- Sobald der Vault vom Kunden genehmigt ist, wird die VaultID über URLNotify gesendet.
Nutzung des Vault
- Rufen Sie paypalvault.aspx auf (unten als Server-zu-Server-Anfrage beschrieben) mit VaultID="VaultID", die im vorigen Schritt erzeugt wurde. Der Kunde muss sich zur Genehmigung der Transaktion nicht mehr am PayPal-Konto anmelden.
Widerruf des Vault
- Ein Kunde kann die VaultID in seinem eigenen PayPal-Konto widerrufen.
- Wenn ein Kunde die VaultID widerruft, sind keine weiteren Transaktionen (unter Verwendung dieser VaultID) mehr möglich. Diese VaultID kann auch nicht wieder reaktiviert werden.
Anfrage
Um eine PayPal-Abonnementzahlung zu veranlassen, verwenden Sie bitte folgende URL:
https://www.computop-paygate.com/paypalvault.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. Bitte beachten Sie die weltweit von PayPal unterstützten Währungen unter https://developer.paypal.com/api/rest/reference/currency-codes/. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| refnr | ans..30 | O | Eindeutige Referenznummer des Händlers |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| OrderDesc | ans..30 | O | Beschreibung der gekauften Waren, Einzelpreise usw. |
| VaultID | an19 | M | Identifikationsnummer der Rechnungsvereinbarung. Wenn der Käufer die Rechnungsvereinbarung bestätigt, wird diese validiert und bleibt gültig, bis sie vom Käufer widerrufen wird. |
Parameter für PayPal-Vault-Transaktionen
Antwort
Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt: 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 |
|---|---|---|---|
| CodeExt | ans..128 | O | Fehlercode (SCREAMING_SNAKE_CASE) von PayPal, wenn mit Computop Helpdesk abgesprochen |
| ErrorText | ans..512 | O | Fehlerbeschreibung von PayPal, wenn mit Computop Helpdesk abgesprochen |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| refnr | ans..30 | O | Eindeutige Referenznummer des Händlers |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| OrderID | ans..17 | O | Eindeutige, von PayPal generierte OrderID |
| TID | ans..17 | O | Eindeutige, von PayPal generierte CaptureID |
| Name | ans..32 | O | Vor- und Nachname zusammengefügt |
FirstName | ans..50 | O | Vorname des Zahlers (PayerInfo, kann vom Kontonamen abweichen) |
LastName | ans..50 | O | Nachname des Zahlers (PayerInfo, kann vom Kontonamen abweichen) |
| ans..100 | O | E-Mail-Adresse des Käufers | |
BillingName | ans..32 | O | Vor- und Nachname zusammengefügt |
BillingAddrCountryCode | an2 | O | Ländercode der Rechnungsadresse |
PayerID | ans..13 | O | (bei aktivierter Antwort): Eindeutige ID des Kundenkontos bei PayPal |
Paketverfolgung
Mit der Paketverfolgungsfunktion können Sie PayPal-Bestellungen nach dem Erstellen eines Versandetiketts Sendungsverfolgungsnummern zuweisen. Die Angabe der Versanddetails erleichtert die Identifizierung von Artikeln während des Transports und verbessert das Zahlungserlebnis in der App. Die Versandinformationen werden von PayPal außerdem im Streitbeilegungsprozess verwendet.
Um Versanddetails über eine Server-zu-Server-Verbindung hinzuzufügen oder zu entfernen, verwenden Sie bitte die folgende URL:
https://www.computop-paygate.com/trackdelivery.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:
Parameter für PayPal-Paketverfolgung
Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt: 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 |
|---|---|---|---|
CodeExt | ans..128 | O | Fehlercode (SCREAMING_SNAKE_CASE) von PayPal, wenn mit dem Computop Helpdesk abgesprochen. |
| ErrorText | ans..512 | O | Fehlerbeschreibung von PayPal, wenn mit Computop Helpdesk abgesprochen |
TrackerID | ans..30 | M | Von PayPal generierte eindeutige Tracker-ID. Dieser Wert sollte im Parameter TrackerID mit EventToken="remove" gesendet werden (z. B. wenn Tracking-Informationen versehentlich gesendet wurden und entfernt werden sollen). |
Antwort-Parameter für PayPal-Paketverfolgung
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:
Action | Version | Beschreibung |
|---|---|---|
| Authorize | 1.0 / 2.0 | Standardversion ohne Rückgabe von Parameter Code |
1.4 / 2.4 | mit TID | |
| Capture | 1.0 / 2.0 | Standardversion ohne Rückgabe von Parameter 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 Parameter 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 Parameter 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 Parameter Code |
1.4 / 2.4 | mit TID | |
| ABO/REFTRANS | 1.0 / 2.0 | ABO - Classic PayPal API REFTRANS - Order V2 PayPal API Standardversion ohne Rückgabe von Parameter 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>) PAYPAL,REFTRANS,<Amount>,<Currency>,<TransID>,(<RefNr>),(<OrderDesc>),(<Capture>),(<TxType>),<BillingAgreementId> FOOT,<CountRecords>,<SumAmount>
Beispiel für Master-MID-Funktion:
HEAD,[Master]MerchantID,Date,2.x 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:
Key | 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) REFTRANS (Abonnement, Order V2 API) |
| 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. Bitte beachten Sie die weltweit von PayPal unterstützten Währungen unter https://developer.paypal.com/api/rest/reference/currency-codes/. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| TransID | ans..64 | M | Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| refnr | ans..30 | O | Eindeutige Referenznummer des Händlers |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| payer | ans..100 | O | MassPay: E-Mail-Adresse des Käufers: In diesem Fall übergeben Sie den empfangenen E-Mail-Parameter aus der Antwort Wenn Sie die MassPay-Funktionalität nutzen möchten, wenden Sie sich bitte an den Computop Helpdesk, um diese Funktion für Sie zu aktivieren. |
| note | ans..758 | O | Erläuterungstext für den Empfänger |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| PayID | an32 | M | Vom Paygate vergebene ID für diese Transaktion |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| TID | ans..17 | O | Eindeutige PayPal-Transaktionsnummer. Erforderlich für eine Reihe von Autorisierungen oder Teilbuchungen, Teilgutschriften oder Teilstornierungen. |
| OrderDesc | ans..127 | O | Beschreibung der gekauften Waren, Einzelpreise usw. |
| Capture | a..6 | O | Auto oder Manual: legt fest, ob der angeforderte Betrag sofort oder zu einem späteren Zeitpunkt abgerechnet wird. Für REFTRANS ist nur Auto möglich. |
| TxType | ans..5 | OC | Pflicht bei Capture=Manual: Transaktionstyp mit den möglichen Werte Order und Auth |
BillingAgreementID | an19 | OC | Identifikationsnummer der Rechnungsvereinbarung. Wenn der Käufer die Rechnungsvereinbarung bestätigt, wird sie gültig und bleibt gültig, bis sie vom Käufer widerrufen wird. Pflicht bei X und Y. |
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,<Amount>,<Currency>,<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>,(<TID>,)<Status>,<Code>,<CodeExt> PAYPAL,REFTRANS,<Amount>,<Currency>,<TransID>,(<RefNr>),(<OrderDesc>),(<Capture>),(<TxType>),<BillingAgreementId>,<PayID>,<Status>,<Code>,<CodeExt> FOOT,<CountRecords>,<SumAmount>
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):
Key | Format | CND | Beschreibung |
|---|---|---|---|
Action | a..20 | M | Der Action-Parameter definiert die Art der Transaktion wie Buchung oder Gutschrift. |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| PayID | an32 | M | Vom Paygate vergebene ID für diese Transaktion |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) oder FAILED (URLFailure) |
| Key | Format | CND | Beschreibung |
|---|---|---|---|
| Code | an8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
Key | Format | CND | Beschreibung |
|---|---|---|---|
| CodeExt | ans..128 | O | Fehlercode (SCREAMING_SNAKE_CASE) von PayPal, wenn mit Computop Helpdesk abgesprochen |
| ErrorText | ans..512 | O | Fehlerbeschreibung von PayPal, wenn mit Computop Helpdesk abgesprochen |
Beschreibung der Ergebnis-Parameter im Datensatz von Batch-Dateien













