Elavon downloads and stores cookies on your device when you visit our website. We use these cookies to better understand and improve your browsing experience by identifying most visited pages, personalising content, and measuring site performance.

Essential cookies enable core functionality such as page navigation and access to secure areas. The website cannot function properly without these cookies; they can only be disabled by changing your browser preferences.

These are cookies that support site functionality that is visible or advantageous to you or your experience of the site, they enable websites to remember choices and provide a more personalized experience.   Functional cookies help to provide services that you request, such as language preference or layout.

Performance cookies help us to improve our website by collecting and reporting information on its usage (for example, which of our pages are most frequently visited).

These cookies and similar technologies gather information about your browsing habits. They remember that you've visited a website and share this information with other organisations, such as advertisers and platforms on which we advertise. They do this in order to provide you with ads that are more relevant to you and your interests. Although these cookies and similar technologies can track your visits to other websites, they don't usually know who you are. Without these cookies, online advertisements you encounter will be less relevant to you and your interests.

Cookie Settings

U.S. Bank Europe DAC. Registered in Ireland – Number 418442..  Registered Office: Block F1, Cherrywood Business Park, Dublin 18, D18 W2X7, Ireland.
U.S. Bank Europe DAC, trading as Elavon Merchant Services, is regulated by the Central Bank of Ireland.
 
U.S. Bank Europe DAC. Registered in Ireland with Companies Registration Office. The liability of the member is limited. United Kingdom branch registered in England and Wales under the number BR022122.
U.S. Bank Europe DAC, trading as Elavon Merchant Services, is a credit institution authorised and regulated by the Central Bank of Ireland.  Authorised by the Prudential Regulation Authority.  Subject to regulation by the Financial Conduct Authority and limited regulation by the Prudential Regulation Authority.  Details about the extent of our regulation by the Prudential Regulation Authority are available from us on request.

Most popular solutions

Additional solutions

Fusebox integration & options

Optional platform features

Documentation

North America

Europe

Regions

:::::notice{info}
If you have any difficulty integrating PayPal via Opayo, you can contact [support@opayo.io](mailto:support@opayo.io?subject=Help%20with%20PayPal%20integration) for help.
:::::


## Complete PayPal onboarding

You'll need to configure your PayPal account to grant Opayo permissions to take payments on your behalf.

- To test your account, onboard to [Paypal's sandbox environment](https://www.sandbox.paypal.com/bizsignup/partner/entry?&partnerClientId=AQry6OU2LU106ECUxmVrlp8OEejoYdp3SaWHVxuC8of-y39fKjeKn5_ZswjdsaRoNMZEmIkgY0HzQ3__&partnerId=9VMX5HHAJXKHS&product=EXPRESS_CHECKOUT&integrationType=OAUTH_THIRD_PARTY&features=PAYMENT,REFUND), using the sandbox business credentials (email and password required) you have created with PayPal. 

- After testing, you will need to onboard your live PayPal account in order to take transactions via Opayo (email and password required). If you don't do this, you will receive an error message. Use this [link to enable the Opayo/PayPal connection](https://www.paypal.com/bizsignup/partner/entry?&partnerClientId=AQcyrdmhawg650yaAuu9TAWpeXoCle5qtGP7c9kHmoJpJrTSsf6vToKBvUkMy6yxRQqAOgOR8UyAss7G&partnerId=C72DURWDY8P2Q&product=EXPRESS_CHECKOUT&integrationType=OAUTH_THIRD_PARTY&features=PAYMENT,REFUND).

- Then log into PayPal using your business account credentials and complete the sign-up process.



## Configure your Opayo account

- Log into MyOpayo and add the PayPal business account email on Settings > Pay Methods.



:::::notice{info}
If you don't have a PayPal account yet, you can [sign up through this link on PayPal's site](https://www.paypal.com/bizsignup/#/checkAccount).
:::::

- After signing up for a PayPal account, complete the above steps to grant permissions for Opayo to take payments on your behalf, and add the business account email to MyOpayo.

## Implement a PayPal button

- First, choose where you will render the PayPal button on your site. This can be in combination with a standard card checkout screen (:magic-link[Pi own form or drop in .js]{id="integration-options-byopp"}), or, you can place the button before the card screen, or against a particular product page.

- Then, select the particular button you wish to use from PayPal. If you have Pay in 3 enabled or PayPal Credit you might want to choose the appropriate button. See here for [general information regarding pay later buttons](https://developer.paypal.com/docs/checkout/pay-later/gb/) and [proper server integration of pay later buttons](https://developer.paypal.com/demo/checkout/#/pattern/server) for further information.

- Finally, link the PayPal checkout button to call resources on your server to initiate the transaction with PayPal via Opayo.

## Integrate with Opayo

When you integrate with PayPal you must ensure:

- Your site is secured using TLS (1.2 or the latest version).
- All communications are over HTTPS.
- You have your Integration Key and Integration Password in order to authenticate your requests.

::::notice{warning}
**Important:** You must keep your Integration Key and Integration Password secret!
::::

### Step 1: Create a merchant session key (MSK)

Generate a Merchant Session Key (**merchantSessionKey**) using your Integration Key and Integration Password to authenticate your requests. A valid **merchantSessionKey** is required to initiate your transaction request.

The Merchant Session Key expires:

- After 400 seconds for the initial registration post
- To continue with the transaction you must redirect your customer to PayPal within 20 minutes, or the Merchant Session Key will expire.

A new Merchant Session Key must be created each time you load the payment page, or when an existing Merchant Session Key expires. Send a HTTP POST request to our **/merchant-session-keys** endpoint using your Integration Key and password to authenticate the request.

#### Example request

```json
{
 "vendorName": "sandbox"
}
```

For HTTP Basic Authentication, you must:

- Format the string as ```integrationKey:integrationPassword```, encode it using Base64 encoding, and include it in the Authorization header.
- Enter your unique Opayo vendor name in the **vendorName** field.

#### Example response
```json
{
 "merchantSessionKey": "M1E996F5-A9BC-41FE-B088-E5B73DB94277",
 "expiry": "2021-08-11T11:45:16.285+01:00"
}
```

::::notice{info}
**Notes:** 
- When a Merchant Session Key is invalid, or when the Merchant Session Key has expired (after 400 seconds), you can create an endpoint on your server that generates a new Merchant Session Key for the current transaction. 
- When you receive an HTTP 401 (Unauthorised) response, you can make an AJAX request to the same endpoint and replace the Merchant Session Key in the page with the new one.
::::


### Step 2. Submit the transaction request

For a basic transaction, the parameters listed in the following table must be included in the request body.

**Transaction request parameters**
| Property | Description |
|---|---|
| **transactionType** | The type of transaction requested. For a PayPal integration, this will always be **Payment** |
| **paypal** (object) | **callbackURL** - The URL to return to once the transaction is complete **merchantSessionKey** - value acquired in step 1. |
| **vendorTxCode** | Your unique reference for this transaction. |
| **amount** | The amount in the smallest currency unit. For example, to charge £1.00 the amount is input as 100. |
| **currency** | The currency of the amount in 3 letter ISO-4217 format. For example, GBP. |
| **description** | A description of the transaction |
| **customerFirstName** | Customer's first name |
| **customerLastName** | Customer's last name |


**Example transaction request post**
```json
{
 "transactionType": "Payment",
 "paymentMethod":
 {
 "paypal": 
 {
 "merchantSessionKey": "{{MERCHANT_SESSION_KEY}}",
 "callbackUrl": "www.example.com" 
 }

 },
 "vendorTxCode": "{{VENDOR_TX_CODE}}",
 "amount": 30000,
 "currency": "GBP",
 "description": "Camera Shop",
 "customerFirstName": "Test"
 "customerLastName": "Name"
}
```

You will receive a response similar to:


```json
{
 "transactionId": "420885fd-e671-49a8-8e2f-c48e45a27b35",
 "transactionType": "Payment",
 "status": "Redirect",
 "statusCode": "2023",
 "statusDetail": "Transaction registered, redirect client to wallet server.",
 "paymentMethod": 
 {
 "paypal": 
 {
 "redirectUrl": "sandbox.paypal.com", 
 "orderId": "7A745039NY355690Y" 
 } 
 
 }
 
}
```

You can find more detail on the request / response exchange, and optional fields :magic-link[in the Opayo API Reference document]{id="api-reference"}.

### Step 3. Forward your customer to the redirectURL

Once you have this response, redirect your customer to the **redirectURL** included in the **paymentMethod** object. We have included the **payPalToken** field for your records. 

::::notice{warning}

**Note: The redirect to PayPal must be a full page - you cannot use the **redirectURL** to populate an iframe.**
::::

PayPal will take over the process at this point.



### Step 4. Transaction response and call back

PayPal will respond with the transaction outcome back to Opayo and we will redirect your customers' browser session to the **callbackURL** specified in Step 2. We will also append a parameter to the URL containing a unique Opayo **transactionId**.

This URL will be able to look up details of the transaction using the **transactionId** (via :magic-link[the retrieveTransaction API call]{id="api-reference#tag/Transactions/operation/retrieveTransaction"}) and will forward the customers' browser to an appropriate completion page. This URL will also be contacted in the event of any errors.

Your site will then interpret the result as required and, should you decide to reject the transaction, you'll need to refund it.

::::notice{warning}

**Note: You cannot refund a PayPal transaction via MyOpayo- you will need to refund any PayPal transaction via an API integration or by logging into the PayPal portal. We expect this to change in approximately July 2025 when a new version of MyOpayo is made available.**
::::


## Next steps

- :magic-link[Review the full API Reference]{id="api-reference"}.

PayPal Integration

Alliance Offers

Data as a Service

Invitation to Apply

Bank Holidays

Card Activation

Card Controls

Challenge-Widget

Commercial Credit Cards

Commercial Statements

Credit Card Account Details

Credit Card Accounts Overview

Credit Card Alerts

Credit Card Application Status

Credit Card APRs

Credit Card Balance Transfers

Credit Card Disputes

Credit Card Payments

Credit Card Qualified Offers

Credit Card Statements

Credit Card Transactions

Data Sharing for Marketing Purposes

Digital Wallets

Incoming Webhooks

Make a Payment - Coming Soon

Rewards Accelerator

Rewards Automatic Redemption

Rewards: Balance Summary

Rewards: Dashboard

Rewards Redemption Accounts

Rewards Redemptions

Rewards Transactions: Earned and Redeemed

Travel Notifications

User Profile

3DSecure2

CheckoutJs

Commerce SDK

Converge

Disputes Management

Dynamic Currency Conversion

eBoarding

Elavon Cloud Payments Interface

Elavon Payment Gateway

Fusebox

Hosted Payment Page

In Person Payments on Opayo

Leads

Lightbox payment modal

Online Payments on Opayo

Opayo

Opayo Direct

Opayo Forms

Opayo Reporting API

Opayo Server

Opayo Shared API

Payment Method Gateway

Payments Core 365

Simplify

viaconex

XML API

Card as a Service API

Core Banking API

Money Movement API

Reference API

Access Online Transactions

Account Transfers

Account Validation

ACH Originations

Avvance Connect

Avvance Express

Avvance Flex

Bank Information

Card as a Service

Check Payables

Corporate Account Information

Corporate Account Information 3LO

Corporate Credit Cards

Corporate Onboarding

Corporate Statements

Custody

Data Toolbox

Data Toolbox - Accounts

Data Toolbox - Documents

Data Toolbox - Transactions

Debit Card Phone Number Lookup

Disbursements via Zelle®

U.S. Bank Flexible Capital Platform

Foreign Exchange

Freight Payment Customer Profiles

Freight Payment Transactions

Instant payments

Investment Accounting

PaySmart

Payee Choice

Payee Token+

Personal Loans

Positive Pay

Push to Card

Receivables

RTP® - Real-Time Payments

Tokenized Payments

Treasury Builder

U.S. Bank FBO Account

Virtual Account Reporting

Virtual Card Payments

Voyager Accounts

Voyager Cards

Voyager Drivers

Voyager Transactions

Voyager Vehicles

Wire Transfers

Overview

Build your own payment page

API reference

Integration options

Transaction types

Additional options

PayPal integration

Apple Pay

Apple Pay (Opayo managed certificate)

Apple Pay (Merchant managed certificate)

Google Pay

Alternative payment methods

3D Secure authentication

SCA exemptions

Tokens (reusable identifiers)

Credential on file

Hosted payment page

Integration guide

Tokens

Test in Sandbox

Support

Compliance information

Change Log