Paypal
Intro
Are you migrating from legacy to Direct?
Mind that this payment method requires a different configuration for Direct than for legacy. Once activated for Direct, these payment methods will stop working on legacy. Activate them only when you are prepared to transition to Direct. To exclude them on legacy, use the parameter "EXCLPMLIST" (example: EXCLPMLIST=PayPal;Przelewy24;Eps;POSTFINANCEefinance).
Activate this payment method for Direct as described in the "Configure Merchant Portal" guide.
PayPal is a leading global digital wallet, utilised by over 400 million active users in more than 200 markets. PayPal provides a seamless, secure, and flexible payment experience, accepting various methods including credit and debit cards and "Pay later" options.
Our platform's robust PayPal integration ensures that when customers select PayPal at checkout, they are redirected to their PayPal account to confirm payment details. The transaction is securely processed, with immediate confirmation sent to both you and the customer regarding payment status.
With its high security standards and versatile payment methods portfolio, PayPal enhances purchasing power and potentially raising average order values and conversion rates.
The integration is very easy, as you only need to send a few additional properties along with your request.
PayPal is phasing out its legacy API and migrating to the PayPal Complete Payment.
To guarantee uninterrupted transaction processing and to offer PayPal’s newest features, we will upgrade our connection with PayPal accordingly in 2025.
By doing so, PayPal will support
- A simplified onboarding/activation procedure.
- Full-stack PayPal payment processing for merchants.
- Improved fraud prevention.
To offer these features to you, we will migrate your existing integration in the months to come. We will contact you in time, informing you about necessary modifications in your PayPal integration.
You can test the upgraded version already in our test environment now. To do so, follow these steps:
- Login to the Merchant Portal test environment. Go to direct.MerchantPortal.BusinessTab > direct.MerchantPortal.BusinessTab.PaymentMethodsSubTab > PayPal.
- Follow the Integrated Sign Up (ISU) process to access or create a PayPal account.
- Once configured, the PayPal Platform Commerce is active, offering the features mentioned above.
Onboarding
Follow the instructions in the "Additional information" chapter to activate PaypPal in your account.
Countries & currencies
Supported countries
-
Afghanistan
-
Albania
-
Algeria
-
American Samoa
-
Andorra
-
Angola
-
Anguilla
-
Antigua and Barbuda
-
Argentina
-
Armenia
-
Aruba
-
Australia
Austria
Azerbaijan
Bahamas
Bahrain
Bangladesh
Barbados
Belarus
Belgium
Belize
Benin
Bermuda
Bhutan
Bolivia
Bonaire, Saba and Sint Eustatius
Bosnia and Herzegovina
Botswana
Brazil
Brunei
Bulgaria
Burkina Faso
Burundi
Cambodia
Cameroon
Canada
Cape Verde
Cayman Islands
Central African Republic
Chad
Chile
China
Colombia
Comoros
Congo (Democratic Republic)
Congo (Republic)
Cook Islands
Costa Rica
Croatia
Cyprus
Czech Republic
Denmark
Djibouti
Dominican Republic
Dominica
Ecuador
Egypt
El Salvador
Eswatini
Equatorial Guinea
Eritrea
Estonia
Ethiopia
Falkland Islands
Faroe Islands
Fiji
Finland
France
French Guiana
French Polynesia
Gabon
Gambia
Georgia
Germany
Ghana
Gibraltar
Greece
Greenland
Grenada
Guadeloupe
Guam
Guatemala
Guinea
Haiti
Honduras
Hong Kong
Hungary
Iceland
India
Indonesia
Iraq
Ireland
Israel
Italy
Ivory Coast
Jamaica
Japan
Jordan
Kazakhstan
Kenya
Kiribati
Kuwait
Kyrgyzstan
Laos
Latvia
Lebanon
Lesotho
Liberia
Libya
Liechtenstein
Lithuania
Luxembourg
Macao
Macedonia
Madagascar
Malawi
Malaysia
Maldives
Mali
Malta
Marshall Islands
Martinique
Mauritania
Mauritius
Mexico
Micronesia
Moldova
Monaco
Mongolia
Montenegro
Morocco
Mozambique
Myanmar
Namibia
Nauru
Nepal
Netherlands Antilles
Netherlands
New Caledonia
New Zealand
Nicaragua
Nigeria
Niger
Niue
Norfolk Island
Northern Mariana Islands
Norway
Oman
Pakistan
Palau
Panama
Papua New Guinea
Paraguay
Peru
Philippines
Poland
Portugal
Puerto Rico
Qatar
Réunion
Romania
Russia
Rwanda
Saint Helena
Saint Kitts and Nevis
Saint Lucia
Saint Pierre and Miquelon
Saint Vincent and The Grenadines
Samoa
San Marino
São Tomé and Príncipe
Saudi Arabia
Senegal
Serbia
Seychelles
Sierra Leone
Singapore
Slovakia
Slovenia
Solomon Islands
Somalia
South Africa
South Korea
Spain
Sri Lanka
Sudan
Suriname
Sweden
Switzerland
Taiwan
Tajikistan
Tanzania
Thailand
Togo
Tonga
Trinidad and Tobago
Tunisia
Turkmenistan
Turks and Caicos Islands
Tuvalu
Uganda
Ukraine
United Arab Emirates
United Kingdom
United States
Uruguay
Uzbekistan
Vanuatu
Vatican City
Venezuela
Vietnam
Virgin Islands (British)
Virgin Islands (U.S.)
Yemen
Zambia
Zimbabwe
Supported currencies
- Australian dollar (AUD)
- Brazilian real (BRL)
- Canadian dollar (CAD)
- Czech koruna (CZK)
- Danish krone (DKK)
- Euro (EUR)
- Hong Kong dollar (HKD)
- Hungarian forint (HUF)
- Israeli new shekel (ILS)
- Japanese yen (JPY)
- Malaysian ringgit (MYR)
- Mexican peso (MXN)
Integration
Redirect your customers to the Paypal payment portal via our Hosted Checkout Page. Find a high level overview in the "Process flows" chapter.
Our platform allows both Express Checkout Mark and Express Checkout Shortcut mode. Depending on the mode, differences apply:
Express Checkout Mark mode
Add the following properties to a standard CreateHostedCheckout request:
{
"order": {
"amountOfMoney": {
"currencyCode": "EUR",
"amount": 1000
}
},
"hostedCheckoutSpecificInput": {
"returnUrl": "https://yourReturnURL.com"
},
"redirectPaymentMethodSpecificInput": {
"paymentProduct840SpecificInput": {
"addressSelectionAtPayPal": false
},
"paymentProductId": "840"
}
}
Express Checkout Shortcut mode
Add the following properties to a standard CreateHostedCheckout request:
{
"order": {
"amountOfMoney": {
"currencyCode": "EUR",
"amount": 1000
}
},
"hostedCheckoutSpecificInput": {
"returnUrl": "https://yourReturnURL.com"
},
"redirectPaymentMethodSpecificInput": {
"paymentProduct840SpecificInput": {
"addressSelectionAtPayPal": true
},
"paymentProductId": "840"
}
}| Properties | Remarks |
|---|---|
|
redirectPaymentMethodSpecificInput |
paymentProductId: The numeric identifier of the payment method on our platform. Find this id in the "Overview" chapter. It instructs our platform to send your customers directly to the Paypal portal. If omitted, our platform sends your customers to the Hosted Checkout Page instead, allowing them to choose this or any other payment method that is active in your account. requiresApproval: Set to either "true"/"false" depending on whether you want to process payments in authorisation/Direct Sale mode. |
|
paymentProduct840SpecificInput.addressSelectionAtPayPal |
Define whether to allow your customers to select a previously stored shipping address on the Paypal checkout page.
|
|
hostedCheckoutSpecificInput.returnUrl |
The URL we redirect your customers to after the payment has been finalised. |
Find detailed information about this object and its properties in our CreateHostedCheckoutAPI.
Process flows
- Your customers finalise an order in your shop and select PayPal.
- You send one of these CreateHostedCheckout requests (Express Checkout Mark or Express Checkout Shortcut) to our platform.
- You redirect your customers via the redirectUrl to the PayPal portal. They confirm the order with their login credentials (email address and password).
- We receive the transaction result.
- We redirect your customer to your returnUrl
- You request the transaction result from our platform via GetHostedCheckout or receive the result via webhooks.
- If the transaction was successful, you can deliver the goods / services.
Testing
Refer to our Test cases for test data and detailed instructions.
Make sure to use the right endpoint and switch back to the live URL as soon as you have finished your tests.
Additional information
To offer this payment method to your customers, make sure to
- Sign an acquiring contract with PayPal and activate the payment method in your PSPID. We are happy to assist you.
- Create PayPal test / live accounts and link them to our platform.
- Set up your PayPal account.
- Configure the payment method in your PSPID.
Check out the following chapters to get all set!
Create PayPal test/live accounts
Both our and PayPal's test environment offer you to test your integration before going live.
Linking your Direct test account to the PayPal Sandbox with dedicated test credentials allow you to stage scenarios in a safe and realistic way. Create your test account on our platform and learn here how to set up the PayPal Sandbox for end-to-end testing.
Once you are done testing, create your live account on our platform and your PayPal live account and configure them both.
Make sure to switch to the LIVE endpoint as soon as you have finalised your tests.
Configure Merchant Portal
Are you using the Back Office?
As per requirement by PayPal, activating the payment method needs to go through the Merchant Portal.
Access the Merchant Portal via the Back Office by clicking on the "Try our new Merchant Portal" button to follow the procedure described below. You can return to the Back Office via the tile menu by clicking on the "Back Office" button.
To activate PayPal in your account, follow these steps:
- Login to the Merchant Portal. Go to Business > Payment methods > PayPal.
- In "How to activate PayPal", click on "Create and login to your PayPal account".
- You are redirected to the PayPal Platform. If you do not have a PayPal account yet, create one using the Integrated Sign Up (ISU). If you already have an account, login via the ISU.
- Grant PayPal permission to connect your PayPal account with our platform by clicking on the "Allow" button. Click on the "Return" button to go back to the Merchant Portal.
- Go to Business > Payment methods > PayPal. Check in "How to activate PayPal" that the "PayPal Payer ID" field has been filled in. Click on the "Activate PayPal".
The payment method will now be available on your account and to your customers.