Skip to main content

Overview of Opayo Direct gateway integration


Overview of Opayo Direct gateway integration

Supported features

The following table provides a quick reference for the supported features. For details about each feature, see the later sections in this article.

Supported payment methods Credit Card/Prepaid Card/Gift Card (Visa, MasterCard, Discover, American Express, JCB, Diners Club)
Supported payment operations  Payment method validation, Payment, Payment cancel (void), Referenced refund
Support 3D Secure 2.0 Yes
Support Delayed Capture No
Support Level 2 and Level 3 card data No
Support stored credential transactions Yes
Support Gateway Options fields Yes
Support Gateway Reconciliation No
Support Payment Method Updater No

Support for 3D Secure 2.0 

See Enable 3DS2 for Opayo Direct gateway integration and Zuora’s implementation of 3D Secure 2.0 for more information.

Support for stored credential profiles

Opayo Direct gateway integration includes support for the Stored Credential Transactions framework, but it does not support the sharing NTI feature. For details, see Support for stored credential transactions overview.

Supported gateway option fields

You can submit additional information to the Opayo Direct gateway using gateway options. Currently, Opayo Direct gateway integration supports the following gateway options fields.

All Gateway Options fields are string fields.

Gateway option field Zuora API field Zuora Payment Page client parameter Description
AccountType gatewayOptions.AccountType param_gwOptions_AccountType Specify the type of the account as either E for Ecommerce or M for MOTO.

If AccountType is E, the end customers might be challenged by 3D Secure.

See Opayo’s documentation for more information.

  • CustomerIpAddress
  • UserAgent
  • AcceptHeader
  • AcceptLanguage
  • BrowserJavaEnabled
  • BrowserJavascriptEnabled
  • gatewayOptions.CustomerIpAddress
  • gatewayOptions.UserAgent
  • gatewayOptions.AcceptHeader
  • gatewayOptions.AcceptLanguage
  • gatewayOptions.BrowserJavaEnabled
  • gatewayOptions.BrowserJavascriptEnabled
  • param_gwOptions_CustomerIpAddress
  • param_gwOptions_UserAgent
  • param_gwOptions_AcceptHeader
  • param_gwOptions_AcceptLanguage
  • param_gwOptions_BrowserJavaEnabled
  • param_gwOptions_BrowserJavascriptEnabled

These fields are required only if AccountType is E.

See Opayo’s documentation for detailed description.

  • BrowserColorDepth
  • BrowserScreenHeight
  • BrowserScreenWidth
  • BrowserTZ
  • gatewayOptions.BrowserColorDepth
  • gatewayOptions.BrowserScreenHeight
  • gatewayOptions.BrowserScreenWidth
  • gatewayOptions.BrowserTZ
  • param_gwOptions_BrowserColorDepth
  • param_gwOptions_BrowserScreenHeight
  • param_gwOptions_BrowserScreenWidth
  • param_gwOptions_BrowserTZ

These fields are required only if BrowserJavascriptEnabled is 1.

See Opayo’s documentation for detailed description.

  • RecurringFrequency
  • RecurringExpiry
  • gatewayOptions.RecurringFrequency
  • gatewayOptions.RecurringExpiry
  • param_gwOptions_RecurringFrequency
  • param_gwOptions_RecurringExpiry

These fields are used for the stored credential transactions.

See Opayo’s documentation for detailed descriptions.

You can use these fields in Payment Pages 2.0 or the following REST API:


Non-referenced refunds are not supported.