Über PayPal


Logo

Info

Computop wickelt PayPal-Zahlungen ab, die Ihnen weltweiten Verkäuferschutz sowie ein Potenzial von 425 Millionen internationalen Kunden in über 200 Märkten bieten.

PayPal gehört zu den beliebtesten Online-Zahlungsmitteln und kann im E- und M-Commerce eingesetzt werden.

TypZahlungen per eWallet

Auf dieser Seite



Paygate-Schnittstelle

Definitionen

Datenformate:

FormatBeschreibung

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)


Abkürzungen:

AbkürzungBeschreibungKommentar

CND

Bedingung (condition)


M

Pflicht (mandatory)

Wenn ein Parameter Pflicht ist, dann muss er vorhanden sein

O

optional

Wenn ein Parameter optional ist, dann kann er vorhanden sein, ist aber nicht erforderlich

C

bedingt (conditional)

Wenn ein Parameter bedingt ist, dann gibt es eine Bedingungsregel, die angibt, ob er Pflicht oder optional ist


Hinweis: Bitte beachten Sie, dass die Bezeichnungen der Parameter in Groß- oder Kleinbuchstaben zurückgegeben werden können.


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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

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

KeyRESTFormatCNDDescriptionBeschreibung
TransID"transactionId": "..."

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyRESTFormatCNDDescriptionBeschreibung
refnr"referenceNumber": "..."

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

Key

REST

Format

CND

Description

Beschreibung

Amount

"amount": { "value": ...}

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).

If OrderDesc(n) is used, there must be valid: Amount=ItemTotal+TaxTotal+SHAmount.

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

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "currency": "..."}

a3

M

Currency, three digits 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/.

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/.

KeyRESTFormatCNDDescriptionBeschreibung

MAC

---

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

REST

Format

CND

Description

Beschreibung

Capture

"capture": {"auto": "Yes"}

"capture": {"manual": "Yes"}

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 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.

TxType

"payment": {"card": { "transactionType": "Order" }}

"payment": {"card": { "transactionType": "Auth" }}

"payment": {"card": { "transactionType": "BAID" }}

ans..5

C

Obligatory for Capture=Manual: Transaction type with possible values Order or Auth.

For initial Billing Agreement transaction (Billing Agreement creation) TxType=BAID. In case TxType=BAID, all parameters except the following are optional. RefNr MUST be unique for each Billing Agreement creation transaction.

  • MerchantID
  • TransID
  • RefNr
  • Amount
  • Currency
  • OrderDesc
  • TxType
  • URLSuccess
  • URLFailure
  • URLNotify
  • MAC

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.

  • MerchantID
  • TransID
  • RefNr
  • Amount
  • Currency
  • OrderDesc
  • TxType
  • URLSuccess
  • URLFailure
  • URLNotify
  • MAC

PayPalMethod

"payment": {"payPal": { "method": "..." }}

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

Reserved for future useFür zukünftige Verwendung reserviert

OrderDesc

"order": {"description": "..."}

ans..127

M

Description of purchased goods, unit prices etc.

Beschreibung der gekauften Waren, Einzelpreise usw.

OrderDesc(n)

"order": {"items": "..."}

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 Paygate parameter Amount.

Warenkorb des Kunden im Format:

OrderDesc(n)=Name,Amount,Number,Quantity,Description,Tax

OrderDesc2 bis max. OrderDesc99 zulässig

Zur korrekten Ausführung der Anzeigefunktion müssen alle OrderDesc(n) Amounts gleich dem Paygate-Parameter Amount sein.

TaxTotal

"amount": {"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 +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

"amount": {"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 +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

"amount": {"shippingTotal": ...}

n..10

C

Shipping costs in the smallest currency unit (e.g. EUR Cent). Can be used only in case ShAmount <> 0 and connection with parameters ItemTotal and TaxTotal.

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.

KeyRESTFormatCNDDescriptionBeschreibung
URLSuccess"urls": {"success": "..."}

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.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

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.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

KeyRESTFormatCNDDescriptionBeschreibung
URLFailure"urls": {"failure": "..."}

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.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Vollständige URL, die das Paygateaufruft, 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.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

KeyRESTFormatCNDDescriptionBeschreibung
Response

---

a7

O

Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.

Die Status-Rückmeldung, die das Paygate an URLSuccess und URLFailure sendet, sollte verschlüsselt werden. Dazu übergeben Sie den Parameter Response=encrypt.

KeyRESTFormatCNDDescriptionBeschreibung
URLNotify"urls": {"notify": "..."}

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.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

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.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

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

KeyRESTFormatCNDDescriptionBeschreibung
ReqId"requestId": "..."

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.

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

REST

Format

CND

Description

Beschreibung

Account

"payment": {"payPal": { "accountId": "..." }}

ans..128

O

For managing multiple PayPal accounts, Merchant account: ID or e-Mail address for which the request should be submitted to PayPal
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"language": "..."an2O

Language: AU, DE, FR, IT, GB, ES, US; default DE

If you would like to control the language for the customer on the PayPal login page, please note the sequence of checks at PayPal and how to influence the language accordingly.

  1. The user cookie is primary with PayPal. If this is set it overwrites everything (if the browser language is German, then this always has priority).
  2. The parameter Localcode parameter Language on Paygate with a 5 digit ISO code (fr_FR). Please see PayPal documentation: https://developer.paypal.com/reference/locale-codes/.
  3. The parameter ShipToCountry from the delivery address (if a delivery address is transferred)
  4. The parameter Localcode parameter Language on Paygate with a 2 digit ISO code (FR)
  5. The country code of the PayPal account. Please note, this takes place when the customer has logged into his PayPal account. At this point, the language can no longer be actively controlled.

Sprache: AU, DE, FR, IT, GB, ES, US; Standardwert 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.

  1. Das User-Cookie ist bei PayPal primär. Wenn dieses gesetzt ist, überschreibt es alles (ist die Browsersprache auf Deutsch, dann hat diese immer Vorrang).
  2. Der Parameter localcode Parameter Language am Paygate mit einem 5-stelligen ISO-Code (fr_FR). Bitte beachten Sie die PayPal-Dokumentation: https://developer.paypal.com/reference/locale-codes/.
  3. Der Parameter ShipToCountry aus der Lieferadresse (sofern eine Lieferadresse übergeben wird)
  4. Der Parameter Localcode Parameter Language am Paygate mit einem 2-stelligen Ländercode (FR)
  5. Der Ländercode des PayPal-Kontos. Bitte beachten Sie, dass dies erfolgt, wenn sich der Kunde an seinem PayPal-Konto angemeldet hat. Zu diesem Zeitpunkt kann die Sprache nicht mehr aktiv gesteuert werden.

FirstName

"billing": {"consumer": { "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, wenn ein Firmenname als Lieferadresse verwendet wird.

LastName

"billing": {"consumer": { "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 Firmenname der Lieferadresse

AddrStreet

"billing": {"addressInfo": { "addressLine1": { "street": "..." }}}

ans..100

OC

(obligatory for USA and Canada): Street in the delivery address(Pflicht für USA und Kanada): Straßenname in der Lieferadresse

AddrStreet2

"billing": {"addressInfo": { "addressLine2": "..." }}

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 Computop Helpdesk aktiviert werden.

AddrCity

"billing": {"addressInfo": { "city": "..." }}

ans..40

OC

(obligatory for USA and Canada): Town/city in the delivery address(Pflicht für USA und Kanada): Ort in der Lieferadresse

AddrState

"billing": {"addressInfo": { "state": "..." }}

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): 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

"billing": {"addressInfo": { "postalCode": "..." }}

ans..20

OC

(obligatory for USA and Canada): Postcode in the delivery address(Pflicht für USA und Kanada): Postleitzahl in der Lieferadresse

AddrCountryCode

"billing": {"addressInfo": { "country": { "A2": "..." }}}

an2

O

Country code of the delivery countryLändercode in der Lieferadresse

Phone

"billing": {"contactInfo": { "phone": "..." }}

n..20

O

Telephone numberTelefonnummer

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.

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..2048O

Array of key-value pair (base64-encoded). List of keys has to be agreed with PayPal (can be different for different merchants) before usage of parameter RiskEvaluation.

Example:

{
 "additional_data": [
    {
      "key": "sender_first_name",
      "value": "John"
    },
    {
      "key": "sender_last_name",
      "value": "Doe"
    }
]
}

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

In case of Multi-Seller Payment (Marketplace functionality) each PaymentUnit(n) is related to a separate Seller (merchant within the Marketplace) and contains JSON object (base64-encoded) with the following format.

Example:

{
        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"
        }
    ]
}
  • Where MerchantID is PayPal PayerID of the merchant.
  • InvoiceID must be unique per MerchantID. Merchant cannot use the same InvoiceID twice.
  • Valid values for Category are DIGITAL_GOODS, PHYSICAL_GOODS and DONATION. In scope of one PayPal transaction it is allowed to use 1) DIGITAL_GOODS and/or PHYSICAL_GOODS; 2) DONATION. DONATION cannot be combined with DIGITAL_GOODS or PHYSICAL_GOODS.
  • ItemTotal is the summary of UnitAmount * Quantity of all Order Items related to this merchant.
  • TaxTotal is the summary of Tax of all Order Items related to this merchant.
  • Amount is the summary of ItemTotal, TaxTotal and ShippingAmount of this merchant.

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"
        }
    ]
}
  • Dabei ist MerchantID die PayPal PayerID des Händlers.
  • InvoiceID muss pro MerchantID eindeutig sein. Der Händler darf dieselbe InvoiceID nicht zweimal verwenden.
  • Gültige Werte für die Category sind DIGITAL_GOODS, PHYSICAL_GOODS und DONATION. Für eine PayPal-Transaktion ist die Verwendung von 1) DIGITAL_GOODS und/oder PHYSICAL_GOODS; 2) DONATION. DONATION kann nicht mit DIGITAL_GOODS oder PHYSICAL_GOODS kombiniert werden.
  • ItemTotal ist die Zusammenfassung von UnitAmount * Quantity aller Bestellartikel, die sich auf diesen Händler beziehen.
  • TaxTotal ist die Zusammenfassung von Tax aller Bestellartikel dieses Händlers.
  • Amount ist die Zusammenfassung von ItemTotal, TaxTotal und ShippingAmount dieses Händlers.
mode
an8O

If mode="redirect" is sent, it means that the merchant does not use PayPal Smart Button and Paygate should redirect the customer to PayPal.

if mode is not sent (or sent with any other value except "redirect"), it means that the merchant uses PayPal Smart Button and Paygate will not redirect the customer to PayPal (redirection will be handled by PayPal Smart Button).

(info) Common notes:

  • We recommend to use the PayPal Smart Button for additional fraud protection and improved user experience

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).

(info) Allgemeine Hinweise:

  • Wir empfehlen, die Verwendung des PayPal Smart Button für zusätzlichen Betrugsschutz und ein verbessertes Benutzererlebnis


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:

(info) es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

(info) die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyFormatCNDDescriptionBeschreibung
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.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Key

Format

CND

Description

Beschreibung

Status

a..50

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.

Timeout – all open payments with status AUTHORIZE_REQUEST will be closed ~ 3hours later automatically and are reported as Timeout.

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

KeyFormatCNDDescriptionBeschreibung
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!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyFormatCNDDescriptionBeschreibung
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyFormatCNDDescriptionBeschreibung
UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

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

Key

Format

CND

Description

Beschreibung

CodeExtn..10O

Error code from PayPal if agreed with Computop Helpdesk

Fehlercode von PayPal, wenn mit Computop Helpdesk abgesprochen

Nameans..50MFirst name and surname joinedVorname und Nachname zusammen

FirstName

ans..50

M

First name of payer (PayerInfo, may differ from the account name)Vorname des Zahlers (PayerInfo, kann vom Kontonamen abweichen)

LastName

ans..50

M

Last name of payer (PayerInfo, may differ from the account name)Nachname des Zahlers (PayerInfo, kann vom Kontonamen abweichen)
E-Mailans..100MEmail address of the purchaserE-Mail-Adresse des Käufers

AddrStreet

ans..100

O

Street in the delivery addressStraßenname in 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 Computop Helpdesk aktiviert werden.

AddrCity

ans..40

O

Town/city in the delivery addressOrt in der Lieferadresse

AddrState

ans..40

O

Federal State in the delivery addressBundesstaat in der Lieferadresse

AddrZip

ans..20

O

Postcode in the delivery addressPostleitzahl in der Lieferadresse

AddrCountryCode

an2

O

Country code of the delivery countryLändercode in der Lieferadresse

Phone

n..20

O

Telephone numberTelefonnummer
BillingAgreementIDans..19OBilling Agreement ID which can be used for subsequent transactions, based on this Billing Agreement.Billing Agreement, die für nachfolgende Transaktionen basierend auf dieser Billing Agreement verwendet werden kann.

BillingName

ans..32

O

First name and surname joined

Vorname und Nachname zusammen

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 Computop Helpdesk 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

Bundesstaat 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 billing addressLändercode in der Rechnungsadresse
payerStatusan..10OStatus 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 merchantNachricht an den Händler

PayerID

ans..13

O

(if response is activated): Unique identification number of customer account at PayPal(falls Antwort aktiviert ist): Eindeutige Identifikationsnummer des Kundenkontos bei PayPal

GrossAmount

an..9

O

Final amount charged, including any shipping and taxes from your Merchant profileAbgerechneter Endbetrag, einschließlich Versandkosten und Steuern aus Ihrem Händlerprofil

FeeAmount

an..9

O

PayPal fee amount charged for the transactionFür die Transaktion berechneter Betrag der PayPal-Gebühr

SettleAmount

an..9

O

Amount deposited in your PayPal account after a currency conversionAuf Ihrem PayPal-Konto nach einer Währungsumrechnung eingezahlter Betrag

TaxAmount

an..9

O

Tax charged on the transactionAuf die Transaktion erhobene 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, 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

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 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

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 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..255O

In case of Multi-Seller Payment (Marketplace functionality), each OrderStatus(n) contains Status and Capture ID (to be used in case of Credit) for corresponding OrderDesc(n) sent in request. JSON object (base64-encoded) with the following format.

Examples:

{"status":"COMPLETED", "id":"3C679366HH908993F1", "invoiceid":"PU1_20230812"}
{"status":"FAILED", "id":"na", "invoiceid":""}

Status has been analysed, because a customer could not have enough money for all merchants. In this case PayPal will approve only some of OrderDesc(n) (only for some merchants).

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).

TIDans..17O

In case of SALE, the parameter contains unique PayPal-generated Capture ID.

In case of AUTH, the parameter contains unique PayPal-generated Authorization ID.

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.

TransactionIDans..17OThe parameter contains unique PayPal-generated Order IDThe parameter contains unique PayPal-generated Order ID

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:


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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
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).

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.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

Currency, three digits 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/.

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/.

KeyFormatCNDDescriptionBeschreibung
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

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.




(info) Address information. When you transfer these values you can also change an address.
(warning) Notice: If transferring FirstName, all other values should also be entered. If not transferring FirstName, other address parameters are not taken into account.
(info) Adressinformationen. Durch Übergabe dieser Werte ist auch eine Adress-Änderung möglich.
(warning) Hinweis: Wenn FirstName übergeben wird, sollten auch alle anderen Werte übergeben werden. Wenn FirstName nicht übergeben wird, werden andere Adressparameter nicht berücksichtigt.

FirstName

ans..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 Computop Helpdesk 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:

(info) es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

(info) die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyFormatCNDDescriptionBeschreibung
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.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
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!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

KeyFormatCNDDescriptionBeschreibung
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyFormatCNDDescriptionBeschreibung
CodeExt

n..10

O

Error code from external partner. Needs to be agreed with Computop Helpdesk.

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:


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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

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

KeyFormatCNDDescriptionBeschreibung
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.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Key

Format

CND

Description

Beschreibung

TxTypeans..5MTransaction type AuthTransaktionstyp Auth

KeyFormatCNDDescriptionBeschreibung
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).

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.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

Currency, three digits 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/.

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

Description

Beschreibung

FirstName

ans..50

O

Either the first name only or first and second name if a company name is used as a delivery addressEntweder nur der Vorname oder Vor- und Nachname, wenn ein Firmenname als Lieferadresse verwendet wird

LastName

ans..50

O

Surname or name of the company of the delivery addressNachname oder Firmenname der Lieferadresse

AddrStreet

ans..100

O

Street in the delivery addressStraßenname in 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 Computop Helpdesk aktiviert werden.

AddrCity

ans..40

O

Town/city in the delivery addressOrt in 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.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

Postcode in the delivery addressPostleitzahl in der Lieferadresse

AddrCountryCode

an2

O

Country code of the delivery countryLändercode in der Lieferadresse

Phone

n..20

O

Telephone numberTelefonnummer

Parameter für PayPal-Autorisierung


Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt:

(info) es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

(info) die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyFormatCNDDescriptionBeschreibung
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.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
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!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

Key

Format

CND

Description

Beschreibung

CodeExtn..10O

Error code from PayPal if agreed with Computop Helpdesk

Fehlercode von PayPal, wenn mit Computop Helpdesk abgesprochen

Ergebnis-Parameter bei PayPal-Autorisierung



Aufruf der Schnittstelle für eine Buchung

Um eine Buchung (Capture) für PayPal über eine Server-zu-Server-Verbindung auszuführen, verwenden Sie bitte folgende URL:


Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

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

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyRESTFormatCNDDescriptionBeschreibung
TransID"transactionId": "..."

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyRESTFormatCNDDescriptionBeschreibung

MAC

---

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

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).

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "currency": "..."}

a3

M

Currency, three digits 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/.

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

REST

Format

CND

Description

Beschreibung

RefNr"referenceNumber": "..."ans..30OMerchant reference number: here a separate reference number, e.g. an invoice number, can be transferredReferenznummer des Händlers: hier kann eine separate Referenznummer übertragen werden, z.B. eine Rechnungsnummer

KeyRESTFormatCNDDescriptionBeschreibung
ReqId"requestId": "..."

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.

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

REST

Format

CND

Description

Beschreibung

TID"payment": {"payPal": { "generatedCaptureId": "..." }}ans..17O

Unique PayPal-generated Capture ID. The value is required for a refund after several partial captures.

Example: A merchant did 3 partial captures for an authorization. For each capture unique PayPal-generated Capture ID is returned in TID  (e.g., TID=111, TID=222, TID=333). Then, a refund for second capture should be done. In this case the merchant needs to send TID=222 in refund request.

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.

CompleteType"payment": {"payPal": { "completeType": "..." }}ans..3O

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).

Wenn <YES> übergeben wird, wird die eventuell offene Bestellung von PayPal bei der Buchung geschlossen. (Grund: Seitens PayPal ist eine 115%ige Buchung zulässig. Wenn eine Buchung 100% erreicht, sendet das Computop Helpdesk automatisch eine Anfrage zum Schließen der Zahlung).

Parameter für PayPal-Buchungen


Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt:

(info) es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

(info) die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyRESTFormatCNDDescriptionBeschreibung
XID"xId": "..."

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

KeyRESTFormatCNDDescriptionBeschreibung
TransID"transactionId": "..."

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyRESTFormatCNDDescriptionBeschreibung
Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyRESTFormatCNDDescriptionBeschreibung
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!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyRESTFormatCNDDescriptionBeschreibung
Code"code": ...

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

Key

REST

Format

CND

Description

Beschreibung

CodeExt"externalErrorCode": ...n..10O

Error code from PayPal if agreed with Computop Helpdesk

Fehlercode von PayPal, wenn mit Computop Helpdesk abgesprochen

Ergebnis-Parameter für PayPal-Buchungen



Aufruf der Schnittstelle für eine Gutschrift mit Referenz

Um eine Gutschrift (Credit) mit Referenztransaktion für PayPal auszuführen, verwenden Sie bitte folgende URL:


Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

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

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment to be credited

Vom Paygate vergebene ID für die gutzuschreibende Zahlung

KeyRESTFormatCNDDescriptionBeschreibung
TransID"transactionId": "..."

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyRESTFormatCNDDescriptionBeschreibung

MAC

---

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

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).

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "currency": "..."}

a3

M

Currency, three digits 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/.

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

REST

Format

CND

Description

Beschreibung

RefNr"referenceNumber": "..."ans..30OMerchant reference number: here a separate reference number, e.g. an invoice number, can be transferredReferenznummer des Händlers: hier kann eine separate Referenznummer übertragen werden, z.B. eine Rechnungsnummer

KeyRESTFormatCNDDescriptionBeschreibung
ReqId"requestId": "..."

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.

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

REST

Format

CND

Description

Beschreibung

TID"payment": {"payPal": { "generatedCaptureId": "..." }}ans..17O

Unique PayPal-generated Capture ID. The value is required for a refund after several partial captures.

Example: A merchant did 3 partial captures for an authorization. For each capture unique PayPal-generated Capture ID is returned in TID in capture response (e.g., TID=111, TID=222, TID=333). Then, a refund for second capture should be done. In this case the merchant needs to send TID=222 in refund request.

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"reason": "..."ans..768CExplanatory text for recipientErläuterungstext für den Empfänger
Subject"payment": {"payPal": { "massPayEmailSubject": "..." }}ans..255C

MassPay: E-Mail subject to recipient

Notice: If you want to use the MassPay functionality, please contact the Computop Helpdesk to activate this function for you.

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:

(info) es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

(info) die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyRESTFormatCNDDescriptionBeschreibung
XID"xId": "..."

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

KeyRESTFormatCNDDescriptionBeschreibung
TransID"transactionId": "..."

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyRESTFormatCNDDescriptionBeschreibung
Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyRESTFormatCNDDescriptionBeschreibung
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!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyRESTFormatCNDDescriptionBeschreibung
Code"code": ...

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

Key

REST

Format

CND

Description

Beschreibung

CodeExt"externalErrorCode": ...n..10O

Error code from PayPal if agreed with Computop Helpdesk

Fehlercode von PayPal, wenn mit Computop Helpdesk abgesprochen

FeeRefundAmount

"payment": {"feeAmount": ...}

n..10

O

The refunded amount of the PayPal transaction fees. Required for part credit notes to prior partial captures.

Der erstattete Betrag der PayPal-Transaktionsgebühren. Erforderlich für Teilgutschriften zu früheren Teilbuchungen.

GrossRefundAmount

"payment": {"grossAmount": ...}

n..10

O

Amount refunded to the buyer in this refund transaction. Required for part credit notes to prior partial captures.

Betrag, der dem Käufer bei dieser Gutschrift erstattet wird. Erforderlich für Teilgutschriften zu früheren Teilbuchungen.

NetRefundAmount

"payment": {"netAmount": ...}

n..10

O

Amount deducted from your PayPal account to make this refund. Required for part credit notes to prior partial captures.

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



Aufruf der Schnittstelle für nicht referenzierte Gutschriften

Um eine Gutschrift ohne Bezugstransaktion für PayPal abzuwickeln, verwenden Sie bitte folgende URL:


Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

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

KeyRESTFormatCNDDescriptionBeschreibung
TransID"transactionId": "..."

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyRESTFormatCNDDescriptionBeschreibung
refnr"referenceNumber": "..."

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

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).

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "currency": "..."}

a3

M

Currency, three digits 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/.

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

REST

Format

CND

Description

Beschreibung

PayerID
ans..13OUnique identification number of customer account at PayPalEindeutige Identifikationsnummer des Kundenkontos bei PayPal

KeyRESTFormatCNDDescriptionBeschreibung
ReqId"requestId": "..."

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.

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

REST

Format

CND

Description

Beschreibung

Account"payment": {"payPal": { "accountId": "..." }}ans..128OFor managing multiple PayPal accounts, Merchant account: ID or e-Mail address for which the request should be submitted to PayPalFür die Verwaltung mehrerer PayPal-Konten, Händlerkonto: ID oder E-Mail-Adresse, für die die Anfrage an PayPal gesendet werden soll
Note"reason": "..."ans..768C

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: Erläuterungstext für 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.

Subject"payment": {"payPal": { "massPayEmailSubject": "..." }}ans..255C

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: 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.

Payer
ans..100O

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 Computop Helpdesk, 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:

(info) es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

(info) die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyRESTFormatCNDDescriptionBeschreibung
XID"xId": "..."

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

KeyRESTFormatCNDDescriptionBeschreibung
TransID"transactionId": "..."

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyRESTFormatCNDDescriptionBeschreibung
Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyRESTFormatCNDDescriptionBeschreibung
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!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyRESTFormatCNDDescriptionBeschreibung
Code"code": ...

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

Key

REST

Format

CND

Description

Beschreibung

CodeExt"externalErrorCode": ...n..10O

Error code from PayPal if agreed with Computop Helpdesk

Fehlercode von PayPal, wenn mit Computop Helpdesk abgesprochen

FeeRefundAmount

"payment": {"feeAmount": ...}

n..10

O

The refunded amount of the PayPal transaction fees. Required for part credit notes to prior partial captures.

Der erstattete Betrag der PayPal-Transaktionsgebühren. Erforderlich für Teilgutschriften zu früheren Teilbuchungen.

GrossRefundAmount

"payment": {"grossAmount": ...}

n..10

O

Amount refunded to the buyer in this refund transaction. Required for part credit notes to prior partial captures.

Betrag, der dem Käufer bei dieser Gutschrift erstattet wird. Erforderlich für Teilgutschriften zu früheren Teilbuchungen.

NetRefundAmount

"payment": {"netAmount": ...}

n..10

O

Amount deducted from your PayPal account to make this refund. Required for part credit notes to prior partial captures.

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 ohne Bezugstransaktion



Aufruf der Schnittstelle für Stornierungen

Um eine Transaktion bei PayPal zu stornieren, verwenden Sie bitte folgende URL:


Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

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

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment to be reversed

Vom Paygate vergebene ID für die zu stornierende Zahlung

KeyRESTFormatCNDDescriptionBeschreibung
TransID"transactionId": "..."

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyRESTFormatCNDDescriptionBeschreibung

MAC

---

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

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).

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "currency": "..."}

a3

M

Currency, three digits 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/.

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/.

KeyRESTFormatCNDDescriptionBeschreibung
ReqId"requestId": "..."

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.

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:

(info) es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

(info) die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyRESTFormatCNDDescriptionBeschreibung
XID"xId": "..."

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

KeyRESTFormatCNDDescriptionBeschreibung
TransID"transactionId": "..."

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyRESTFormatCNDDescriptionBeschreibung
Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyRESTFormatCNDDescriptionBeschreibung
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!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyRESTFormatCNDDescriptionBeschreibung
Code"code": ...

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

Key

REST

Format

CND

Description

Beschreibung

CodeExt"externalErrorCode": ...n..10O

Error code from PayPal if agreed with Computop Helpdesk

Fehlercode 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)

  1. 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.
  2. Über die URL meldet sich der Kunde im PayPal-Konto an und genehmigt die Abrechnungsvereinbarung.
  3. Sobald die Abrechnungsvereinbarung vom Kunden genehmigt ist, wird die Billing Agreement ID über URLNotify gesendet.

Nutzung der Abrechnungsvereinbarung

  1. 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. Der Händler kann nur dann über die Kündigung informiert werden, wenn für das Händlerkonto die Zusatzoption IPN „Sofortzahlungsbenachrichtigung“ aktiviert ist. Die Freischaltung muss über den Computop Helpdesk erfolgen. Bitte beachten Sie, dass der Händler nach der IPN-Aktivierung Benachrichtigungen über jede Statusänderung einer PayPal-Zahlung erhält.
  • 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:


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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
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).

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.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

Currency, three digits 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/.

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/.

KeyFormatCNDDescriptionBeschreibung
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

Key

Format

CND

Description

Beschreibung

OrderDescans..30ODescription of purchased goods, unit prices etc.Beschreibung der gekauften Waren, Einzelpreise usw.
BillingAgreementIDan19MIdentification 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 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:

(info) es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

(info) die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyFormatCNDDescriptionBeschreibung
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.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
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!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

Key

Format

CND

Description

Beschreibung

CodeExtn..10O

Error code from PayPal if agreed with Computop Helpdesk

Fehlercode von PayPal, wenn mit Computop Helpdesk abgesprochen

KeyFormatCNDDescriptionBeschreibung
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

Key

Format

CND

Description

Beschreibung

OrderIDans..17OUnique PayPal-generated OrderIDEindeutige, von PayPal generierte OrderID
TIDans..17O

Unique PayPal-generated CaptureID

Eindeutige, von PayPal generierte CaptureID
Nameans..32OFirst name and surname joinedVor- und Nachname zusammengefügt

FirstName

ans..50

O

First name of payer (PayerInfo, may differ from the account name)Vorname des Zahlers (PayerInfo, kann vom Kontonamen abweichen)

LastName

ans..50

O

Last name of payer (PayerInfo, may differ from the account name)Nachname des Zahlers (PayerInfo, kann vom Kontonamen abweichen)
E-Mailans..100OEmail address of the purchaserE-Mail-Adresse des Käufers

BillingName

ans..32

O

First name and surname joined

Vor- und Nachname zusammengefügt

BillingAddrCountryCode

an2

O

Country code of the billing addressLändercode der Rechnungsadresse

PayerID

ans..13

O

(if response is activated): Unique ID of customer account at PayPal(bei aktivierter Antwort): Eindeutige ID des Kundenkontos bei PayPal

Ergebnis-Parameter für PayPal-Referenztransaktionen



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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Action

Version

Description

Beschreibung
Authorize

1.0 / 2.0

Standard version without return of parameter Code

Standardversion ohne Rückgabe von Parameter Code


1.4 / 2.4

with TID

mit TID

Capture

1.0 / 2.0

Standard version without return of parameter Code

Standardversion ohne Rückgabe von Parameter Code

1.x / 2.x

with RefNr (valid for all versions other than 1.0)

mit RefNr (gilt für alle Versionen außer 1.0)

1.4 / 2.4

with TID

mit TID

Credit

1.0 / 2.0

Standard version without return of parameter Code

Standardversion ohne Rückgabe von Parameter Code


1.x / 2.x

with RefNr (valid for all versions other than 1.0)

mit RefNr (gilt für alle Versionen außer 1.0)

1.4 / 2.4with TIDmit TID
CreditEx

1.0 / 2.0

Standard version without return of parameter Code

Standardversion ohne Rückgabe von Parameter Code

1.x / 2.x

with RefNr (valid for all versions other than 1.0)

mit RefNr (gilt für alle Versionen außer 1.0)
Reverse

1.0 / 2.0

Standard version without return of parameter Code

Standardversion ohne Rückgabe von Parameter Code

1.4 / 2.4

with TID

mit TID
ABO/REFTRANS

1.0 / 2.0

ABO - Classic PayPal API

REFTRANS - Order V2 PayPal API

Standard version without return of parameter Code

ABO - Classic PayPal API

REFTRANS - Order V2 PayPal API

Standardversion ohne Rückgabe von Parameter Code


1.x / 2.x

with RefNr (valid for all versions other than 1.0)

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>,<CodeExt>,<PayID>,<Status>,<Code>
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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

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
Capture
Credit
CreditEx (credit note without previous capture; please agree this with Computop Helpdesk beforehand)
Reverse (cancellation)
ABO (subscription, Classic API)

REFTRANS (subscription, Order V2 API)

Der Action-Parameter definiert die Art der Transaktion:

Authorize (Autorisierung)
Capture (Buchung)
Credit (Gutschrift)
CreditEx (Gutschrift ohne vorherige Buchung; bitte vereinbaren Sie das vorher mit dem Computop Helpdesk)
Reverse (Storno)
ABO (Abonnement, Classic API)

REFTRANS (Abonnement, Order V2 API)

KeyFormatCNDDescriptionBeschreibung
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).

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.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

Currency, three digits 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/.

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/.

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

Key

Format

CND

Description

Beschreibung
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: 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

Explanatory text for recipient

Erläuterungstext für den Empfänger

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for this transaction

Vom Paygate vergebene ID für diese Transaktion

Key

Format

CND

Description

Beschreibung
TID

ans..17

O

PayPal unique transaction number. Required for a number of authorisations or part captures, part credit notes or part cancellations.Eindeutige PayPal-Transaktionsnummer. Erforderlich für eine Reihe von Autorisierungen oder Teilbuchungen, Teilgutschriften oder Teilstornierungen.
OrderDesc

ans..127

O

Description of purchased goods, unit prices etc.Beschreibung der gekauften Waren, Einzelpreise usw.
Capture

a..6

O

Auto or Manual: determines whether the requested amount is settled immediately or at a later stage.

For REFTRANS only Auto is possible.

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

Obligatory for Capture=Manual: Transaction type with possible values Order and AuthPflicht bei Capture=Manual: Transaktionstyp mit den möglichen Werte Order und Auth

BillingAgreementID

an19

OC

Identification number of the invoice agreement. When the buyer confirms the invoice agreement it is validated and remains valid until revoked by the buyer.

Mandatory in case of ABO and REFTRANS.

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>,<Status>,<Code>,<CodeExt>
PAYPAL,REFTRANS,<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):

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

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 Buchung oder Gutschrift.

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for this transaction

Vom Paygate vergebene ID für diese Transaktion

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

Key

Format

CND

Description

Beschreibung
CodeExtn..10O

Error code from PayPal if agreed with Computop Helpdesk

Fehlercode von PayPal, wenn mit Computop Helpdesk abgesprochen

Beschreibung der Ergebnis-Parameter im Datensatz von Batch-Dateien