Paypal
Intro
Are you migrating from legacy to GoPay?
Mind that this payment method requires a different configuration for GoPay than for legacy. Once activated for GoPay, 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 GoPay 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 allowing your customers to pay in instalments while you get paid up front — at no extra cost to your business.
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.
Now available: PayPal Complete Payments – The all-in-one PayPal checkout solution
PayPal Complete Payments is PayPal's next-generation checkout platform, bringing together PayPal, Pay Later, and PayPal Vault through a single, unified integration.
In 2025, Worldline upgraded its PayPal connection to PayPal Complete Payments, giving merchants access to PayPal's latest features and improved conversion tools — without disrupting existing checkout flows.
Key benefits
- Simplified onboarding via the Merchant Portal using PayPal's Integrated Sign-Up (ISU) flow.
- In-context PayPal experiences seamlessly blended into your customers' checkout journey, reducing friction and abandonment.
- Pay Later as the most relevant PayPal Pay Later option at no extra cost to your business.
- Save payment methods (Vault) to securely store your customers' PayPal payment methods for one-click payments, subscriptions, and other MITs (Merchant-Initiated Transactions).
If you already have a PayPal merchant account, you can easily upgrade your profile via the Merchant Portal. To do so, follow these steps:
- Login to the Merchant Portal test environment. Go to Business > Payment methods PayPal.
- In the How to activate PayPal section, click on Create and login.
- You will be redirected to PayPal to complete the Integrated Sign-Up (ISU) process.
- Log in to PayPal using your existing PayPal credentials. PayPal will confirm that your account is linked and ready to process payments.
Key benefits
- Worldwide popularity
- PayPal Fraud Protection and Seller protection
- Variety of modalities (Pay in 3 / 4, Pay in 30, Pay Monthly)
- Allows
Authorisations/Direct sales
Full/Partial captures
Full/Partial refunds
Full authorisation cancellations - Guaranteed payment
- Line items
- PayPal insights and reporting via the PayPal Business Account
Onboarding
To activate PayPal in the test/live environment, follow these steps:
- Login to the Merchant Portal. Go to Business > Payment methods PayPal.
- In the How to activate PayPal section, click on Create and login.
- You are redirected to PayPal to complete the onboarding. Depending on your status with PayPal, differences apply:
a) You already have a PayPal business account
-
- Log in with your existing PayPal business account credentials.
- After successful login, PayPal confirms that your account is correctly linked and ready to be used for payments.
b) You do not have a PayPal business account yet
-
- Create a new PayPal business account via the PayPal onboarding flow.
- Complete the required business information.
- Once the account is created and linked, you will receive same confirmation message.
Mind that
- In the test environment, PayPal onboarding is performed in sandbox mode.
- The data entered in the test environment is for testing purposes only and does not create a live PayPal account.
Countries & currencies
Supported countries
-
Afghanistan
-
Albania
-
Algeria
-
American Samoa
-
Andorra
-
Angola
-
Anguilla
-
Antigua and Barbuda
-
Argentina
-
Armenia
-
Aruba
-
Australia
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 portal via integration methods via our Hosted Checkout Page or Server-to-server.
The PayPal Complete Payments API distinguishes between two modes, allowing you to adapt your customers' payment experience to your preference.
Depending on the flow, differences apply:
- PayPal displayed on the Hosted Checkout Page (formerly known as Express Checkout Mark)
- PayPal shortcut button on the merchant's checkout page (formerly known as Express Checkout Shortcut)
Find a high level overview in the "Process flows" chapter.
PayPal displayed on the Hosted Checkout Page
You collect your customers' shipping address before redirecting them to the Hosted Checkout Page. Your customers can choose between various payment options (Buy Now, Pay Later), dynamically based on customer eligibility and country. This optimised checkout flow is aligned with PayPal's UX best practices.
Add the following properties to a standard CreateHostedCheckout request:
{
"hostedCheckoutSpecificInput":{
"locale":"en_GB"
},
"redirectPaymentMethodSpecificInput":{
"requiresApproval":true,
"paymentProduct840SpecificInput":{
"AddressSelectionAtPayPal":false
}
},
"order":{
"amountOfMoney":{
"amount":100,
"currencyCode":"EUR"
},
"customer":{
"contactDetails":{
"emailAddress":"test@worldline.com"
}
},
"shipping":{
"address":{
"street":"Shipping Street",
"houseNumber":"88",
"zip":"1930",
"city":"Brussels",
"countryCode":"BE",
"name":{
"firstName":"ShipFN",
"surname":"ShipLN"
}
},
"type":"delivery",
"shippingCost":0,
"shippingCostTax":0
}
}
}
PayPal shortcut button on the merchant's checkout page
Available via both Hosted Checkout Page and Server-to-server, this mode allows you to place a PayPal button directly on your webshop's checkout page. Upon clicking the button, your customers are redirected to the PayPal portal for managing their shipping address and confirming the order.
Integrating via Server-to-server requires you to implement the PayPal JavaScript SDK to comply with PayPal's guidelines.
Add the following properties to a standard CreateHostedCheckout/CreatePayment request:
{
"redirectPaymentMethodSpecificInput":{
"requiresApproval":true,
"paymentProductId":840,
"paymentProduct840SpecificInput":{
"AddressSelectionAtPayPal":true
}
},
"order":{
"amountOfMoney":{
"amount":100,
"currencyCode":"EUR"
},
"customer":{
"contactDetails":{
"emailAddress":" YourCustomer@domain.com"
}
}
}
}
| Properties | Description |
|---|---|
|
hostedCheckoutSpecificInput.locale |
The language version of our Hosted Checkout Page. |
|
order.amountOfMoney |
amount: The gross amount you want to charge for this order. |
|
shipping |
Your customer's personal information/contact details, billing and shipping address. Mandatory for PayPal displayed on the Hosted Checkout Page mode. |
|
redirectPaymentMethodSpecificInput |
requiresApproval: Set to either "true"/"false" depending on whether you want to process payments in authorisation/Direct Sale mode. 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. Mandatory for PayPal shortcut button on the merchant's checkout page mode. addressSelectionAtPayPal: Define whether to allow your customers to select a previously stored shipping address on the PayPal portal.
|
Find detailed information about this object and its properties in our CreateHostedCheckoutAPI/CreatePaymentAPI.
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.
- The data in our Test cases ONLY work for payment requests in our test environment. Using this data in our production environment will lead to undesirable testing results.
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 GoPay 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.