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.

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

Elavon Financial Services DAC. Registered in Ireland – Number 418442.
Registered Office: Block F1, Cherrywood Business Park, Dublin 18, D18 W2X7, Ireland.
Elavon Financial Services DAC, trading as Elavon Merchant Services, is regulated by the Central Bank of Ireland.
 
Elavon Financial Services 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.
Elavon Financial Services 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.

## Overview

When you receive a Card Identifier using our :magic-link[Drop-in Checkout]{id="integrate-your-own-form"} or :magic-link[your Own Form]{id="integrate-our-dropin-checkout"} integration, you can submit the payment to the Opayo gateway from your server.


**Note: Opayo offers you a range of :magic-link[additional transaction types]{id="additional-transaction-types-4485"}, too.**


## Integration

You must:

- Authenticate your call using HTTP Basic authentication.
- Format the string as ```integrationKey:integrationPassword``` and encode it using Base64 encoding.
- Include the encoded string in the Authorization header.

### Step 1. 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 example, Payment or Repeat. |
| paymentMethod | The payment method for the transaction. In this object you must provide us with the **cardIdentifier** and the **merchantSessionKey** used to create that **cardIdentifier.** |
| 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. |
| customerFirstName | Your customer's first name. |
| customerLastName | Your customer's last name. |
| billingAddress | Your customer's billing address. |

::::notice{warning}

**Important:** You must submit the **strongCustomerAuthentication** object. For more information, see the [API reference](https://developer-eu.elavon.com/docs/opayo/spec/api-reference).
::::


#### Example payment transaction request

```json
{
 "transactionType": "Payment",
 "paymentMethod": {
 "card": {
 "merchantSessionKey": "",
 "cardIdentifier": ""
 }
 },
 "vendorTxCode": "demotransaction-",
 "amount": 10000,
 "currency": "GBP",
 "description": "Demo transaction",
 "apply3DSecure": "UseMSPSetting",
 "customerFirstName": "Sam",
 "customerLastName": "Jones",
 "billingAddress": {
 "address1": "407 St. John Street",
 "city": "London",
 "postalCode": "EC1V 4AB",
 "country": "GB"
 },
 "entryMethod": "Ecommerce",
 "strongCustomerAuthentication": {
 "website": "https://mydomain.com",
 "notificationURL": "https://notification.url",
 "browserIP": "10.68.21.21",
 "browserAcceptHeader": "text/html, application/json",
 "browserJavascriptEnabled": true,
 "browserJavaEnabled": false,
 "browserLanguage": "en-GB",
 "browserColorDepth": "16",
 "browserScreenHeight": "768",
 "browserScreenWidth": "1200",
 "browserTZ": "+300",
 "browserUserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:67.0) Gecko/20100101 Firefox/67.0",
 "challengeWindowSize": "Small",
 "transType": "GoodsAndServicePurchase"
 }
}
```

You can find a full list of parameters in our [API Reference](https://developer.elavon.com/products/opayo/v1/api-reference).

### Step 2. Handle transaction responses

Responses depend on your 3D Secure requirements. When 3D Secure authentication is not required and the transaction is successfully authorised, you should receive a response similar to the following example:


```json
{
 "transactionId": "T6569400-1516-0A3F-E3FA-7F222CC79221",
 "transactionType": "Payment",
 "status": "Ok",
 "statusCode": "0000",
 "statusDetail": "The Authorisation was Successful.",
 "retrievalReference": 8636128,
 "bankResponseCode": "00",
 "bankAuthorisationCode": "999777",
 "paymentMethod": {
 "card": {
 "cardType": "Visa",
 "lastFourDigits": "0006",
 "expiryDate": "0317"
 }
 },
 "3DSecure": {
 "status": "NotChecked"
 }
}
```

The **status**, **statusCode** and **statusDetail** inform you of the transaction outcome.

**Response statuses**
| Status | Status description |
|---|---|
| OK | Transaction request completed successfully. |
| NotAuthed | Transaction request was not authorised. |
| Rejected | Transaction request was rejected by your fraud rules. |
| Malformed | Missing properties or badly formed body. |
| Invalid | Invalid property values supplied |
| Error | An error occurred at Opayo |

#### Transactions with 3D Secure

Transactions that use 3D Secure authentication require your customer to be forwarded to their card issuer for authentication before a card authorisation can complete. When 3D Secure authentication is required you should receive a response similar to the following example:


```json
{
 "statusCode": "2021",
 "statusDetail": "Please redirect your customer to the ACSURL to complete the 3DS Transaction",
 "transactionId": "BEB718F6-3ED2-323E-2CB2-B8C83DB2029C",
 "acsTransId": "43b04fd1-692c-4b76-ac20-a75527ad0a25",
 "dsTransId": "7980e36f-907b-4530-84fd-ccc1f40bf9ae",
 "acsUrl": "https://localhost:8252/html_challenge",
 "status": "3DAuth",
 "cReq": "eyJtZXNzYWdlVHlwZSI6IkNSZXEi...V2luZG93U2l6ZSI6IjAxIn0"
}
```

## Next steps

- :magic-link[3D Secure Authentication]{id="3d-secure-authentication-"}
- [Review the full API reference](https://developer.elavon.com/products/opayo/v1/api-reference)

Submit Transactions from Your Server

Accounts

Bank Holidays

Card Activation

Card Controls

Credit Card Account Details

Credit Card Accounts Overview

Credit Card Alerts

Credit Card Application Status

Credit Card APRs

Credit Card Disputes

Credit Card Payments

Credit Card Qualified Offers

Credit Card Statements

Credit Card Transactions

Data Sharing for Marketing Purposes

Digital Wallets

Make a Payment - Coming Soon

Rewards Accelerator

Rewards Automatic Redemption

Rewards Balance Summary

Rewards Redemption Coming Soon

Rewards Redemption Accounts

Rewards Redemptions

Rewards Transactions Earned and Redeemed

Travel Notifications

User Profile

Virtual Card Payments

3DSecure2

Avvance

Commerce SDK

Converge

Disputes Management

Dynamic Currency Conversion

eBoarding

Elavon Cloud Payments Interface

Fusebox

In Person Payments on Opayo

Leads

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

Access Online Transactions

Account Transfers

Account Validation

ACH Originations

Bank Information

Card as a Service

Check Payables

Corporate Account Information

Corporate Credit Cards

Corporate Onboarding

Corporate Statements

Custody

Data Toolbox

Data Toolbox - Accounts

Data Toolbox - Documents

Data Toolbox - Transactions

Disbursements via Zelle

U.S. Bank Flexible Capital Platform

Freight Payment Customer Profiles

Freight Payment Transactions

Instant payments

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

Voyager Accounts

Voyager Cards

Voyager Drivers

Voyager Transactions

Voyager Vehicles

Wire Transfers

Opayo Pi

API Reference

Integrate Our Drop-In Checkout

Integrate Your Own Form

PayPal Integration

Apple Pay

Apple Pay (Opayo managed certificate)

Apple Pay (Merchant managed certificate)

3D Secure Authentication

SCA Exemptions

Tokens (Reusable Identifiers)

Credential on File

Compliance

PCI Compliance

PSD2 Compliance

MCC 6012

Zero Value Authorisation

Additional Transaction Types

Repeat Payments

Deferred Payments

Authenticate Transactions

Refund a Transaction

Void Transactions

Authentication and Credentials

Test in Sandbox

Pi Demo

Support

Change Log