Maintenance Work Notice!

We will carry out maintenance work on this documentation on Tuesday, 15.06.2021 between 3 pm and 4 pm CEST. Thank you for your understanding.

Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space ENWORK and version Documentation

About PayPal

General information about PayPal

PayPal is one of the world’s leading eWallets for e- and m-Commerce. Around 179 million active members in over 200 countries pay for their online orders with PayPal. Customers in Germany can pay via direct debit, giropay or credit card (American Express, Diners Club, Discover, MasterCard, Visa). Along with the above payment methods, PayPal PLUS offers purchase on account and purchase by instalment. Members log into their PayPal account with their email address and a password during checkout and choose the preferred payment method (direct debit, PayPal credit, credit card and, if applicable purchase on account or by instalment). The amount payable is then immediately credited to their own PayPal account. The usual direct debit periods for transfers or the delay resulting from distribution to collecting services do not apply. This allows real-time payments processing on the Internet.

PayPal Express Checkout

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Name
PageWithExcerptWording
offers the PayPal Express Checkout 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.
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
then sends the delivery address as a result parameter back to your shop.

Buyers and vendors are also protected.

PayPal offers buyers and merchants extensive buyer / vendor protection. 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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Name
PageWithExcerptWording
.

Payment online globally

PayPal is particularly beneficial for overseas customer acquisition. 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Name
PageWithExcerptWording
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 your customers with several payment methods at once.


Page properties
Logo

Info
Excerpt

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
also processes PayPal payments, which offers you worldwide merchant protection and a potential of 179 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 EN

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

Process flow charts

Multiexcerpt
MultiExcerptNameProcessFlow


draw.io Diagram
bordertrue
diagramNamePaypal Payment
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth1109

PayPal process flow within from merchant's perspective


draw.io Diagram
bordertrue
diagramNamePaypal Shortcut
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth1109



Important information

Please note that, unlike our currency table, the currencies HUF (Hungarian - Forints) 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.

On this page

Table of Contents
exclude(Auf dieser Seite|In diesem Abschnitt|On this page|In this section).*


Configuration for PayPal

To process PayPal transactions via the

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Name
PageWithExcerptWording
as merchant you need to have a PayPal business account . You also need to enable the PayPal interface for use via 
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
and to make the necessary settings for receiving payments.

Create and configure the PayPal business account

  1. Please call the PayPal URL of your country, e.g. http://www.paypal.co.uk.
  2. Use the Button „Sign Up“ to open a new business account

  3. The following page shows possible account types which can be created.
  4. Please choose “Business Account” and press “Continue”.

  5. Now you are forwarded to the page "Create Business Account". Please enter your email address, which will be used for your PayPal Account and press “Continue”.

  6. Please enter here your Business information. Accept the User Agreement and press the button “Agree and Continue”.

  7. Please complete the required information about your company on the next pages.
  8. In the next step you will get an email to confirm your email address. Please confirm your email address.

  9. Please add the further required information about your company.


Setting up the API permission

In order to process PayPal transactions through

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Name
PageWithExcerptWording
you will need to setup an API permission Therefore please complete the six steps explained below.

  1. Please go to the menu -> Profile -> Profile and Settings

  2. Please go to „My selling preferences“ on the left side …

    … and then select „API access“, than complete with the link „Update“.

  3. Inside the API Access area, please choose “Grant API permission”

  4. Please enter the following API Third Party Username and press the button “Lookup” frank.arnoldt_api1.computop.de
  5. Please check the following API Access Level boxes, all other boxes remain unchecked. Press “Add” to confirm and finish API permission settings.
    - Use PayPal Express Checkout to process payments
    - Issue a refund for a specific transaction
    - Authorise and capture your PayPal transactions
    - Obtain information about a single transaction
    - Search your transactions for items that match specific criteria and display the results

  6. You will get the confirmation, that the third party supplier „frank.arnoldt_api1.computop.de“ was added.

 

Setting up PayPal-API permissions for Sandbox

For the PayPal Sandbox you can set up API permissions with the following steps.

  1. At https://developer.paypal.com below "Accounts" --> (Accountname) --> "Manage accounts" --> "View/ edit account" you will find the credentials of the respective merchant account.

  2. With this credentials please login at https://sandbox.paypal.com.

  3. Click on the name on the upper right and go to "Account settings".

  4. Click on "API access" --> "Set up API permission" --> Enter "test_paypal_api_api1.computop.com".

  5. Please check the boxes for following permissions:
    - Use PayPal Express to process payments
    - Issue a refund for a specific transaction
    - Authorise and capture your PayPal transactions
    - Obtain information about a single transaction
    - Search your transactions for items the match specific criteria and display the results


Settings for Payment Receiving Preferences

  1. Please go to “Profile” and click on “Profile and Settings”.


  2. Below "My selling preferences" please select "Block payments" with the link “Update”.

  3. Please use the following settings.
    - Block payments sent in a currency not provided
    - Block accidental payments with duplicate invoice IDs
    - Refuse following payments: Block payments with status „Pending“ (recommended) This option has no effect on eBay-payments.
    - Block payments from Student accounts under 18 years of age
    - Display “Add Instructions to Seller” text input field

    Please confirm your selected options by clicking on the "Save" button.


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
interface

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameDefinition
PageWithExcerptDefinition EN


Calling the interface

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
form:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
paypal.aspx


With this URL

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
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.

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

Notice: Please note that a PayPal connection in the shop via i-Frame is not possible due to PayPal-Regulations. Express Checkout always connects the Customer directly to PayPal.

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
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.
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
therefore supports several alternatives for the processing of PayPal payments: we shall be happy to advise you about the implementation of PayPal.


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620846626588_-1469180185
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepaypal_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620846626592_-1355834400
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_AmountMac
DisableCachingtrue
PageWithExcerptReuse API

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ans..30

O

Unique reference number

eindeutige Referenznummer

Capture

a..6

O

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

Important Note: Please contact

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
for Manual, to discuss different possibilities of usage.

Auto oder Manual: bestimmt, ob der angefragte Betrag sofort oder erst später abgebucht wird.

Wichtiger Hinweis: Bitte kontaktieren Sie den

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
für Manual, um die unterschiedlichen Einsatzmöglichkeiten abzuklären.

TxType

ans..5

C

Obligatory for Capture=Manual: Transaction type with possible values Order or Auth and BAID (BillingAgreementID)

Pflicht bei Capture=Manual: Transaktionstyp mit den möglichen Werten Order oder Auth sowie BAID (BillingAgreementID)

PayPalMethod

enum

O

The "shortcut" value selects the changed transaction procedure which takes the customer back to the shop for payment confirmation and e.g. in the case of purchase by instalment, displays the instalment purchase data which the customer then has to confirm.

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 und z.B. bei einem Ratenkauf die Ratenkaufdaten angezeigt werden, die er dann bestätigen muss.

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

RTF

ans1

O

For repeat payments (subscriptions):
I = Initial payment of a new subscription
R = Routine payment (Recurring)

In this case only RTF=I is allowed, other subscription payments are carried out via the separate paypalAbo.aspx interface.

Für wiederkehrende Zahlungen (Abos):
I = Initialzahlung eines neuen Abos,
R = Wiederkehrende Zahlung (Recurring)

Hier nur RTF=I zulässig, weitere Abo-Zahlungen werden über die separate Schnittstelle paypalAbo.aspx ausgeführt.

OrderDesc

ans..127

M

Description of purchased goods, unit prices etc.

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

Beschreibung der gekauften Waren, Einzelpreise etc.

(info) Wenn OrderDesc(n) verwendet wird, muss gelten: Amount=ItemTotal+TaxTotal+ShAmount

OrderDesc(n)

ans..2048

O

Customers shopping basket in the form:

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

OrderDesc2 to max. OrderDesc99 permissible

For correct execution of displaying function all OrderDesc(n) Amounts must equal to the parameter Amount.

Warenkorb des Kunden in der Form:

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

OrderDesc2 bis max. OrderDesc99 zulässig

Zur korrekten Ausführung der Darstellungsfunktion müssen alle OrderDesc(n) Amounts mit dem übergebenen Parameter Amount übereinstimmen.

TaxTotal

n..10

C

Mandatory, if +Tax is given in description of OrderDesc(n): Total amount of taxes of all single articles in the smallest currency unit (e.g. EUR Cent) = Sum(Tax*Number)

Pflicht, wenn bei OrderDesc(n) die Beschreibung +Tax angegeben wird. Gesamtbetrag der Steuern aller einzelnen Artikel in der kleinsten Währungseinheit (z.B. EUR Cent) = Summe(Tax*Number)

ItemTotal

n..10

C

Mandatory, if +tax is given in description of OrderDesc(n): Gross amount of all single articles in the smallest currency unit (e.g. EUR Cent) = Sum(Amount*Number)

Pflicht, wenn bei OrderDesc(n) die Beschreibung +Tax angegeben wird. Gesamtbetrag der einzelnen Artikel in der kleinsten Währungseinheit (z.B. EUR Cent) = Summe(Amount*Number)

ShAmount

n..10

O

Shipping costs in the smallest currency unit (e.g. EUR Cent). Can be uses only in connection with parameters ItemTotal and TaxTotal.

Versandkosten in der kleinsten Währungseinheit (z.B. EUR Cent). Kann nur in Verbindung mit den Parametern ItemTotal und TaxTotal verwendet werden.

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Table Excerpt Include
statictrue
nameURLSuccess
pageURLSuccess
typepage

Table Excerpt Include
statictrue
nameURLFailure
pageURLFailure
typepage

Table Excerpt Include
statictrue
nameResponse
pageResponse
typepage

Table Excerpt Include
statictrue
nameURLNotify
pageURLNotify
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
nameexpirationTime
pageexpirationTime
typepage

Key

Format

CND

Description

Beschreibung

Account

ans..128

O

For managing multiple PayPal accounts, Merchant account: ID or e-Mail address for which the request should be submitted to PayPal

Zur Steuerung mehrerer PayPal-Accounts, Händler-Account: ID oder E-Mail-Adresse, für die die Anfrage an PayPal gesendet werden soll

BrandName

ans..127

O

Brand name to be displayed on login page

Auf der Login-Seite angezeigter Markenname

HeaderLogo

ans..127

O

URL for a logo image in the login area. Graphic formats GIF, JPG or PNG with maximally 190 x 60 pixels. Larger logos are cut off by PayPal. PayPal displays the logo at the top in the shopping cart.

URL für ein Logo-Bild im Login-Bereich. Grafikformate GIF, JPG oder PNG mit maximal 190 x 60 Pixeln. Größere Logos werden von PayPal abgeschnitten. PayPal zeigt das Logo oben im Warenkorb an.

LandingPage

ans

O

Controls how the PayPal page is displayed. Possible values are “Login” or “Billing”

Steuert, wie die PayPal-Seite angezeigt wird. Mögliche Werte „Login“ oder „Billing“

FundingSource

a..7

O

For PayPal hire purchase: „FINANCE“

Presently PayPal hire purchase is offered for customers with German billing address in EUR starting from a shopping basket of 99 EUR. Before confirming the order the hire purchase data must be displayed to the customer. Therefore the PayPal method “shortcut” must be used. Additionally the LineItems must be transferred within the OrderDesc parameters incl. taxtotal, itemtotal and shamount.

Für PayPal Ratenkauf: „FINANCE“

Die PayPal Ratenzahlung wird aktuell für Kunden mit deutscher Rechnungsadresse in EUR ab einem Warenwert von 99 EUR angeboten. Vor der Bestätigung der Bestellung müssen die Ratenkaufdaten dem Kunden angezeigt werden. Dazu muss die PayPalMethod „shortcut“ verwendet werden. Zusätzlich ist die Übergabe der LineItems in den OrderDesc Parametern inkl. taxtotal, itemtotal und shamount erforderlich.

Language

an2

O

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

AU, DE, FR, IT, GB, ES, US; Standard DE

FirstName

ans..30

OC

(obligatory for USA and Canada): Either the first name only or first and second name if a company name is used as a delivery address.

(Pflicht für USA und Kanada): Entweder nur der Vorname oder Vor- und Nachname, falls ein Firmenname als Lieferadresse genutzt wird.

LastName

ans..30

OC

(obligatory for USA and Canada): Surname or name of the company of the delivery address

(Pflicht für USA und Kanada): Nachname oder Firmenbezeichnung der Lieferadresse

AddrStreet

ans..100

OC

(obligatory for USA and Canada): Street in the delivery address

(Pflicht für USA und Kanada): Straßenname der Lieferadresse

AddrStreet2

ans..100

O

Street in the delivery address

Straßenname der Lieferadresse

AddrCity

ans..40

OC

(obligatory for USA and Canada): Town/city in the delivery address

(Pflicht für USA und Kanada): Ortsname der Lieferadresse

AddrState

ans..40

OC

(obligatory for USA and Canada): Federal state of the delivery address. The town submitted in AddrCity must be located in the given federal state, otherwise PayPal refused this payment. For possible values please refer to the PayPal-API-reference documentation.

(Pflicht für USA und Kanada): Bundesland (Bundesstaat) der Lieferadresse. Die in AddrCity übergebene Stadt muss im angegebenen Bundesstaat liegen, sonst lehnt PayPal die Zahlung ab. Mögliche Werte entnehmen Sie bitte der PayPal-API-Reference Dokumentation.

AddrZip

ans..20

OC

(obligatory for USA and Canada): Postcode in the delivery address

(Pflicht für USA und Kanada): Postleitzahl der Lieferadresse

AddrCountryCode

an2

O

Country code of the delivery country

Ländercode des Lieferlandes

Phone

n..20

O

Telephone number

Telefonnummer

NoShipping

n1

O

Handover NoShipping=1 prevents the delivery address registered with Paypal from being displayed

Übergabe NoShipping=1 verhindert die Anzeige der bei PayPal hinterlegten Lieferadresse

AllowNote

ans..2

O

The value “no” prevents the option of sending a message to the merchant.

As standard a possible message is returned in the Infotext parameter.

Wert „no“ verhindert die Möglichkeit, eine Nachricht an den Händler zu übermitteln.

Standardmäßig wird eine eventuelle Mitteilung im Parameter Infotext zurückgegeben.

BuyerEMail

ans..127

OC

Pre-completion of an email address on the PayPal login page

Vorbelegung einer E-Mail-Adresse auf der Login-Seite von PayPal

NoteToBuyer

ans..165

O

Notice for the buyer

Hinweistext für den Käufer

Parameters for PayPal payments


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_IntroURL
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620849718943_537020069
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepaypal_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620849718948_-506999170
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pageMID
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

Status

a..30

M

OK, AUTHORIZE_REQUEST or Timeout (only if Capture=Manual) on the URLSuccess page or FAILED on the URLFailure page.

AUTHORIZE_REQUEST – Is returned actively only for request parameter "TxType=auth" or "PayPalMethod=shortcut". When using TxType=auth or without TxType the final status is returned directly.
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 beim Aufrufparameter "TxType=auth" bzw. "PayPalMethod=shortcut" aktiv versendet. Bei Verwendung von TxType=auth oder ohne TxType wird direkt der abschließende Status gemeldet.
Timeout – Alle offenen Zahlungsvorgänge im Status AUTHORIZE_REQUEST werden nach ~ 3h automatisiert geschlossen und als Timeout gemeldet.

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ans..30

O

Merchant’s unique reference number

Referenznummer des Händlers

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
nameCodeExt_n10
pageCodeExt
typepage

Key

Format

CND

Description

Beschreibung

Name

ans..32

M

First name and surname joined

Vorname und Nachname zusammengenommen

FirstNameans..30MFirst name of payer (PayerInfo, may differ from the account name)Vorname vom Bezahler (PayerInfo, kann vom Account-Namen abweichen)
LastNameans..30MLast name of payer (PayerInfo, may differ from the account name)Nachname vom Bezahler (PayerInfo, kann vom Account-Namen abweichen)
Firstnameans..30MFirst name of payer (PayerInfo, may differ from the account name)Vorname vom Bezahler (PayerInfo, kann vom Account-Namen abweichen)
Lastnameans..30MLast name of payer (PayerInfo, may differ from the account name)Nachname vom Bezahler (PayerInfo, kann vom Account-Namen abweichen)

E-Mail

ans..100

M

Email address of the purchaser.

E-Mail-Adresse des Käufers.

AddrStreet

ans..100

O

Street in the delivery address

Straßenname der Lieferadresse

AddrStreet2

ans..100

O

2. Street name in the delivery address, if agreed with 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording

2. Straßenname der Lieferadresse, wenn mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
abgestimmt

AddrCity

ans..40

O

Town/city in the delivery address

Ortsname der Lieferadresse

AddrState

ans..40

O

Federal State in the delivery address

Bundesland (Bundesstaat) der Lieferadresse

AddrZIP

ans..20

O

Postcode in the delivery address

Postleitzahl der Lieferadresse

AddrCountryCode

an2

O

Country code of the delivery country

Ländercode des Lieferlandes

Phone

n..20

O

Telephone number

Telefonnummer

BillingAgreementID

an19

M

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

Identifikationsnummer der Rechnungsvereinbarung. Wenn der Käufer die Rechnungsvereinbarung bestätigt, wird sie gültig und bleibt gültig, bis sie vom Käufer widerrufen wird.

BillingName

ans..32

O

First name and surname joined

Vorname und Nachname zusammengenommen

BillingAddrStreet

ans..100

O

Street name of the invoicing address lodged with PayPal

Straßenname der bei PayPal hinterlegten Rechnungsadresse

BillingAddrStreet2

ans..100

O

2. Street name of the invoicing address lodged with PayPal, if agreed with 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording

2. Straßenname der bei PayPal hinterlegten Rechnungsadresse, wenn mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
abgestimmt

BillingAddrCity

ans..40

O

Town/city name of the invoicing address saved with PayPal

Ortsname der bei PayPal hinterlegten Rechnungsadresse

BillingAddrState

ans..40

O

Federal state of the invoicing address saved with PayPal

Bundesland der bei PayPal hinterlegten Rechnungsadresse

BillingAddrZIP

ans..20

O

Postcode of the invoicing address saved with PayPal

Postleitzahl der bei PayPal hinterlegten Rechnungsadresse

BillingAddrCountryCode

an2

O

Country code of the delivery country

Ländercode des Lieferlandes

TransactionID

an..19

O

Unique transaction number from PayPal for a transaction (PayPal Order)

Eindeutige Transaktionsnummer von PayPal für eine Transaktion (PayPal Order)

TIDan..19OUnique transaction number from PayPal for an authorisation (PayPal Auth): Only for automatic PayPal configuration or if TxType=AuthEindeutige Transaktionsnummer von PayPal für eine Autorisierung (PayPal Auth): Nur bei automatischer PayPal-Konfiguration oder sonst wenn TxType=Auth
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 merchant

Nachricht an den Händler

PayerID

ans..13

O

(if response is activated): Unique identification number of customer account at PayPal

(wenn Rückgabe aktiviert ist): Eindeutige Identifikationsnummer des Kundenkontos bei PayPal

IsFinancing

ans..5

C

Purchase by instalment only: Indicates whether this is purchase by instalment: Value „TRUE“ or „FALSE“

Nur bei Ratenkauf: gibt an, ob es sich um einen Ratenkauf handelt: Wert „TRUE“ oder „FALSE“

FinancingFeeAmount

ans..9

C

Only in case of hire purchase: Hire purchase fee. (Forwarded from PayPal; presently no conversion into smallest currency unit)

Nur bei Ratenkauf: Ratenkauf-Gebühr. (Weitergabe von PayPal; bisher keine Umrechnung in kleinste Einheit je Währung)

FinancingMonthlyPayment

ans..9

C

Only in case of hire purchase: Estimated amount incl. fees, which customer has to pay each month. (Forwarded from PayPal; presently no conversion into smallest currency unit)

Nur bei Ratenkauf: geschätzter Betrag inkl. Gebühren, der durch den Kunden pro Monat gezahlt wird. (Weitergabe von PayPal; bisher keine Umrechnung in kleinste Einheit je Währung)

FinancingTerm

an..2

C

Only in case of hire purchase: Number of installments (6, 12, 18 and 24 are possible)

Nur bei Ratenkauf: Anzahl der Raten (6, 12, 18 und 24 möglich)

FinancingTotalCost

ans..9

C

Only in case of hire purchase: Estimated amount incl. fees, which customer has to pay in total. (Forwarded from PayPal; presently no conversion into smallest currency unit)

Nur bei Ratenkauf: geschätzter Betrag inkl. Gebühren, der durch den Kunden gesamt gezahlt wird. (Weitergabe von PayPal; bisher keine Umrechnung in kleinste Einheit je Währung)

GrossAmount

an..9

O

Final amount charged, including any shipping and taxes from your Merchant Profile

Endgültig berechneter Betrag einschließlich Lieferkosten und Steuern von Ihrem Händlerprofil

FeeAmount

an..9

O

PayPal fee amount charged for the transaction

Betrag der für die Transaktion berechneten PayPal-Gebühr

SettleAmount

an..9

O

Amount deposited in your PayPal account after a currency conversion

Ihrem PayPal-Konto nach einer Währungsumrechnung gutgeschriebener Betrag

TaxAmount

an..9

O

Tax charged on the transaction

Für die Transaktion berechnete Steuer

ExchangeRate

an..17

O

Exchange rate if a currency conversion occurred. Relevant only if you are billing in their non-primary currency. If the buyer chooses to pay with a currency other than the non-primary currency, the conversion occurs in the buyer's account

Wechselkurs bei einer Währungsumrechnung. Nur relevant, wenn die Rechnung nicht in der primären Währung ausgestellt ist. Wenn der Käufer in einer anderen als der nicht primären Währung bezahlt, erfolgt die Umrechnung im Händlerkonto.

mc_fee

an..9

C

Only in case of separate Notify from PayPal: Transaction fee associated with the payment. mc_gross minus mc_fee equals the amount deposited into the receiver_email account. Equivalent to payment_fee for USD payments. If this amount is negative, it signifies a refund or reversal, and either of those payment statuses can be for the full or partial amount of the original transaction fee

Nur bei separatem Notify von PayPal: Transaktionsgebühr für die Zahlung. mc_gross minus mc_fee entspricht dem Betrag, der dem Empfängerkonto gutgeschrieben wird. Ist äquivalent zur payment_fee bei Zahlung in US-Dollar. Ein negativer Betrag signalisiert ein Storno oder eine Gutschrift. Beide Zahlungs-Status können für den vollständigen oder teilweisen Betrag der ursprünglichen Transaktionsgebühr sein.

mc_gross

an..9

C

Only in case of separate Notify from PayPal: Full amount of the customer's payment, before transaction fee is subtracted. Equivalent to payment_gross for USD payments. If this amount is negative, it signifies a refund or reversal, and either of those payment statuses can be for the full or partial amount of the original transaction.

Nur bei separatem Notify von PayPal: Gesamtbetrag der Zahlung des Kunden vor Abzug der Transaktionsgebühr. Ist äquivalent zu payment_gross bei Zahlung in US-Dollar. Ein negativer Betrag signalisiert ein Storno oder eine Gutschrift. Beide Zahlungs-Status können für den vollständigen oder teilweisen Betrag der ursprünglichen Transaktionsgebühr sein.



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 and e.g. in the case of purchase by instalment, displays the instalment purchase data which the customer then has to confirm. To complete this PayPal payment in the next step, use the following URL and parameters:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
paypalComplete.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro_Short
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620851108089_1509549929
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepaypalComplete_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620851108093_374907579
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Amount
PageWithExcerptReuse API

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

PayID

an32

M

ID assigned by

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
for the payment.

Enter the PayID from the response from paypal.aspx received in the previous transaction procedure.

Vom

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
vergebene ID für die Zahlung.

Übergeben Sie hier die PayID aus der Antwort von paypal.aspx, die Sie im bisherigen Transaktionsablauf erhalten haben.

RefNr

ans..30

O

Unique reference number

eindeutige Referenznummer

OrderDesc(n)

ans..2048

O

Customers shopping basket in the form:

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

OrderDesc2 to max. OrderDesc99 permissible

For correct execution of displaying function all OrderDesc(n) Amounts must equal to the parameter Amount.

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

Notice: If OrderDesc(n) is changed also the Amount has to be modified.

Warenkorb des Kunden in der Form:

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

OrderDesc2 bis max. OrderDesc99 zulässig

Zur korrekten Ausführung der Darstellungsfunktion müssen alle OrderDesc(n) Amounts mit dem übergebenen Parameter Amount übereinstimmen.

(info) Wenn OrderDesc(n) verwendet wird, muss gelten: Amount=ItemTotal+TaxTotal+ShAmount

Hinweis: Bei Änderung von OrderDesc(n) muss auch der Amount angepasst werden.




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

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

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: Street in the delivery address

Pflicht, wenn FirstName übergeben wird: Straßenname der Lieferadresse

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"


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620852050555_1037517711
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepaypalComplete_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620852050557_-808512163
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pageMID
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

Status

a..30

M

OK or FAILEDOK oder FAILED

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ans..30

O

Merchant’s unique reference number

Referenznummer des Händlers

Table Excerpt Include
statictrue
nameCodeExt_n10
pageCodeExt
typepage

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, call the following URL:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
Authorize.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro_Short
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620970232305_287504007
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameAuthorize_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620970232308_887635514
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Amount
DisableCachingtrue
PageWithExcerptReuse API

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Key

Format

CND

Description

Beschreibung

TransID

ans..64

M

TransactionID which should be unique for each payment

TransaktionsID, die für jede Zahlung eindeutig sein muss

TxType

ans..5

M

Transaction type Auth

Transaktionstyp Auth

FirstName

ans..30

O

Either the first name only or first and second name if a company name is used as a delivery address.

Entweder nur der Vorname oder Vor- und Nachname, falls ein Firmenname als Lieferadresse genutzt wird.

LastName

ans..30

O

Surname or name of the company of the delivery address

Nachname oder Firmenbezeichnung der Lieferadresse

AddrStreet

ans..100

O

Street in the delivery address

Straßenname der Lieferadresse

AddrStreet2

ans..100

O

2. Street name in the delivery address, if agreed with 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording

2. Straßenname der Lieferadresse, wenn mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
abgestimmt

AddrCity

ans..40

O

Town/city in the delivery address

Ortsname der Lieferadresse

AddrState

ans..40

O

Federal state of the delivery address. The town submitted in AddrCity must be located in the given federal state, otherwise PayPal refused this payment. For possible values please refer to the PayPal-API-reference documentation.

Bundesland (Bundesstaat) der Lieferadresse. Die in AddrCity übergebene Stadt muss im angegebenen Bundesstaat liegen, sonst lehnt PayPal die Zahlung ab. Mögliche Werte entnehmen Sie bitte der PayPal-API-Reference Dokumentation.

AddrZip

ans..20

O

Postcode in the delivery address

Postleitzahl der Lieferadresse

AddrCountryCode

an2

O

Country code of the delivery country

Ländercode des Lieferlandes

Phone

n..20

O

Telephone number

Telefonnummer

Parameters for PayPal authorization



Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620852268168_2125038567
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameAuthorize_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620852268169_-870227096
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pageMID
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

Status

a..30

M

OK or FAILEDOK oder FAILED

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameCodeExt_n10
pageCodeExt
typepage

Response parameters for PayPal authorization



Calling the interface for a capture

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
capture.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620970570944_-307437493
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecapture_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620970570946_1458520026
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Amount
DisableCachingtrue
PageWithExcerptReuse API

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ans..30

O

Merchant reference number: here a separate reference number, e.g. an invoice number, can be transferred

Referenznummer des Händlers: hier kann eine separate Referenznummer wie z.B. Rechnungsnummer übergeben werden

TID

ans..17

O

PayPal unique transaction number Required for part postings to previous authorisations.

Eindeutige Transaktionsnummer bei PayPal. Notwendig bei Teilbuchungen auf vorangegangene Autorisierungen.

CompleteType

ans..3

O

If <YES> is transferred, the possible open order of PayPal is closed on capture. (Reason: a 115% capture is permissible on the part of PayPal. If a capture reached 100%,

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
automatically sends a request to close the payment).

Wird <YES> übergeben, wird bei der Buchung die mögliche offene Order von PayPal geschlossen. (Hintergrund: seitens PayPal ist eine 115% Buchung zulässig. Bei Buchung ab 100% sendet das

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePlatform-Kurz
PageWithExcerptDE:Wording
automatisch einen Aufruf zum Schließen der Zahlung an PayPal.)

Parameters for PayPal captures


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620852359748_1551040040
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecapture_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620852359749_896091302
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pageMID
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

Status

a..30

M

OK or FAILEDOK oder FAILED

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameCodeExt_n10
pageCodeExt
typepage

Key

Format

CND

Description

Beschreibung

TIDans..17OPayPal unique transaction number. Required for part postings to previous authorisations.Eindeutige Transaktionsnummer bei PayPal. Notwendig bei Teilbuchungen auf vorangegangene Autorisierungen.

Result parameters for PayPal captures



Calling the interface for a credit with reference

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
credit.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API


Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620970852057_1890185544
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecredit_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620970852059_838120044
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Amount
PageWithExcerptReuse API

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ans..30

O

Merchant reference number: here a separate reference number, e.g. an invoice number, can be transferred

Referenznummer des Händlers: hier kann eine separate Referenznummer wie z.B. Rechnungsnummer übergeben werden

Account

ans..128

O

For managing multiple PayPal accounts, Merchant account: ID or e-Mail address for which the request should be submitted to PayPal

Zur Steuerung mehrerer PayPal-Accounts, Händler-Account: ID oder E-Mail-Adresse, für die die Anfrage an PayPal gesendet werden soll

TID

ans..17

O

PayPal unique transaction number Required for part credit notes to prior partial captures.

Eindeutige Transaktionsnummer bei PayPal. Notwendig bei Teilgutschriften auf vorangegangene Teilbuchungen.

Note

ans..768

C

Explanatory text for recipient

Hinweistext für Empfänger

Subject

ans..255

C

MassPay: E-Mail subject to recipient

MassPay: Betreff für E-Mail an Empfänger

Parameters for PayPal credits with reference transaction


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620852501605_-424366243
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecredit_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620852501607_-2146160541
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pageMID
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

Status

a..30

M

OK or FAILEDOK oder FAILED

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameCodeExt_n10
pageCodeExt
typepage

Key

Format

CND

Description

Beschreibung

TIDans..17OPayPal unique transaction number. Required for part postings to previous authorisations.Eindeutige Transaktionsnummer bei PayPal. Notwendig bei Teilbuchungen auf vorangegangene Autorisierungen.

FeeRefundAmount

n..10

O

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

Gutgeschriebener Betrag der PayPal-Transaktionsgebühren. Notwendig bei Teilgutschriften auf vorangegangene Teilbuchungen.

GrossRefundAmount

n..10

O

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

Gutgeschriebener Betrag an den Käufer bei dieser Gutschrift. Notwendig bei Teilgutschriften auf vorangegangene Teilbuchungen.

NetRefundAmount

n..10

O

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

Von ihrem PayPal-Konto abgezogener Betrag, um diese Gutschrift auszuführen. Notwendig bei Teilgutschriften auf vorangegangene Teilbuchungen.

Response parameters for PayPal credits with reference transaction



Calling the interface for credits without reference

Use the following URL and parameters to initiate a credit without reference transaction for PayPal payment in the

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
form:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
paypalcreditEx.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro_Short
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620971170052_477182931
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepaypalcreditEx_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620971170055_1025233681
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Amount
PageWithExcerptReuse API

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ans..30

O

Merchant’s unique reference number

Referenznummer des Händlers: hier kann eine separate Referenznummer wie z.B. Rechnungsnummer übergeben werden

PayerID

ans..13

O

Unique identification number of customer account at PayPal

Eindeutige Identifikationsnummer des Kundenkontos bei PayPal

Note

ans..768

C

MassPay: Explanatory text for recipient

MassPay: Hinweistext für Empfänger

Subject

ans..255

C

MassPay: E-Mail subject to recipient

MassPay: Betreff für E-Mail an Empfänger

Payer

ans..100

O

MassPay: Email address of the purchaser:

MassPay: E-Mail-Adresse des Käufers

Parameters for PayPal credits without reference transaction


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620971356265_-343693621
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepaypalcreditEx_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620971356267_-128009615
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pageMID
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

Status

a..30

M

OK or FAILEDOK oder FAILED

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameCodeExt_n10
pageCodeExt
typepage

Key

Format

CND

Description

Beschreibung

FeeRefundAmount

n..10

O

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

Gutgeschriebener Betrag der PayPal-Transaktionsgebühren. Notwendig bei Teilgutschriften auf vorangegangene Teilbuchungen.

GrossRefundAmount

n..10

O

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

Gutgeschriebener Betrag an den Käufer bei dieser Gutschrift. Notwendig bei Teilgutschriften auf vorangegangene Teilbuchungen.

NetRefundAmount

n..10

O

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

Von ihrem PayPal-Konto abgezogener Betrag, um diese Gutschrift auszuführen. Notwendig bei Teilgutschriften auf vorangegangene Teilbuchungen.

Response parameters for PayPal credits without reference transaction



Call of
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
interface for reversals

To cancel a transaction with PayPal, please use the following URL:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
reverse.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro_Short
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620971449231_334576820
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamereverse_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620971449232_162513679
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Amount
DisableCachingtrue
PageWithExcerptReuse API

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Key

Format

CND

Description

Beschreibung

TID

ans..17

O

PayPal unique transaction number. Required for part cancellations of prior part authorisations.

Eindeutige Transaktionsnummer bei PayPal. Notwendig bei Teilstornierungen auf vorangegangene Teilautorisierungen.

Parameters for PayPal reversals


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620972809570_-475904105
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamereverse_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620972809573_2134651916
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pageMID
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

Status

a..30

M

OK or FAILEDOK oder FAILED

Table Excerpt Include
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameCodeExt_n10
pageCodeExt
typepage

Key

Format

CND

Description

Beschreibung

TIDans..17OPayPal unique transaction number. Required for part cancellations of prior part authorisations.Eindeutige Transaktionsnummer bei PayPal. Notwendig bei Teilstornierungen auf vorangegangene Teilautorisierungen.

Result parameters for PayPal reversals



Call of
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
interface for subscriptions

Requirements

  • The option „reference transaction“ has to be activated in your PayPal account. Please request the activation at PayPal directly.
  • In addtion, please configure the corresponding permission in your mechant PayPal account
  • Charge an existing customer based on a prior transaction
  • Obtain authorisation for pre-approved payments and initiate pre-approved transctions
  • The option “reference transaction” has to be activated for your
    Multiexcerpt include
    SpaceWithExcerptEN
    MultiExcerptNamePartner-Name
    PageWithExcerptWording
    MerchantID.

Process

  1. In order to process the initial recurring payment use paypal.aspx and add the parameter “RTF=I”. The additional parameter triggers a recurring flag to be recognized by PayPal. If you want to get the „BillingAgreementID“ only with the first request without to show the original amount to the customer, please submit the parameter "txtype=BAID" to
    Multiexcerpt include
    SpaceWithExcerptEN
    MultiExcerptNamePlatform-Kurz
    PageWithExcerptWording
    . If txtype=BAID is submitted,
    Multiexcerpt include
    SpaceWithExcerptEN
    MultiExcerptNamePlatform-Kurz
    PageWithExcerptWording
    sets the value automatically to 0,00.
    Please note, that the merchant never may send an amount of 0,00€, because
    Multiexcerpt include
    SpaceWithExcerptEN
    MultiExcerptNamePlatform-Kurz
    PageWithExcerptWording
    cannot process this.
    That means the merchant has to specify an amount X >0,00 an
    Multiexcerpt include
    SpaceWithExcerptEN
    MultiExcerptNamePlatform-Kurz
    PageWithExcerptWording
    changes this for PayPal to 0,00.
  2. You will receive PayPal`s standard parameters as well as the additional parameter “BillingAgreementID” in 
    Multiexcerpt include
    SpaceWithExcerptEN
    MultiExcerptNamePlatform-Name
    PageWithExcerptWording
    response. Please add and save this parameter in your system.
  3. In order to process the second/recurring payment, please use the URL
    Multiexcerpt include
    SpaceWithExcerptEN
    MultiExcerptNameBaseURL
    PageWithExcerptWording
    paypalAbo.aspx. In this server-to-server based request, please use the regular parameters as well as the parameter “BillingAgreementID”. The additional parameter triggers the second/recurring payment with reference to the initial recurring payment. This way amount withdrawals are available without the need of a customer login into PayPal.

Notice

  • The following addition will be displayed during payment process within the customer`s PayPal account (example):
    "Hereby you authorise –merchant name– for future direct withdrawals from your PayPal account without any action on your part. You can revoke this authorisation at any time within your profile."
  • The customer can obtain information about this function within his PayPal account.

Capture on demand (capture=manual + txtype=Order or Auth)

  • If you are initiating payments including txtype=Order or Auth
    Multiexcerpt include
    SpaceWithExcerptEN
    MultiExcerptNamePlatform-Name
    PageWithExcerptWording
    returns the "BillingAgreementID" for this action already within the notification. The "BillingAgreementID" is not necessary for the subsequent action capture. Only if a new payment is initiated it is necessary as a referral.

Deleting BillingAgreementID

  • The customer can revoke the BillingAgreementID in his PayPal account. The merchant will only be informed about the cancellation if the additional option IPN “instant payment notification” is activated for his account. The activation has to be done by the 
    Multiexcerpt include
    SpaceWithExcerptEN
    MultiExcerptNameHelpdesk-Name
    PageWithExcerptWording
    as well as PayPal account. Please keep in mind that by activating IPN the merchant receives a notification for each status change of a PayPal payment.
  • If a customer revokes the BillingAgreementID no further recurring payments are possible. It is also not possible to reactivate a BillingAgreementID.


Payment processing for subscriptions

The processing of PayPal payments by subscription requires an initial transaction to have been processed via the normal interface. Also the possibility of subscriptions must have been activated previously with both PayPal and

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
. Therefore the option “Reference transaction” muss be arranged with
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
and PayPal. Besides following 3 API Access Level boxes options must be checked in the section “Available permissions” during setup (see section Setting up the API permission above):

- Charge existing accounts based on earlier transactions
- Setup and manage subscription payments
- Request of authorization and initializing PayPal payments via merchant debit

Use the following URL and parameters to initiate a PayPal subscription payment in the

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
form:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
paypalAbo.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro_Short
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620974816059_-263240963
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepaypalAbo_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620974816061_1863522741
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Amount
DisableCachingtrue
PageWithExcerptReuse API

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ans..30

O

Merchant’s unique reference number which must be unique for each payment

Referenznummer des Händlers, die für jede Zahlung eindeutig sein muss

OrderDesc

ans..30


Description of purchased goods, unit prices etc.

Beschreibung der gekauften Waren, Einzelpreise etc.

Capture

a..6

M

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

Important Note: Please contact 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
for Manual, to discuss different possibilities of usage.

Auto oder Manual: bestimmt, ob der angefragte Betrag sofort oder erst später abgebucht wird.

Wichtiger Hinweis: Bitte kontaktieren Sie den

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
für Manual, um die unterschiedlichen Einsatzmöglichkeiten abzuklären.

TxType

ans..5

M

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

Pflicht bei Capture=Manual: Transaktionstyp mit den möglichen Werten Order sowie Auth

BillingAgreementID

an19

M

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

Identifikationsnummer der Rechnungsvereinbarung. Wenn der Käufer die Rechnungsvereinbarung bestätigt, wird sie gültig und bleibt gültig, bis sie vom Käufer widerrufen wird.

RTF

ans1

O

For repeat payments (subscriptions):
I = Initial payment of a new subscription
R = Routine payment (Recurring)

Bei wiederkehrenden Zahlungen (Abos):
I = Initialzahlung eines neuen Abos,
R = Wiederkehrende Zahlung (Recurring)

FirstName

ans..30

OC

(obligatory for USA and Canada): Either the first name only or first and second name if a company name is used as a delivery address.

(Pflicht für USA und Kanada): Entweder nur der Vorname oder Vor- und Nachname, falls ein Firmenname als Lieferadresse genutzt wird.

LastName

ans..30

OC

(obligatory for USA and Canada): Surname or name of the company of the delivery address

(Pflicht für USA und Kanada): Nachname oder Firmenbezeichnung der Lieferadresse

AddrStreet

ans..100

OC

(obligatory for USA and Canada): Street in the delivery address

(Pflicht für USA und Kanada): Straßenname der Lieferadresse

AddrCity

ans..40

OC

(obligatory for USA and Canada): Town/city in the delivery address

(Pflicht für USA und Kanada): Ortsname der Lieferadresse

AddrState

ans..40

OC

(obligatory for USA and Canada): Federal state of the delivery address. The town submitted in AddrCity must be located in the given federal state, otherwise PayPal refused this payment. For possible values please refer to the PayPal-API-reference documentation.

(Pflicht für USA und Kanada): Bundesland (Bundesstaat) der Lieferadresse. Die in AddrCity übergebene Stadt muss im angegebenen Bundesstaat liegen, sonst lehnt PayPal die Zahlung ab. Mögliche Werte entnehmen Sie bitte der PayPal-API-Reference Dokumentation.

AddrZip

ans..20

OC

(obligatory for USA and Canada): Postcode in the delivery address

(Pflicht für USA und Kanada): Postleitzahl der Lieferadresse

AddrCountryCode

an2

O

Country code of the delivery country

Ländercode des Lieferlandes

Phone

n..20

O

Telephone number

Telefonnummer

Parameters for PayPal subscriptions


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620975242612_1778676703
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepaypalAbo_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620975242613_-1045894826
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pageMID
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

Status

a..30

M

OK or FAILEDOK oder FAILED

Table Excerpt Include
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameCodeExt_n10
pageCodeExt
typepage

Key

Format

CND

Description

Beschreibung

BillingAgreementIDan19MIdentification number of the invoice agreement. When the buyer confirms the invoice agreement it is validated and remains valid until revoked by the buyer.Identifikationsnummer der Rechnungsvereinbarung. Wenn der Käufer die Rechnungsvereinbarung bestätigt, wird sie gültig und bleibt gültig, bis sie vom Käufer widerrufen wird.

Result parameters for PayPal subscriptions



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:

Action

Version

Description

Authorize

1.0 / 2.0

Standard version without return of parameter Code

 

1.4 / 2.4

with TID

Capture

1.0 / 2.0

Standard version without return of parameter Code

 

1.x / 2.x

with RefNr (valid for all versions other than 1.0)

 

1.4 / 2.4

with TID

Credit

1.0 / 2.0

Standard version without return of parameter Code

 

1.x / 2.x

with RefNr (valid for all versions other than 1.0)

 

1.4 / 2.4

with TID

CreditEx

1.0 / 2.0

Standard version without return of parameter Code

 

1.x / 2.x

with RefNr (valid for all versions other than 1.0)

Reverse

1.0 / 2.0

Standard version without return of parameter Code

 

1.4 / 2.4

with TID

Abo

1.0 / 2.0

Standard version without return of parameter Code

 

1.x / 2.x

with RefNr (valid for all versions other than 1.0)

Description of the possible batch versions


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

Multiexcerpt
MultiExcerptNameBatchStructureRequest
Code Block
HEAD,<MerchantID>,<Date>,<Version>
PAYPAL,Authorize,<Amount>,<Currency>,<TransID>,<PayID>
PAYPAL,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>(,<TID>)
PAYPAL,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>(,<TID>)
PAYPAL,CreditEx,<TransID>,(<RefNr>,)<Amount>,<Currency>,<payer>,<note>
PAYPAL,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>(,<TID>)
PAYPAL,ABO,<Amount>,<Currency>,<TransID>,(<RefNr>),(<OrderDesc>),(<Capture>),(<TxType>,)<BillingAgreementId>
FOOT,<CountRecords>,<SumAmount>



Example for Master MID Funktion:

Multiexcerpt
MultiExcerptNameBatchSampleRequest
Code Block
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:

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620977626636_-806102684
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameBatch_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620977626639_-992655376
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

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 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
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 stimmen sie sich hierzu vorher mit dem

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
ab)

Reverse (Storno)
Abo (Abonnement)

RefNr

ans..30

O

Unique reference number

eindeutige Referenznummer

payer

ans..100

O

MassPay: Email address of the purchaser: In this case you transfer the received email parameter from the Response

MassPay: E-Mail-Adresse des Käufers: Übergeben Sie hier den erhaltenen Parameter E-Mail aus der Response

note

ans..758

O

Explanatory text for recipient

Hinweistext für Empfänger

TID

ans..17

O

PayPal unique transaction number Required for a number of authorisations or part captures, part credit notes or part cancellations.

Eindeutige Transaktionsnummer bei PayPal. Notwendig bei mehreren Autorisierungen oder Teilbuchungen, Teilgutschriften, Teilstornierungen.

OrderDesc

ans..127

O

Description of purchased goods, unit prices etc.

Beschreibung der gekauften Waren, Einzelpreise etc.

Capture

a..6

O

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

Auto oder Manual: bestimmt, ob der angefragte Betrag sofort oder erst später abgebucht wird.

TxType

ans..5

OC

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

Pflicht bei Capture=Manual: Transaktionstyp mit den möglichen Werten Order sowie Auth

BillingAgreementID

an19

M

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

Identifikationsnummer der Rechnungsvereinbarung. Wenn der Käufer die Rechnungsvereinbarung bestätigt, wird sie gültig und bleibt gültig, bis sie vom Käufer widerrufen wird.

Description of fields within the record for Batch files

 

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


Multiexcerpt
MultiExcerptNameBatchSampleResponse
Code Block
HEAD,<MerchantID>,<Date>,<Version>
PAYPAL,Authorize,<Amount>,<Currency>,<TransID>,<PayID>,<Status>,<Code>,<CodeExt>
PAYPAL,Capture,<Betrag>,<Währung>,<TransID>,(<RefNr>,)<PayID>,(TID,)<Status>,<Code>,<CodeExt>
PAYPAL,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,(TID,)<Status>,<Code>,<CodeExt>
PAYPAL,CreditEx,<TransID>,(<RefNr>,)<Amount>,<Currency>,<payer>,<note>,<Status>,<Code>,<CodeExt>
PAYPAL,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>,<CodeExt>
PAYPAL,ABO,<Amount>,<Currency>,<TransID>,(<RefNr>),(<OrderDesc>),(<Capture>),(<TxType>,)<BillingAgreementId>,<CodeExt>,<PayID>,<Status>,<Code>
FOOT,<CountRecords>,<SumAmount>

 

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

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1620977953308_2051676018
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameBatch_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1620977953309_-1853933545
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*


Key

Format

CND

Description

Beschreibung

Action

a..20

M

The parameter Action defines the type of transaction like capture or credit.

Der Action-Parameter definiert die Art der Transaktion wie Capture (Buchung) oder Credit (Gutschrift).

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Key

Format

CND

Description

Beschreibung

Status

a..50

M

OK or FAILED

OK oder FAILED

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameCodeExt
pageCodeExt
typepage

Description of result parameters within the record for Batch files