Magento 2 Opayo Sage Pay Integration User Guide

  • admin admin |
  •    15 Feb, 2023  |
Magento 2 Opayo Sage Pay Integration User Guide

Magento 2 Sage Pay Integration seamlessly integrates Europe's leading Payment Service Provider to capture secure and flexible payments from customers. To help merchants comply with PCI security standards, Sage Pay store payment data on its PCI-compliant data vault through its checkout forms. Merchants only have to validate their PCI DSS compliance using SAQ A self-questionnaire.The administrator can change the title of the payment method, select the credit card types that can be used, enable 3D secure, and select the payment action for this method.


  • NEW Sage Pay PI integration.
  • NEW Magento orphan transaction log & recovery.
  • Sage Pay drop-in checkout form.
  • NEW Acquire PCI DSS Compliance Level 1.
  • Tokenization & saved cards
  • Pre-authorization or Authorization & capture.
  • MOTO support
  • Donation supported with Gift Aid.
  • Support multiple stores, and credit card providers.
  • NEW Sage Pay Direct refund: full refund and partial refund.
  • Support major credit card providers: Visa, MasterCard, AMEX, and Discover.
  • Specify allowed credit card types and countries.
  • Customer can capture invoice up to quantity
  • Support 3D Secure 2.0

Installation Steps

Buyers will get a Zip file, they have to unzip / extract the file to their system. The uncompressed folder will have a folder called Scriptzol and you need to transfer the Scriptzol folder to your Magento 2 root directory /app/code/.

Installation Steps

After the successful transfer, buyers have to run the following commands in the Magento 2 root directory with the help of terminal.

  • php bin/magento setup:upgrade
  • php bin/magento setup:di:compile
  • php bin/magento setup:static-content:deploy

After the commands running successfully, need to flush the cache in admin panel.

flush Cache

cache Flush

Installation steps done.

Configuration Steps

Multiple Languages

To configure in multiple languages, Under Store > Configuration > General > Locale in admin panel, select the language which needed.

SagePay translate

Translation of Languages

For translation of the content in the module, In the “app/code/Scriptzol/SagePay/i18n” folder, need to add the file. To add a file for specific language, for eg.arabic for Saudi Arabia, ar_SA.csv is the file name format.

SagePay Language

The file content should be like the below screenshot.

SagePay Table

Left side of the column is the original content, right side contains translations.

SagePay Edit Table

General Configuration

To enable / disable the SagePay module , navigate to Stores > Configuration > Sales> Payment Methods > Other Payment Methods.

SagePay Configuration

Payment Configuration

Enabled: Choose Yes to enable direct checkout for SagePay Payment

Title: The title of the payment method displayed on the checkout page.

Can Save Credit Card: Allow customers to save credit card token for future purchase.

Vendor Name, User and Password: The credentials you got from Sage Pay in the above step.


Payment Action: You can choose between Authorize Only (Deferred) and Authorize and Capture (Payment)

  • Authorize Only: check for the card for validity but not charge the account yet until the order is approved and invoiced.
  • Authorize and Capture (Payment): charge the debit/credit card at the time of the order is placed.

New Order Status: Processing, Suspected Fraud

  • Processing: The payment is made successfully and an order invoice is issued.
  • Suspected Fraud: No invoice is issued.

Test Mode: Turn on Test Mode when you use test credentials. Choose the Live Mode when you go live.

Ignore address check: You can also turn on Ignore address check to skip the address and postcode check in test mode.

Allow Gift Aid: Allow customers to donate to charity. Note that this function only works if your Sage account is enabled for Gift Aid.

Credit Card Types: You can choose which credit card types you want by choosing one or more items.

Credit Card Verification: Allow (or) skip verification of user's credit card.

Apply 3D Secure with 4 options: Default, Force, Disable, Force & Ignore

  • Default: Use Default My SagePay Settings
  • Force: Apply authentication even if the 3D Secure is turned off
  • Disable: Disable authentication and rules
  • Force & Ignore: Apply authentication but ignore rules

Apply AVS, CVC Check with 4 options: Default; Force; Disable; Force & Ignore

  • Default: Use Default My SagePay Settings
  • Force: Apply authentication even if the AVS, CVC Check is turned off
  • Disable: Disable authentication and rules
  • Force & Ignore: Apply authentication but ignore rules

Transactions :


Front end

In frontend, the Sagepay payment method will be displayed on the checkout page.

SagePay Frontend Checkout

We hope this documentation helped for configuration successfully. Please feel free to contact us.

Email: /

Contact Us: Contact Support Team

License: License Agreement


  • No Comments Found!!
Post Comments