Skip to end of metadata
Go to start of metadata


About PayPal


Logo

Info

Computop processes PayPal payments, which offers you worldwide merchant protection and a potential of 425 million international customers in more than 200 countries.

PayPal is one of the most popular online payment methods and it can be used in e- and m-Commerce.

TypePayments by eWallet

General information about PayPal

PayPal has remained at the forefront of the digital payment revolution for more than 20 years. By leveraging technology to make financial services and commerce more convenient, affordable, and secure, the PayPal platform is empowering more than 425 million costomers and merchants in more than 200 markets to join and thrive in the global economy.

Customers in Germany can pay via direct debit, giropay or credit card (American Express, Diners Club, Discover, MasterCard, Visa). Members log into their PayPal account with their email address and a password during checkout and choose the preferred funding source - direct debit, credit card, PayPal credit (Pay Later) and, if applicable purchase on account or by instalment.

For more details visit https://www.paypal.com/.

PayPal Shortcut (former "Express Checkout Shortcut (ECS)")

Computop Paygate offers the PayPal Shortcut to shorten the order process: Your customer does not need to enter any address data but rather click on Checkout with PayPal in the shopping cart area, log on and select the invoice- and delivery address retained by PayPal. Paygate then sends the delivery address as a result parameter back to your shop.

Buyers and vendors are protected

PayPal offers buyers and merchants extensive buyer/vendor protection in case "Pay with PayPal" is used as payment method (this excludes alternative payment methods). Buyers are able to claim money back from PayPal in the event of non-fulfilment of a contract of sale. With address verification and PayPal seller protection PayPal removes the merchant of the risk of payment failures in the case of direct debit payments, German credit card payments and unjustified customer complaints. Vendor protection is always linked to PayPal rules and conditions. PayPal risk management with buyer protection and address verification is provided to you via the Computop Paygate.

Payment online globally

PayPal is particularly beneficial for overseas customer acquisition. Computop Paygate supports all currencies and markets offered by PayPal. In many countries PayPal offers customers typical payment methods for their country. Customers abroad can often use typical payment methods such as prepaid cards in Italy or debit cards in the UK. Integrating PayPal into your shop provides the option to present your customers several payment methods at once. Of course you are also free to just present "Pay with PayPal" only.

Advantages of Orders V2 ("PayPal Checkout")

Orders V2 has the following advantages against PayPal NVP and SOAP.

  • Orders V2 is the basis for any future development of products and featured by PayPal. PayPal will not develop any new feature/extend existing functionality based on PayPal NVP and SOAP anymore.
  • Orders V2 adheres to the latest compliance standards.
  • Orders V2 offers smoother checkout process using a lightbox (by using JS SDK, so-called "PayPal Mini Browser"), a window overlay that appears on top of the merchant’s online shop page. This allows the customer to stay on merchant's page and to not lose focus.


Further information can be found on the webpage of PayPal (https://www.paypal.com).

Important information

Please note that, unlike our currency table, the currencies HUF (Hungarian ‒ Forints), JPY (Japanese Yen) and TWD (Republic of China ‒ Taiwan-Dollars) must be given without decimal places.

Example: To transfer 100.00 HUF one enters the amount=100.

This exception applies only for the PayPal payment method. For more details refer to https://developer.paypal.com/reference/currency-codes/.

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

On this page


Process flow




PayPal process flow


Configuration for PayPal

To process PayPal transactions via the Computop Paygate as merchant you need to have a PayPal Business account. You also need to grant API permissions to Computop in order to enable usage of PayPal interface via Computop Paygate.

Create and configure PayPal Business account

1 Go to https://developer.paypal.com and:

  • Create new PayPal Business account, or
  • Log-in using your existing PayPal account and upgrade it to PayPal Business account, or
  • Log-in using your existing PayPal Business account.


Create and configure REST API app, and obtain REST API credentials

1. Go to https://developer.paypal.com/developer/applications


2. Log-in to Dashboard using your PayPal Business account, and go to “My Apps & Credentials”


3. Create REST API app by clicking on “Create App” button.


4. Enter App Name and click “Create App” button.


5. The page shows “Sandbox account”, “Client ID” and “Secret” for this App.


6. Go to “Accounts” under SANDBOX section.


7. Find the sandbox account for newly created App (refer to step 5), then click “…” button and choose “View/edit account”.


8. The page shows “Email ID” and “System Generated Password” which will to be used later for log-in to sandbox.paypal.com.


Grant API permissions to Computop Paygate

1. Go to https://www.paypal.com/US/cgi-bin/webscr?cmd=_profile-api-grant-authorization and enter frank.arnoldt_api1.computop.de as Third-Party Permission Username and click Lookup button.


2. Grant the following permissions and click “Add” button.


3. After adding the permissions, the following page with summary of granted permissions appears.


Grant API permissions to Computop Paygate on Sandbox

1. Go to https://sandbox.paypal.com

 


2. Log-in using “Email ID” and “System Generated Password” from Developer portal (refer to step 8 above).


3. The page shows your test store.


4. Under your account on right top conner choose “Kontoeinstellungen” and then “Website-Zahlungslösungen”.


5. Click “Bearbeiten” in front of “API-Zugriff”.


6. Click “API-Genehmigung erteilen”.


7. Enter test_paypal_api_api1.computop.com and click “Nachschlagen” button. On the page grant the following permissions and click “Hinzufügen” button.


8. After adding the permissions, the following page with summary of granted permissions appears.


Setting Payment Preferences on Sandbox

1. Go to https://sandbox.paypal.com and log-in using “Email ID” and “System Generated Password” from Developer portal (refer to steps 1-3 above).

 

2. Under your account on right top corner choose “Kontoeinstellungen” and then “Zahlungseinstellungen”.


3. Click “Bearbeiten” in front of “Zahlungen blockieren”. On the page choose the following preferences.


4. All changes on the page are saved “on fly”, there is no need to click any button to save the changes.


PayPal Smart Button

Setting up the PayPal Button

The client-side implementation of PayPal is realized using the PayPal JavaScript SDK.

Depending on your setup, you can use the following script or prepare you own, using the official PayPal JavaScript SDK documentation  https://developer.paypal.com/sdk/js/.

While you are testing in sandbox, you can use client-id that matches your test app from PayPal web developer portal. When going live, replace this with the live client-id.

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8"/>
</head>
 
<body>
    <!-- Set up a container element for the button -->
    <div id="paypal-button-container"></div>
 
	<!-- Include the PayPal JavaScript SDK -->
    <!-- While you are testing in sandbox, you can use client-id that matches your test app from PayPal web developer portal. When going live, replace this with the live client-id provided by Paypal -->
    <script type="text/javascript" src="https://www.paypal.com/sdk/js?client-id=myClientID&currency=EUR&disable-funding=giropay,sofort,sepa,card&intent=capture"></script>
     
    <!-- Initialize and show PayPal button -->
    <script type="text/javascript">
    let mid = "YOUR MERCHANTID";
    let len = "LEN OF UNENCRYPTED BLOWFISH STRING";
    let data = "BLOWFISH ENCRYPTED STRING";
	let payid;
     
        if (len != '' && data != '') {
            // Set the request parameter MerchantID, Len and Data
            const params = new URLSearchParams({
                MerchantID: mid,
                Len: len,
                Data: data
            });
 
            // Render the PayPal button into #paypal-button-container
            paypal.Buttons({
                // Call your server to set up the transaction
                createOrder: function(data, actions) {
                    return fetch('https://www.computop-paygate.com/ExternalServices/paypalorders.aspx', {
                        method: 'POST',
                        body: params
                    }).then(function (res) {
                        return res.text();
                    }).then(function(orderData) {
                        var json = stringToObj(orderData);
							payid = json.PayID;
                        return json.orderid;
                    });
                },
                // Call cbPayPal.aspx for continue sequence
                onApprove: function (data, actions) {
                    var rd = "MerchantId=" + mid + "&PayId=" + payid + "&OrderId=" + data.orderid;
                    window.location = "https://www.computop-paygate.com/cbPayPal.aspx?rd=" + window.btoa(rd);
                    }
                        }).render('#paypal-button-container');
                    }
 
            function stringToObj (string) {
                var newobj = {};
                string.split('&').forEach(function (value) {
                var keypair = value.split('=');
                newobj[keypair[0]] = keypair[1];
            });
 
            return newobj;
        }
         
    </script>
     
</body>
</html>

Enabling PayPal Pay Later Button

The above piece of code contains the following line. In this line it will be possible to define which funding sources will be allowed in the web shop.

<script type="text/javascript" src="https://www.paypal.com/sdk/js?client-id=sb&currency=EUR&disable-funding=giropay,sofort,sepa,card&intent=capture"></script>

The line corresponded to the following button. By default (using the above line) only PayPal button will be available.


If it is required to have PayPal Pay Later Button in addition to standard PayPal button, the button can be enabled by using parameter enable-funding like follows.

<script type="text/javascript" src="https://www.paypal.com/sdk/js?client-id=sb&currency=EUR&disable-funding=giropay,sofort,sepa,card&enable-funding=paylater"></script>

As a result the following two buttons will appear.


Full list of values for disable-funding and enable-funding can be found by the link below.

https://developer.paypal.com/docs/regional/th/checkout/reference/customize-sdk/#components

Parameter intent

The above piece of code contains the following line.

<script type="text/javascript" src="https://www.paypal.com/sdk/js?client-id=sb&currency=EUR&disable-funding=giropay,sofort,sepa,card&intent=capture"></script>

Paygate offers 3 possible options for a payment.

  • SALE (when Paygate automatically sends Capture for a payment; this is the default scenario matching most merchant's needs)
  • AUTHORIZE (when Capture should be sent later by the merchant as a separate API call)
  • ORDER (when Authorize and Capture should be sent later by the merchant as a separate API calls)

Parameter intent in the above line must be in synch with these options.

If SALE option is used, parameters intent must be set to "capture" as below.

<script type="text/javascript" src="https://www.paypal.com/sdk/js?client-id=sb&currency=EUR&disable-funding=giropay,sofort,sepa,card&intent=capture"></script>

If AUTHORIZE or ORDER option is used, parameters intent must be set to "authorize" as below.

<script type="text/javascript" src="https://www.paypal.com/sdk/js?client-id=sb&currency=EUR&disable-funding=giropay,sofort,sepa,card&intent=authorize"></script>

It is important to set proper value for parameter intent, otherwise an error appears.

PayPal Button Style

The above piece of code for PayPal Button does not have any style-related parameters. This piece of code assumes default PayPal style for the button as follows.


PayPal allows to define different PayPal Button style by using parameters shape, color, layout and label. Full list of style-related parameters can be find by the following link.

https://developer.paypal.com/docs/checkout/advanced/style-guide/



Paygate interface

Definitions

Data formats

Format

Description

a

alphabetical

as

alphabetical with special characters

n

numeric

an

alphanumeric

ans

alphanumeric with special characters

ns

numeric with special characters

bool

boolean expression (true or false)

3

fixed length with 3 digits/characters

..3

variable length with maximum 3 digits/characters

enum

enumeration of allowed values

dttm

ISODateTime (YYYY-MM-DDThh:mm:ss)


Abbreviations

Abbreviation

Description

Comment

CND

condition


M

mandatory

If a parameter is mandatory, then it must be present

O

optional

If a parameter is optional, then it can be present, but it is not required

C

conditional

If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional


Notice: Please note that the names of parameters can be returned in upper or lower case.


Calling the interface

Use the following URL and parameters to initiate a PayPal payment in the Paygate form:

https://www.computop-paygate.com/ExternalServices/paypalorders.aspx


With this URL Paygate supports two different PayPal methods: One the one hand you can offer PayPal quite normally as an additional payment method for the conclusion of a sale. Otherwise you can use PayPal Express Checkout Shortcut, which connects the customers from the shopping cart directly to PayPal, where they can then select their delivery and invoicing address. The customer saves having to re-enter address details and you, as the merchant, enjoy PayPal vendor protection.

Paygate also supports the separation of authorisation and capture for PayPal Express Checkout. You can set parameters via the Paygate to control whether the amount on the customer's PayPal account should be blocked or captured immediately.

Notice: One of the following conditions must be fulfilled to enable you to benefit from PayPal seller protection. Either the customer uses PayPal Express Checkout and selects a delivery address which it has saved previously with PayPal, which Paygate transmits to your shop. Or your shop transmits the already known delivery address to PayPal. Seller protection applies only if the goods have been supplied to this specified address. There may be no more than 3 days between the authorisation of the amount in the customer's PayPal account and capture if you wish to benefit from seller protection. Paygate therefore supports several alternatives for the processing of PayPal payments: we shall be happy to advise you about the implementation of PayPal.


Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

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
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

Key

Format

CND

Description

Beschreibung

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

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

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

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

Format

CND

Description

Beschreibung

Capture

a..6

O

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

Important Note: Please contact Computop Helpdesk for Manual, to discuss different possibilities of usage.

Auto oder Manual: bestimmt, ob der 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

ans..5

C

Obligatory for Capture=Manual: Transaction type with possible values Order or AuthPflicht bei Capture=Manual: Transaktionstyp mit den möglichen Werten Order oder Auth

PayPalMethod

enum

O

The "shortcut" value selects the changed transaction procedure which takes the customer back to the shop for payment confirmation.

You then need to call up the interface paypalcomplete.aspx to complete the sale.

Wert "shortcut" wählt den geänderten Transaktionsablauf, bei dem der Kunde für die Zahlungsbestätigung in den Shop zurückgeleitet wird.

Zum Abschließen der Bestellung muss anschließend die Schnittstelle paypalcomplete.aspx aufgerufen werden.

RTF

ans1

O

Reserved for future useFür zukünftige Verwendung reserviert

OrderDesc

ans..127

M

Description of purchased goods, unit prices etc.

Beschreibung der gekauften Waren, Einzelpreise usw.

OrderDesc(n)

ans..2048

O

Customers shopping basket in the form:

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

OrderDesc2 to max. OrderDesc99 permissible

For correct execution of displaying function all OrderDesc(n) Amounts must equal to the 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

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

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

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.

KeyFormatCNDDescriptionBeschreibung
URLSuccess

ans..256

M

Complete URL which calls up Paygate if payment has been successful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

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

KeyFormatCNDDescriptionBeschreibung
URLFailure

ans..256

M

Complete URL which calls up Paygate if payment has been unsuccessful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

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

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

KeyFormatCNDDescriptionBeschreibung
URLNotify

ans..256

M

Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443. It may not contain parameters: Use the UserData parameter instead.

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

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.

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. 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 einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

Key

Format

CND

Description

Beschreibung

Account

ans..128

O

For managing multiple PayPal accounts, Merchant account: ID or e-Mail address for which the request should be submitted to PayPal
Für die Verwaltung mehrerer PayPal-Konten, Händlerkonto: ID oder E-Mail-Adresse, für die die Anfrage an PayPal gesendet werden soll
LandingPageans..OControls how the PayPal page is displayed. Possible values are “Login” or “Billing”.Steuert, wie die PayPal-Seite angezeigt wird. Mögliche Werte sind „Login“ oder „Billing“.
Languagean2OLanguage: AU, DE, FR, IT, GB, ES, US; default DESprache: AU, DE, FR, IT, GB, ES, US; Standardwert DE

FirstName

ans..50

OC

(obligatory for USA and Canada): Either the first name only or first and second name if a company name is used as a delivery address.(Pflicht für USA und Kanada): Entweder nur der Vorname oder Vor- und Nachname, wenn ein Firmenname als Lieferadresse verwendet wird.

LastName

ans..50

OC

(obligatory for USA and Canada): Surname or name of the company of the delivery address(Pflicht für USA und Kanada): Nachname oder Firmenname der Lieferadresse

AddrStreet

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

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

OC

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

AddrState

ans..40

OC

(obligatory for USA and Canada): Federal state of the delivery address. The town submitted in AddrCity must be located in the given federal state, otherwise PayPal refused this payment. For possible values please refer to the PayPal-API-reference documentation.(Pflicht für USA und Kanada): Bundesstaat der Lieferadresse. Der in AddrCity hinterlegte Ort muss im angegebenen Bundesland liegen, ansonsten lehnt PayPal diese Zahlung ab. Mögliche Werte entnehmen Sie bitte der PayPal-API-Referenzdokumentation.

AddrZip

ans..20

OC

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

AddrCountryCode

an2

O

Country code of the delivery countryLändercode in der Lieferadresse

Phone

n..20

O

Telephone numberTelefonnummer

NoShipping

n1

O

Handover NoShipping=1 prevents the delivery address registered with Paypal from being displayedDie Übergabe von NoShipping=1 verhindert, dass die bei Paypal hinterlegte Lieferadresse angezeigt wird

Parameters for PayPal payments


The following table gives the result parameters which Computop Paygate transmits to URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

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

n8

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

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.

Return parameters for URLSuccess, URLFailure and URLNotify with PayPal


Notice: The address parameters are always transmitted to the shop but are empty if no address data has been exchanged.

 

Calling the interface for method "shortcut"

The PayPal "shortcut" method enables a changed transaction procedure which takes the customer back to the shop for payment confirmation. To complete this PayPal payment in the next step, use the following URL and parameters:

 https://www.computop-paygate.com/paypalComplete.aspx


Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

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

Parameters for PayPal payments with method "shortcut"


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

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

n8

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.

Response parameters for PayPal with method "shortcut"


Calling the interface for a separate authorization

For a PayPal payment the ORDER can be separated from the subsequent authorization and the following steps. Separate authorization is only possible after the order (TxType=Order) is completed.

For a separate authorization with PayPal, please use the following URL:


Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

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

Parameters for PayPal authorization


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

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

n8

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

Response parameters for PayPal authorization



Capture

To carry out a capture for PayPal via a Server-to-Server connection, please use the following URL:


Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

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

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

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

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. 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 einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

Key

Format

CND

Description

Beschreibung

TIDans..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 PayPal Capture ID.
CompleteTypeans..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).

Parameters for PayPal captures


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

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

n8

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

Result parameters for PayPal captures



Credit with reference

To carry out a credit with a reference transaction for PayPal, please use the following URL:


Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

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 to be credited

Vom Paygate vergebene ID für die gutzuschreibende Zahlung

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

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

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

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. 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 einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

Key

Format

CND

Description

Beschreibung

TIDans..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 PayPal Capture ID.
Noteans..768CExplanatory text for recipientErläuterungstext für den Empfänger
Subjectans..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.

Parameters for PayPal credits with reference transaction


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

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

n8

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

FeeRefundAmount

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

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

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.

Response parameters for PayPal credits with reference transaction



Credit without reference

In order to initiate a credit without reference transaction for PayPal payment, please use the following URL:


Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

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
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

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

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

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. 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 einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

Key

Format

CND

Description

Beschreibung

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

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

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

Parameters for PayPal credits without reference transaction


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

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

n8

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

FeeRefundAmount

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

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

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.

Response parameters for PayPal credits without reference transaction



Reversal

In order to cancel a transaction with PayPal, please use the following URL:


Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

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 to be reversed

Vom Paygate vergebene ID für die zu stornierende Zahlung

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

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

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. 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 einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

Parameters for PayPal reversals


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

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

n8

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

Result parameters for PayPal reversals



Batch processing via the interface

Basic information about using Batch files and about their structure can be found in the Batch Manager manual. Within batch processing not alle functions are available which are usually available for the online interface.

This section describes the parameters which must be transferred within the data set (Record) for executing a PayPal payment and which information can be found within the response file about the payment status.

For Batch calls there must be considered batch versions, from which optional parameters depend. All version designations starting with „2.“ pertain calls for a group of enterprises. That means within a batch file for a particular MerchantID can be transferred transactions for other merchants with a separate Sub-MID.

Following table gives an overview of all batch versions that are possible for a specific action and their specialities:

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

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)

Description of the possible batch versions


The structure for a PayPal payment within a Batch file to be submitted is the following:

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>)
FOOT,<CountRecords>,<SumAmount>

Example for Master MID function:

HEAD,[Master]MerchantID,Date,2.x
Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action)
FOOT,CountRecords,SumAmount

Notice: In Version 1.4 it is also possible to transfer CompleteType together with a Capture action:

PAYPAL,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>(,<CompleteType>,<TID>)

 

The following table describes the individual fields and values used within the data set (record) in the batch file:

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)

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)

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.Auto oder Manual: legt fest, ob der angeforderte Betrag sofort oder zu einem späteren Zeitpunkt abgerechnet wird.
TyType

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

Description of fields within the record for Batch files

 

The record area within the response file for Batch transactions looks as follows:

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>
FOOT,<CountRecords>,<SumAmount>

The following table describes the response parameters which the Batch Manager saves in the Record area for each transaction (standard parameters not explained here, such as <TransID> or <RefNR> and request parameters are returned unchanged and correspond to the call as specified before):

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

n8

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

Description of result parameters within the record for Batch files