Konfiguration für PayPal
Damit Sie als Online-Anbieter PayPal-Transaktionen über das Computop Paygate abwickeln können, benötigen Sie ein Geschäftskonto bei PayPal. Weiterhin müssen Sie die PayPal-Schnittstelle für die Nutzung über das Paygate freigeben und die nötigen Einstellungen für den Empfang von Zahlungen vornehmen.
PayPal-Geschäftskonto anlegen und konfigurieren
- Bitte rufen Sie die URL http://www.paypal.com
- Anschließend klicken Sie links in der Servicebox auf die Schaltfläche „Neu anmelden“.
- Sie werden von PayPal auf die nächste Seite weitergeleitet.
- Dort wählen Sie „Geschäftskonto“ aus und klicken auf „weiter“.
- Nun werden Sie auf die Seite „Geschäftskonto eröffnen“ weitergeleitet. Bitte geben Sie dort Ihre E-Mail-Adresse ein, welche für den PayPal-Account verwendet werden soll und klicken dann auf die Schaltfläche „Weiter“.
- Bitte geben Sie hier Ihre Daten ein, bestätigen per Option die PayPal-Nutzungsbedingungen und klicken dann auf die Schaltfläche „Weiter“.
- Hinterlegen Sie auf den nächsten Seiten die benötigten Angaben zu Ihrem Unternehmen.
- Sie erhalten jetzt eine E-Mail, welche Sie bestätigen müssen.
- Ergänzen Sie bitte die weiteren notwendigen Angaben zu Ihrem Unternehmen.
PayPal-API freigeben
Damit über das Computop Paygate PayPal-Transaktionen abgewickelt werden können, muss die API-Genehmigung für Computop erteilt werden. Dazu führen Sie die nachfolgend erklärten sechs Schritte aus.
- Wählen Sie im Menü „Mein Profil“ die „Kontoeinstellungen“ aus
- Bitte wählen Sie nun links in der Servicebox „Verkäufer/Händler“ …
… und anschließend mit der Schaltfläche „Aktualisieren“ den Punkt „API-Zugriff“ aus. - Klicken Sie dann bitte auf den Link „API-Genehmigung erteilen“
- Bitte tragen Sie im Feld „Benutzername für Genehmigungen für Drittanbieter“ den nachfolgenden Wert ein und klicken dann auf die Schaltfläche „Nachschlagen“: frank.arnoldt_api1.computop.de
- Bitte setzen Sie bei den folgenden Punkten das Häkchen, alle anderen Optionen lassen Sie deaktiviert. Anschließend bestätigen Sie die Eingaben per Schaltfläche „Hinzufügen“.
- Verwenden der Express-Kaufabwicklung für Ihre Zahlungsvorgänge
- Veranlassen einer Rückzahlung für bestimmte Transaktionen
- Autorisieren und Einziehen Ihrer PayPal-Transaktionen
- Abrufen von Informationen zu einer einzelnen Transaktion
- Durchsuchen Ihrer Transaktionen nach Artikeln, die spezifische Kriterien entsprechen, und Anzeigen der Ergebnisse - Sie erhalten die Bestätigung darüber, dass der Drittanbieter „frank.arnoldt_api1.computop.de“ hinzugefügt wurde.
PayPal-API Genehmigungen für Sandbox erteilen
Für die PayPal Sandbox können die API-Genehmigungen folgendermaßen erteilt werden.
- Auf https://developer.paypal.com finden Sie unter "Accounts" --> (Accountname) --> "Manage accounts" --> "View/ edit account" die Zugangsdaten des jeweiligen Händlerkontos.
- Mit diesen Zugangsdaten melden Sie sich unter https://sandbox.paypal.com an.
- Klicken Sie oben rechts auf den Namen und gehen zu den "Kontoeinstellungen".
- Klicken Sie auf "API-Zugriff" --> "API-Genehmigung erteilen" --> Tragen Sie "test_paypal_api_api1.computop.com" ein.
- Setzen Sie die Häkchen bei folgenden Berechtigungen:
- Verwenden von PayPal Express für Ihre Zahlungsvorgänge
- Veranlassen einer Rückzahlung für eine bestimmte Transaktion
- Autorisieren und Einziehen Ihrer PayPal-Transaktionen
- Abrufen von Informationen zu einer einzelnen Transaktion
- Ihre Transaktionen nach bestimmte Kriterien durchsuchen und die Suchergebnisse anzeigen
Einstellungen für den Zahlungsempfang vornehmen
- Im Menü wählen Sie „Mein Profil“ aus und klicken auf „Kontoeinstellungen“.
- Bitte wählen Sie hier unter „Verkäufer/Händler“ den Punkt „Zahlungen sperren“ über den Link „Aktualisieren“ aus.
- Bitte stellen Sie hier folgende Punkte ein.
- Zahlungseingänge in einer nicht unterstützten Währung blockieren
- Doppelte Zahlungen mit gleicher Invoice ID vermeiden
- Automatische Zahlungen für eBay-Rückerstattungen einrichten
- Texteingabefeld "Anweisungen für Verkäufer hinzufügen" anzeigen
Bitte bestätigen Sie Ihre Eingaben mit einem Klick auf die Schaltfläche „Speichern“.
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/paypal.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: Bitte beachten Sie, dass eine PayPal-Anbindung im Shop per i-Frame aufgrund von PayPal-Regularien nicht möglich ist. Express Checkout funktioniert mit einer Weiterleitung des Kunden direkt zu PayPal.
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 | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table. Please note the global PayPal supported currencies at https://developer.paypal.com/api/rest/reference/currency-codes/. |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
| Key | Format | CND | Description |
|---|---|---|---|
| refnr | ans..30 | O | Merchant’s unique reference number |
Key | Format | CND | Description | Beschreibung |
|---|---|---|---|---|
Capture | a..6 | O | Auto or Manual: determines whether the requested amount is settled immediately or at a later stage. Important Note: Please contact Computop Helpdesk for Manual, to discuss different possibilities of usage. | Auto oder Manual: bestimmt, ob der angefragte Betrag sofort oder erst später abgebucht wird. Wichtiger Hinweis: Bitte kontaktieren Sie den The page DE:Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro für Manual, um die unterschiedlichen Einsatzmöglichkeiten abzuklären. |
TxType | ans..5 | C | Obligatory for Capture=Manual: Transaction type with possible values Order or Auth and BAID (BillingAgreementID) | Pflicht bei Capture=Manual: Transaktionstyp mit den möglichen Werten Order oder Auth sowie BAID (BillingAgreementID) |
PayPalMethod | enum | O | The "shortcut" value selects the changed transaction procedure which takes the customer back to the shop for payment confirmation. You then need to call up the interface paypalcomplete.aspx to complete the sale. | 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 | For repeat payments (subscriptions): In this case only RTF=I is allowed, other subscription payments are carried out via the separate paypalAbo.aspx interface. | Für wiederkehrende Zahlungen (Abos): Hier nur RTF=I zulässig, weitere Abo-Zahlungen werden über die separate Schnittstelle paypalAbo.aspx ausgeführt. |
OrderDesc | ans..127 | M | Description of purchased goods, unit prices etc.
| Beschreibung der gekauften Waren, Einzelpreise etc.
|
OrderDesc(n) | ans..2048 | O | Customers shopping basket in the form: OrderDesc(n)=Name,Amount,Number,Quantity,Description,Tax OrderDesc2 to max. OrderDesc99 permissible For correct execution of displaying function all OrderDesc(n) Amounts must equal to the parameter Amount. | 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 Parameter Amount übereinstimmen. |
TaxTotal | n..10 | C | Mandatory, if +Tax is given in description of OrderDesc(n): Total amount of taxes of all single articles in the smallest currency unit (e.g. EUR Cent) = Sum(Tax*Number) | 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..10 | C | Mandatory, if +tax is given in description of OrderDesc(n): Gross amount of all single articles in the smallest currency unit (e.g. EUR Cent) = Sum(Amount*Number) | 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..10 | O | Shipping costs in the smallest currency unit (e.g. EUR Cent). Can be uses only in connection with parameters ItemTotal and TaxTotal. | Versandkosten in der kleinsten Währungseinheit (z.B. EUR Cent). Kann nur in Verbindung mit den Parametern ItemTotal und TaxTotal verwendet werden. |
| Key | Format | CND | Description |
|---|---|---|---|
| ReqId | ans..32 | O | To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly. Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate. |
| Key | Format | CND | Description |
|---|---|---|---|
| URLSuccess | ans..256 | M | Complete URL which calls up Paygate if payment has been successful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.
|
| Key | Format | CND | Description |
|---|---|---|---|
| URLFailure | ans..256 | M | Complete URL which calls up Paygate if payment has been unsuccessful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.
|
| Key | Format | CND | Description |
|---|---|---|---|
| Response | a7 | O | Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter. |
| Key | Format | CND | Description |
|---|---|---|---|
| URLNotify | ans..256 | M | Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443. It may not contain parameters: Use the UserData parameter instead.
|
| Key | Format | CND | Description |
|---|---|---|---|
| UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. |
Key | Format | CND | Description | Beschreibung |
|---|---|---|---|---|
Account | ans..128 | O | For managing multiple PayPal accounts, Merchant account: ID or e-Mail address for which the request should be submitted to PayPal | 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 | Controls how the PayPal page is displayed. Possible values are “Login” or “Billing” | Steuert, wie die PayPal-Seite angezeigt wird. Mögliche Werte „Login“ oder „Billing“ |
Language | an2 | O | AU, DE, FR, IT, GB, ES, US ; default DE | AU, DE, FR, IT, GB, ES, US; Standard DE |
FirstName | ans..50 | OC | (obligatory for USA and Canada): Either the first name only or first and second name if a company name is used as a delivery address. | (Pflicht für USA und Kanada): Entweder nur der Vorname oder Vor- und Nachname, falls ein Firmenname als Lieferadresse genutzt wird. |
LastName | ans..50 | OC | (obligatory for USA and Canada): Surname or name of the company of the delivery address | (Pflicht für USA und Kanada): Nachname oder Firmenbezeichnung der Lieferadresse |
AddrStreet | ans..100 | OC | (obligatory for USA and Canada): Street in the delivery address | (Pflicht für USA und Kanada): Straßenname der Lieferadresse |
AddrStreet2 | ans..100 | O | 2. Street name in the delivery address that contains additional information e.g. packing station or similar. In order to receive this as a response parameter, it needs to be activated separately by the Computop Helpdesk. | 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 The page DE:Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro aktiviert werden. |
AddrCity | ans..40 | OC | (obligatory for USA and Canada): Town/city in the delivery address | (Pflicht für USA und Kanada): Ortsname der Lieferadresse |
AddrState | ans..40 | OC | (obligatory for USA and Canada): Federal state of the delivery address. The town submitted in AddrCity must be located in the given federal state, otherwise PayPal refused this payment. For possible values please refer to the PayPal-API-reference documentation. | (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 | (obligatory for USA and Canada): Postcode in the delivery address | (Pflicht für USA und Kanada): Postleitzahl der Lieferadresse |
AddrCountryCode | an2 | O | Country code of the delivery country | Ländercode des Lieferlandes |
Phone | n..20 | O | Telephone number | Telefonnummer |
NoShipping | n1 | O | Handover NoShipping=1 prevents the delivery address registered with Paypal from being displayed. Computop Paygate also offers the option to permanently suppress the delivery address for you on your MID. Please note that the delivery address should only be suppressed in the case of digital goods, as the seller protection is also linked to this. Please contact the Computop Helpdesk for this. | Übergabe NoShipping=1 verhindert die Anzeige der bei PayPal hinterlegten Lieferadresse. Zusätzlich bietet das The page DE:Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro 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 The page DE:Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro. |
AllowNote | ans..2 | O | The value “no” prevents the option of sending a message to the merchant. As standard a possible message is returned in the Infotext parameter. | Wert „no“ verhindert die Möglichkeit, eine Nachricht an den Händler zu übermitteln. Standardmäßig wird eine eventuelle Mitteilung im Parameter Infotext zurückgegeben. |
BuyerEMail | ans..127 | OC | Pre-completion of an email address on the PayPal login page | Vorbelegung einer E-Mail-Adresse auf der Login-Seite von PayPal |
NoteToBuyer | ans..165 | O | Notice for the buyer | Hinweistext für den Käufer |
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 | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
Key | Format | CND | Description | Beschreibung | |
|---|---|---|---|---|---|
Status | a..30 | M | OK, AUTHORIZE_REQUEST or Timeout (only if Capture=Manual) on the URLSuccess page or FAILED on the URLFailure page. AUTHORIZE_REQUEST – Is returned actively only for request parameter "TxType=auth" or "PayPalMethod=shortcut". When using TxType=auth or without TxType the final status is returned directly. | 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. | |
| Key | Format | CND | Description |
|---|---|---|---|
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
| Key | Format | CND | Description |
|---|---|---|---|
| refnr | ans..30 | O | Merchant’s unique reference number |
| Key | Format | CND | Description |
|---|---|---|---|
| UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. |
| Key | Format | CND | Description |
|---|---|---|---|
| CodeExt | n..10 | O | Error code from external partner. Needs to be agreed with Computop Helpdesk. |
Key | Format | CND | Description | Beschreibung | |
|---|---|---|---|---|---|
Name | ans..32 | M | First name and surname joined | Vorname und Nachname zusammengenommen | |
| Firstname | ans..50 | M | First name of payer (PayerInfo, may differ from the account name) | Vorname vom Bezahler (PayerInfo, kann vom Account-Namen abweichen) | |
| Lastname | ans..50 | M | Last name of payer (PayerInfo, may differ from the account name) | Nachname vom Bezahler (PayerInfo, kann vom Account-Namen abweichen) | |
ans..100 | M | Email address of the purchaser. | E-Mail-Adresse des Käufers. | ||
AddrStreet | ans..100 | O | Street in the delivery address | Straßenname der Lieferadresse | |
AddrStreet2 | ans..100 | O | 2. Street name in the delivery address that contains additional information e.g. packing station or similar. In order to receive this as a response parameter, it needs to be activated separately by the Computop Helpdesk. | 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 The page DE:Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro aktiviert werden. | |
AddrCity | ans..40 | O | Town/city in the delivery address | Ortsname der Lieferadresse | |
AddrState | ans..40 | O | Federal State in the delivery address | Bundesland (Bundesstaat) der Lieferadresse | |
AddrZIP | ans..20 | O | Postcode in the delivery address | Postleitzahl der Lieferadresse | |
AddrCountryCode | an2 | O | Country code of the delivery country | Ländercode des Lieferlandes | |
Phone | n..20 | O | Telephone number | Telefonnummer | |
BillingAgreementID | an19 | M | Identification number of the invoice agreement. When the buyer confirms the invoice agreement it is validated and remains valid until revoked by the buyer. | 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. | |
BillingName | ans..32 | O | First name and surname joined | Vorname und Nachname zusammengenommen | |
BillingAddrStreet | ans..100 | O | Street name of the invoicing address lodged with PayPal | Straßenname der bei PayPal hinterlegten Rechnungsadresse | |
BillingAddrStreet2 | ans..100 | O | 2. Street name of the invoicing address lodged with PayPal that contains additional information e.g. packing station or similar. In order to receive this as a response parameter, it needs to be activated separately by the Computop Helpdesk. | 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 The page DE:Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro aktiviert werden. | |
BillingAddrCity | ans..40 | O | Town/city name of the invoicing address saved with PayPal | Ortsname der bei PayPal hinterlegten Rechnungsadresse | |
BillingAddrState | ans..40 | O | Federal state of the invoicing address saved with PayPal | Bundesland der bei PayPal hinterlegten Rechnungsadresse | |
BillingAddrZIP | ans..20 | O | Postcode of the invoicing address saved with PayPal | Postleitzahl der bei PayPal hinterlegten Rechnungsadresse | |
BillingAddrCountryCode | an2 | O | Country code of the delivery country | Ländercode des Lieferlandes | |
TransactionID | an..19 | O | Unique transaction number from PayPal for a transaction (PayPal Order) | Eindeutige Transaktionsnummer von PayPal für eine Transaktion (PayPal Order) | |
| TID | an..19 | O | Unique transaction number from PayPal for an authorisation (PayPal Auth): Only for automatic PayPal configuration or if TxType=Auth | Eindeutige Transaktionsnummer von PayPal für eine Autorisierung (PayPal Auth): Nur bei automatischer PayPal-Konfiguration oder sonst wenn TxType=Auth | |
| payerStatus | an..10 | O | Status of buyer with possible values "verified" or "unverified" | Status des Käufers mit den möglichen Werten "verified" oder "unverified" | |
InfoText | ans..255 | M | Message to the merchant | Nachricht an den Händler | |
PayerID | ans..13 | O | Unique identification number of customer account at PayPal. (Additional response has to be first activated. Please contact the Computop Helpdesk, if you need the additional values in the response) | Eindeutige Identifikationsnummer des Kundenkontos bei PayPal. (Die Rückgabe dieses Parameters muss aktiviert werden. Bitte wenden Sie sich an den The page DE:Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro, wenn Sie diesen Wert in der Antwort benötigen.) | |
GrossAmount | an..9 | O | Final amount charged, including any shipping and taxes from your Merchant Profile | Endgültig berechneter Betrag einschließlich Lieferkosten und Steuern von Ihrem Händlerprofil | |
FeeAmount | an..9 | O | PayPal fee amount charged for the transaction | Betrag der für die Transaktion berechneten PayPal-Gebühr | |
SettleAmount | an..9 | O | Amount deposited in your PayPal account after a currency conversion | Ihrem PayPal-Konto nach einer Währungsumrechnung gutgeschriebener Betrag | |
TaxAmount | an..9 | O | Tax charged on the transaction | Für die Transaktion berechnete Steuer | |
ExchangeRate | an..17 | O | Exchange rate if a currency conversion occurred. Relevant only if you are billing in their non-primary currency. If the buyer chooses to pay with a currency other than the non-primary currency, the conversion occurs in the buyer's account | 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 | Only in case of separate Notify from PayPal: Transaction fee associated with the payment. mc_gross minus mc_fee equals the amount deposited into the receiver_email account. Equivalent to payment_fee for USD payments. If this amount is negative, it signifies a refund or reversal, and either of those payment statuses can be for the full or partial amount of the original transaction fee | 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 | Only in case of separate Notify from PayPal: Full amount of the customer's payment, before transaction fee is subtracted. Equivalent to payment_gross for USD payments. If this amount is negative, it signifies a refund or reversal, and either of those payment statuses can be for the full or partial amount of the original transaction. | 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. Um im nächsten Schritt diese PayPal-Zahlung abzuschließen, nutzen Sie folgende URL und Parameter:
https://www.computop-paygate.com/paypalComplete.aspx |
Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table. Please note the global PayPal supported currencies at https://developer.paypal.com/api/rest/reference/currency-codes/. |
| Key | Format | CND | Description |
|---|---|---|---|
| refnr | ans..30 | O | Merchant’s unique reference number |
Key | Format | CND | Description | Beschreibung |
|---|---|---|---|---|
PayID | an32 | M | ID assigned by Paygate for the payment. Enter the PayID from the response from paypal.aspx received in the previous transaction procedure. | Vom Paygate vergebene ID für die Zahlung. Übergeben Sie hier die PayID aus der Antwort von paypal.aspx, die Sie im bisherigen Transaktionsablauf erhalten haben. |
OrderDesc(n) | ans..2048 | O | Customers shopping basket in the form: OrderDesc(n)=Name,Amount,Number,Quantity,Description,Tax OrderDesc2 to max. OrderDesc99 permissible For correct execution of displaying function all OrderDesc(n) Amounts must equal to the parameter Amount.
Notice: If OrderDesc(n) is changed also the Amount has to be modified. | 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 Parameter Amount übereinstimmen.
Hinweis: Bei Änderung von OrderDesc(n) muss auch der Amount angepasst werden. |
FirstName | ans..50 | C | Mandatory in order to transfer address information Either the first name only or first and second name if a company name is used as a delivery address. | Pflicht, um Adressangaben zu übermitteln: Entweder nur der Vorname oder Vor- und Nachname, falls ein Firmenname als Lieferadresse genutzt wird. |
LastName | ans..50 | C | Obligatory if FirstName is transmitted: Surname or name of the company of the delivery address | Pflicht, wenn FirstName übergeben wird: Nachname oder Firmenbezeichnung der Lieferadresse |
AddrStreet | ans..100 | C | Obligatory if FirstName is transmitted: Street in the delivery address | Pflicht, wenn FirstName übergeben wird: Straßenname der Lieferadresse |
AddrStreet2 | ans..100 | C | Obligatory if FirstName is transmitted: 2. Street name in the delivery address that contains additional information e.g. packing station or similar. In order to receive this as a response parameter, it needs to be activated separately by the Computop Helpdesk. | 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 The page DE:Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro aktiviert werden. |
AddrCity | ans..40 | C | Obligatory if FirstName is transmitted: Town/city in the delivery address | Pflicht, wenn FirstName übergeben wird: Ortsname der Lieferadresse |
AddrState | ans..40 | C | Obligatory if FirstName is transmitted: Federal state of the delivery address. The town submitted in AddrCity must be located in the given federal state, otherwise PayPal refused this payment. For possible values please refer to the PayPal-API-reference documentation. | 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 | Obligatory if FirstName is transmitted: Postcode in the delivery address | Pflicht, wenn FirstName übergeben wird: Postleitzahl der Lieferadresse |
AddrCountryCode | an2 | C | Obligatory if FirstName is transmitted: Country code of the delivery country | Pflicht, wenn FirstName übergeben wird: Ländercode des Lieferlandes |
Phone | n..20 | C | Obligatory if FirstName is transmitted: Telephone number | 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 | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
| Key | Format | CND | Description |
|---|---|---|---|
| refnr | ans..30 | O | Merchant’s unique reference number |
| Key | Format | CND | Description |
|---|---|---|---|
| CodeExt | n..10 | O | Error code from external partner. Needs to be agreed with Computop Helpdesk. |
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 folgende URL:
https://www.computop-paygate.com/Authorize.aspx |
Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table. Please note the global PayPal supported currencies at https://developer.paypal.com/api/rest/reference/currency-codes/. |
Key | Format | CND | Description | Beschreibung |
|---|---|---|---|---|
TxType | ans..5 | M | Transaction type Auth | Transaktionstyp Auth |
FirstName | ans..50 | O | Either the first name only or first and second name if a company name is used as a delivery address. | Entweder nur der Vorname oder Vor- und Nachname, falls ein Firmenname als Lieferadresse genutzt wird. |
LastName | ans..50 | O | Surname or name of the company of the delivery address | Nachname oder Firmenbezeichnung der Lieferadresse |
AddrStreet | ans..100 | O | Street in the delivery address | Straßenname der Lieferadresse |
AddrStreet2 | ans..100 | O | 2. Street name in the delivery address that contains additional information e.g. packing station or similar. In order to receive this as a response parameter, it needs to be activated separately by the Computop Helpdesk. | 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 The page DE:Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro aktiviert werden. |
AddrCity | ans..40 | O | Town/city in the delivery address | Ortsname der Lieferadresse |
AddrState | ans..40 | O | Federal state of the delivery address. The town submitted in AddrCity must be located in the given federal state, otherwise PayPal refused this payment. For possible values please refer to the PayPal-API-reference documentation. | 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 | Postcode in the delivery address | Postleitzahl der Lieferadresse |
AddrCountryCode | an2 | O | Country code of the delivery country | Ländercode des Lieferlandes |
Phone | n..20 | O | Telephone number | 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 | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
| Key | Format | CND | Description |
|---|---|---|---|
| CodeExt | n..10 | O | Error code from external partner. Needs to be agreed with Computop Helpdesk. |
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, 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:
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table. Please note the global PayPal supported currencies at https://developer.paypal.com/api/rest/reference/currency-codes/. |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
| Key | Format | CND | Description |
|---|---|---|---|
| ReqId | ans..32 | O | To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly. Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate. |
Key | Format | CND | Description | Beschreibung |
|---|---|---|---|---|
RefNr | ans..30 | O | Merchant reference number: here a separate reference number, e.g. an invoice number, can be transferred | Referenznummer des Händlers: hier kann eine separate Referenznummer wie z.B. Rechnungsnummer übergeben werden |
TID | ans..17 | O | PayPal unique transaction number Required for part postings to previous authorisations. | Eindeutige Transaktionsnummer bei PayPal. Notwendig bei Teilbuchungen auf vorangegangene Autorisierungen. |
CompleteType | ans..3 | O | If <YES> is transferred, the possible open order of PayPal is closed on capture. (Reason: a 115% capture is permissible on the part of PayPal. If a capture reached 100%, Paygate automatically sends a request to close the payment). | 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 The page DE:Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro automatisch einen Aufruf zum Schließen der Zahlung an PayPal.) |
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 | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
| Key | Format | CND | Description |
|---|---|---|---|
| CodeExt | n..10 | O | Error code from external partner. Needs to be agreed with Computop Helpdesk. |
Key | Format | CND | Description | Beschreibung | |
|---|---|---|---|---|---|
| TID | ans..17 | O | PayPal unique transaction number. Required for part postings to previous authorisations. | Eindeutige Transaktionsnummer bei PayPal. Notwendig bei Teilbuchungen auf vorangegangene Autorisierungen. | |
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:
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 | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table. Please note the global PayPal supported currencies at https://developer.paypal.com/api/rest/reference/currency-codes/. |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
| Key | Format | CND | Description |
|---|---|---|---|
| ReqId | ans..32 | O | To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly. Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate. |
Key | Format | CND | Description | Beschreibung |
|---|---|---|---|---|
RefNr | ans..30 | O | Merchant reference number: here a separate reference number, e.g. an invoice number, can be transferred | Referenznummer des Händlers: hier kann eine separate Referenznummer wie z.B. Rechnungsnummer übergeben werden |
TID | ans..17 | O | PayPal unique transaction number Required for part credit notes to prior partial captures. | Eindeutige Transaktionsnummer bei PayPal. Notwendig bei Teilgutschriften auf vorangegangene Teilbuchungen. |
Note | ans..768 | C | Explanatory text for recipient | Hinweistext für Empfänger |
Subject | ans..255 | C | MassPay: E-Mail subject to recipient If you want to use the MassPay functionality, please contact the Computop Helpdesk to activate this function for you. | MassPay: Betreff für E-Mail an Empfänger Wenn Sie die MassPay-Funktionalität nutzen möchten, wenden Sie sich bitte an den The page DE:Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro, 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 | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
| Key | Format | CND | Description |
|---|---|---|---|
| CodeExt | n..10 | O | Error code from external partner. Needs to be agreed with Computop Helpdesk. |
Key | Format | CND | Description | Beschreibung | |
|---|---|---|---|---|---|
| TID | ans..17 | O | PayPal unique transaction number. Required for part postings to previous authorisations. | Eindeutige Transaktionsnummer bei PayPal. Notwendig bei Teilbuchungen auf vorangegangene Autorisierungen. | |
FeeRefundAmount | n..10 | O | The refunded amount of the PayPal transaction fees. Required for part credit notes to prior partial captures. | Gutgeschriebener Betrag der PayPal-Transaktionsgebühren. Notwendig bei Teilgutschriften auf vorangegangene Teilbuchungen. | |
GrossRefundAmount | n..10 | O | Amount refunded to the buyer in this refund transaction. Required for part credit notes to prior partial captures. | Gutgeschriebener Betrag an den Käufer bei dieser Gutschrift. Notwendig bei Teilgutschriften auf vorangegangene Teilbuchungen. | |
NetRefundAmount | n..10 | O | Amount deducted from your PayPal account to make this refund. Required for part credit notes to prior partial captures. | 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, verwenden Sie bitte folgende URL und Parameter:
https://www.computop-paygate.com/paypalcreditEx.aspx |
Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table. Please note the global PayPal supported currencies at https://developer.paypal.com/api/rest/reference/currency-codes/. |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
| Key | Format | CND | Description |
|---|---|---|---|
| ReqId | ans..32 | O | To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly. Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate. |
| Key | Format | CND | Description |
|---|---|---|---|
| refnr | ans..30 | O | Merchant’s unique reference number |
Key | Format | CND | Description | Beschreibung |
|---|---|---|---|---|
| Account | ans..128 | O | For managing multiple PayPal accounts, Merchant account: ID or e-Mail address for which the request should be submitted to PayPal | 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: Explanatory text for recipient If you want to use the MassPay functionality, please contact the Computop Helpdesk to activate this function for you. | MassPay: Hinweistext für Empfänger Wenn Sie die MassPay-Funktionalität nutzen möchten, wenden Sie sich bitte an den The page DE:Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro, um diese Funktion für Sie zu aktivieren. |
Subject | ans..255 | C | MassPay: E-Mail subject to recipient If you want to use the MassPay functionality, please contact the Computop Helpdesk to activate this function for you. | MassPay: Betreff für E-Mail an Empfänger Wenn Sie die MassPay-Funktionalität nutzen möchten, wenden Sie sich bitte an den The page DE:Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro, um diese Funktion für Sie zu aktivieren. |
Payer | ans..100 | O | MassPay: Email address of the purchaser If you want to use the MassPay functionality, please contact the Computop Helpdesk to activate this function for you. | MassPay: E-Mail-Adresse des Käufers Wenn Sie die MassPay-Funktionalität nutzen möchten, wenden Sie sich bitte an den The page DE:Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro, um diese Funktion für Sie zu aktivieren. |
Parameter für PayPal-Gutschriften ohne 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 | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
| Key | Format | CND | Description |
|---|---|---|---|
| CodeExt | n..10 | O | Error code from external partner. Needs to be agreed with Computop Helpdesk. |
Key | Format | CND | Description | Beschreibung | |
|---|---|---|---|---|---|
FeeRefundAmount | n..10 | O | The refunded amount of the PayPal transaction fees. Required for part credit notes to prior partial captures. | Gutgeschriebener Betrag der PayPal-Transaktionsgebühren. Notwendig bei Teilgutschriften auf vorangegangene Teilbuchungen. | |
GrossRefundAmount | n..10 | O | Amount refunded to the buyer in this refund transaction. Required for part credit notes to prior partial captures. | Gutgeschriebener Betrag an den Käufer bei dieser Gutschrift. Notwendig bei Teilgutschriften auf vorangegangene Teilbuchungen. | |
NetRefundAmount | n..10 | O | Amount deducted from your PayPal account to make this refund. Required for part credit notes to prior partial captures. | 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, verwenden Sie bitte folgende URL und Parameter:
https://www.computop-paygate.com/reverse.aspx |
Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
ans..30 MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. an32 ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. ans..64 Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). a3 Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table. Please note the global PayPal supported currencies at https://developer.paypal.com/api/rest/reference/currency-codes/. an64 ans..32 To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly. Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate. Key Format CND Description TID ans..17 O PayPal unique transaction number. Required for part cancellations of prior part authorisations.Key Format CND Description M Key Format CND Description PayID M Key Format CND Description TransID M TransactionID provided by you which should be unique for each payment Key Format CND Description Amount n..10 M Key Format CND Description Currency M Key Format CND Description M Key Format CND Description ReqId O Beschreibung Eindeutige Transaktionsnummer bei PayPal. Notwendig bei Teilstornierungen auf vorangegangene Teilautorisierungen.
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 | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
| Key | Format | CND | Description |
|---|---|---|---|
| CodeExt | n..10 | O | Error code from external partner. Needs to be agreed with Computop Helpdesk. |
Key | Format | CND | Description | Beschreibung | |
|---|---|---|---|---|---|
| TID | ans..17 | O | PayPal unique transaction number. Required for part cancellations of prior part authorisations. | Eindeutige Transaktionsnummer bei PayPal. Notwendig bei Teilstornierungen auf vorangegangene Teilautorisierungen. | |
Ergebnis-Parameter für PayPal-Stornierungen
Aufruf der Schnittstelle für Abonnements
Voraussetzungen
- Die Option „Reference Transaction“ muss bei PayPal eingerichtet sein. Bitten Sie PayPal direkt um die Aktivierung.
- Bitte konfigurieren Sie zusätzlich die entsprechende Genehmigung in Ihrem Paypal-Händlerkonto
- Belasten bestehender Kunden auf der Grundlage einer früherer Transaktion
- Einholen der Autorisierung und initiieren von PayPal-Zahlungen per Händleranbindung
- Die Option „Reference Transaction“ muss für Ihre Computop MerchantID eingerichtet sein.
Ablauf
- Zur Erstellung eines Abos wird zuerst eine normale PayPal-Zahlung mit dem zusätzlichen Parameter „RTF=I“ initiiert. Dies fügt ein Abo-Flag an die Transaktion an, damit diese von PayPal wiedererkannt wird. Möchten Sie in dem ersten Request nur die „BillingAgreementID“ holen, ohne dem Kunden einen Betrag anzuzeigen, übermitteln Sie bitte an das Paygate den Parameter "txtype=BAID". Wird der txtype=BAID gesendet, wird der eingereichte Betrag vom Paygate automatisch auf 0,00 gesetzt.
Bitte beachten Sie, dass der Händler auf gar keinen Fall einen Betrag von 0,00€ senden darf, dies kann unser Paygate nicht verarbeiten.
D.h. der Händler muss einen Betrag X >0,00 übertragen und wir setzen diesen dann in Richtung PayPal auf 0,00. - Unsere Response an den Händler enthält die normalen PayPal-Parameter sowie den zusätzlichen Parameter „BillingAgreementID“. Dieser muß in deren System an der Zahlung hinterlegt werden.
- Zur Erstellung der zweiten/wiederkehrenden Abo-Zahlung verwenden Sie bitte die URL https://www.computop-paygate.com/paypalAbo.aspx durchgeführt werden. In dieser Server-zu-Server-Verbindung verwenden Sie bitte die normalen PayPal-Parameter zuzüglich des Parameters „BillingAgreementID“. Der zusätzliche Parameter löst die zweite/wiederkehrende Zahlung mit Bezug auf die ursprüngliche Zahlung aus Auf diese Weise ist kein Login des PayPal-Kunden notwendig und Sie können Beträge von dessen Konto abbuchen.
Hinweis
- Folgender Zusatz wird während des Bezahlprozesses im PayPal Account des Kunden angezeigt (Beispiel):
"Hiermit genehmigen Sie –Händlername–, künftige Zahlungen direkt und ohne Ihr Zutun von Ihrem PayPal-Konto abzubuchen. Sie können diese Genehmigung für die Zukunft jederzeit in Ihrem Profil widerrufen." - Der Kunde kann sich in seinem PayPal Account über diese Funktion informieren.
Capture on demand (capture=manual + txtype=Order oder Auth)
- Wenn die initiale Zahlung mit txtype=Order oder Auth ausgeführt wird, sendet Computop Paygate die „BillingAgreementID“ bereits im Notify auf diese Aktion mit zurück. Beim darauffolgenden Capture muss diese nicht mitgegeben werden, nur wenn wirklich ein komplett neues Payment ausgelöst wird.
Löschen der BillingAgreementID
- Grundsätzlich kann ein Kunde die generierte BillingAgreementID in seinem PayPal-Konto löschen/stornieren. Eine Info darüber kann ein Händler nur erhalten, wenn die zusätzliche Option IPN “instant payment notification” für sein Konto aktiviert ist. Diese Aktivierung muss sowohl im Konto bei Computop als auch bei PayPal erfolgen. Bitte beachten Sie, dass der Händler bei aktiviertem IPN auch Meldungen zu jeder Statusänderung einer PayPal-Zahlung erhält.
- Wenn ein Kunde die BillingAgreementID löscht, sind weitere Zahlungen mit dieser ID nicht mehr möglich. Eine gelöschte BillingAgreementID kann nicht mehr aktiviert werden.
Zahlungsabwicklung für Abonnements
Die Abwicklung von PayPal-Zahlungen per Abonnement setzt eine Initial-Transaktion voraus, die über die übliche Schnittstelle abgewickelt worden ist. Zudem muss die Möglichkeit von Abonnements zuvor sowohl bei PayPal als auch bei Computop aktiviert worden sein. Dazu muss die Option „Reference Transaction“ bei Computop und bei PayPal eingerichtet sein. Zudem sind im Bereich „Verfügbare Genehmigungen“ bei der Einrichtung (siehe Kapitel PayPal-API freigeben oben) folgende 3 Optionen zu aktivieren:
- Belasten bestehender Kunden auf der Grundlage früherer Transaktionen
- Erstellen und Verwalten von Abonnementzahlungen
- Einholen der Autorisierung und Initiierung von PayPal-Zahlungen per Händlerabbuchung
Um eine PayPal-Zahlung per Abonnement abzuwickeln, nutzen Sie folgende URL und Parameter:
https://www.computop-paygate.com/paypalAbo.aspx |
Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table. Please note the global PayPal supported currencies at https://developer.paypal.com/api/rest/reference/currency-codes/. |
| Key | Format | CND | Description |
|---|---|---|---|
| refnr | ans..30 | O | Merchant’s unique reference number |
Key | Format | CND | Description | Beschreibung |
|---|---|---|---|---|
OrderDesc | ans..30 | Description of purchased goods, unit prices etc. | Beschreibung der gekauften Waren, Einzelpreise etc. | |
Capture | a..6 | M | Auto or Manual determines whether the requested amount is settled immediately or at a later stage. Important Note: Please contact Computop Helpdesk for Manual, to discuss different possibilities of usage. | Auto oder Manual: bestimmt, ob der angefragte Betrag sofort oder erst später abgebucht wird. Wichtiger Hinweis: Bitte kontaktieren Sie den The page DE:Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro für Manual, um die unterschiedlichen Einsatzmöglichkeiten abzuklären. |
TxType | ans..5 | M | Obligatory for Capture=Manual: Transaction type with possible values Order and Auth | Pflicht bei Capture=Manual: Transaktionstyp mit den möglichen Werten Order sowie Auth |
BillingAgreementID | an19 | M | Identification number of the invoice agreement. When the buyer confirms the invoice agreement it is validated and remains valid until revoked by the buyer. | 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. |
RTF | ans1 | O | For repeat payments (subscriptions): | Bei wiederkehrenden Zahlungen (Abos): |
FirstName | ans..50 | OC | (obligatory for USA and Canada): Either the first name only or first and second name if a company name is used as a delivery address. | (Pflicht für USA und Kanada): Entweder nur der Vorname oder Vor- und Nachname, falls ein Firmenname als Lieferadresse genutzt wird. |
LastName | ans..50 | OC | (obligatory for USA and Canada): Surname or name of the company of the delivery address | (Pflicht für USA und Kanada): Nachname oder Firmenbezeichnung der Lieferadresse |
AddrStreet | ans..100 | OC | (obligatory for USA and Canada): Street in the delivery address | (Pflicht für USA und Kanada): Straßenname der Lieferadresse |
AddrCity | ans..40 | OC | (obligatory for USA and Canada): Town/city in the delivery address | (Pflicht für USA und Kanada): Ortsname der Lieferadresse |
AddrState | ans..40 | OC | (obligatory for USA and Canada): Federal state of the delivery address. The town submitted in AddrCity must be located in the given federal state, otherwise PayPal refused this payment. For possible values please refer to the PayPal-API-reference documentation. | (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 | (obligatory for USA and Canada): Postcode in the delivery address | (Pflicht für USA und Kanada): Postleitzahl der Lieferadresse |
AddrCountryCode | an2 | O | Country code of the delivery country | Ländercode des Lieferlandes |
Phone | n..20 | O | Telephone number | Telefonnummer |
Parameter für PayPal-Abonnements
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 | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
| Key | Format | CND | Description |
|---|---|---|---|
| CodeExt | n..10 | O | Error code from external partner. Needs to be agreed with Computop Helpdesk. |
Key | Format | CND | Description | Beschreibung | |
|---|---|---|---|---|---|
| BillingAgreementID | an19 | M | Identification number of the invoice agreement. When the buyer confirms the invoice agreement it is validated and remains valid until revoked by the buyer. | 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. | |
Ergebnis-Parameter für PayPal-Abonnements
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 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>) PAYPAL,ABO,<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 | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table. Please note the global PayPal supported currencies at https://developer.paypal.com/api/rest/reference/currency-codes/. |
Key | Format | CND | Description | Beschreibung |
|---|---|---|---|---|
Type | a..11 | M | HEAD for Header, FOOT for Footer, PAYPAL for PayPal | HEAD für Header, FOOT für Footer, PAYPAL für PayPal |
Action | a..20 | M | The parameter Action defines the type of transaction: Authorize Reverse (cancellation) | Der Action-Parameter definiert die Art der Transaktion: Authorize (Autorisierung) Reverse (Storno) |
RefNr | ans..30 | O | Unique reference number | eindeutige Referenznummer |
payer | ans..100 | O | MassPay: Email address of the purchaser: In this case you transfer the received email parameter from the Response If you want to use the MassPay functionality, please contact the Computop Helpdesk to activate this function for you. | MassPay: E-Mail-Adresse des Käufers: Übergeben Sie hier den erhaltenen Parameter E-Mail aus der Response Wenn Sie die MassPay-Funktionalität nutzen möchten, wenden Sie sich bitte an den The page DE:Wording (veraltet) was not found -- Please check/update the page name used in the MultiExcerpt-Include macro, um diese Funktion für Sie zu aktivieren. |
note | ans..758 | O | Explanatory text for recipient | Hinweistext für Empfänger |
TID | ans..17 | O | PayPal unique transaction number Required for a number of authorisations or part captures, part credit notes or part cancellations. | Eindeutige Transaktionsnummer bei PayPal. Notwendig bei mehreren Autorisierungen oder Teilbuchungen, Teilgutschriften, Teilstornierungen. |
OrderDesc | ans..127 | O | Description of purchased goods, unit prices etc. | Beschreibung der gekauften Waren, Einzelpreise etc. |
Capture | a..6 | O | Auto or Manual: determines whether the requested amount is settled immediately or at a later stage. | Auto oder Manual: bestimmt, ob der angefragte Betrag sofort oder erst später abgebucht wird. |
TxType | ans..5 | OC | Obligatory for Capture=Manual: Transaction type with possible values Order and Auth | Pflicht bei Capture=Manual: Transaktionstyp mit den möglichen Werten Order sowie Auth |
BillingAgreementID | an19 | M | Identification number of the invoice agreement. When the buyer confirms the invoice agreement it is validated and remains valid until revoked by the buyer. | 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. |
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> PAYPAL,ABO,<Amount>,<Currency>,<TransID>,(<RefNr>),(<OrderDesc>),(<Capture>),(<TxType>,)<BillingAgreementId>,<CodeExt>,<PayID>,<Status>,<Code> 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 | Description | Beschreibung |
|---|---|---|---|---|
Action | a..20 | M | The parameter Action defines the type of transaction like capture or credit. | Der Action-Parameter definiert die Art der Transaktion wie Capture (Buchung) oder Credit (Gutschrift). |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
| Key | Format | CND | Description |
|---|---|---|---|
| CodeExt | n..10 | O | Error code from external partner. Needs to be agreed with Computop Helpdesk. |
Beschreibung der Ergebnis-Parameter im Datensatz von Batch-Dateien

















