Learn about the business side of integrating with Optty. While our developer docs cover all the technical integration details, here you'll find information on the basics of integrating and how you can use our features to best fit your business.
It's never been easier to connect to the whole world of Payments
The Optty UPP is the user interface for your Optty integration. You can manage your Payment Methods, generate reports, enable new providers, and manage your account.
We are a simple integration, connecting you to the Payment Method with 2 lines of code. The API Key and Secret. Our sophisticated technology will have you trading in minutes with full functionality including partial and full returns. It is so simple, and you have full control from the Universal Payments Platform.
Ecommerce Website
You will need an online shop to sell your products – It’s up to you to decide which platform to use for your store. We have direct integrations into Magento, BigCommerce, Salesforce and WooCommerce.
Buy Now Pay Later account
Once you know which Payment Method you wish to use, you can create your account with them. The commercial relationship is always between you and the Payment Method directly.
Optty Account
Your Optty account is what we use to display your Payment Methods on your store. It also gives you the full access to change how the Payment Methods are displayed on your store and to manage the Payment Methods on your product and checkout pages.
Developer Knowledge
If you have a store built on Magento, Salesforce, BigCommerce or WooCommerce then you can get setup without the need for a developer. However, having a developer on-hand is always helpful for any additional tweaks you may want to make.
You’ll interact with us in two ways:
1. The Universal Payments Platform (UPP)
2. The Platform Plug-In OR Application Programming Interface (API)
The Universal Payments Platform
The Universal Payments Platform is our user-friendly interface focused on the tools you need to keep your business running smoothly – allowing you to set up Payment Methods, manage widgets, pull reports, manage new Payment Methods, and more. Learn more about the [Universal Payments Platform].
The Platform Plug-in
We have developed direct plugins for a number of the top ecommerce platforms, to allow you to integrate with Optty in as little as 15 minutes. The Optty plugin can be found in the Salesforce, Magento, Woocommerce and BigCommerce marketplaces and is FREE.
The API
The API is the architecture of our gateway – our complete set of code that powers everything we do, from payments to Payment Methods management to reporting.
To use the API’s to integrate Optty to your custom application, your developers will update the existing code for your website or mobile app to make requests to our API, allowing you to automate processes and customize the way you interact with Optty. Our [developer docs] will guide your developers through everything they'll need for a complete custom integration.
Integrating with Optty offers your customers many different ways to pay – and we’re working on adding more. Here’s a quick list of what we currently offer, and in which countries they are available in. For an overview of how to add Payment Providers to your integration, see our [Universal Payments Platform].
When your customers shop on your store and checkout via Optty, the transaction goes through several stages. A standard transaction will go through the following:
Add items to basket
Your customer comes to your store and adds items to their online basket.
Enter store checkout
When they are ready to complete their purchase, they go to the checkout and enter their delivery and billing details.
Select Payment Method
Under payment methods they select the Payment Method you have setup via Optty.
Complete Payment Method Payment
The customer is redirected to the Payment Method website to complete the payment. Optty sends the Payment Methods the details of the customers shopping cart.
If the Payment Method declines the payment, or the customer cancels the payment process, they will be returned back to the checkout page to select a different payment method/provider.
Order successful page
If the payment is successful, Optty will return the customer to your “Order Successful” page and send you the payment reference.
After a transaction is completed, the Payment Method will transfer the full basket amount, less their fees to your account at the agreed time (usually the following day –T+1).
Payments are always handled directly between you and the Payment Method. Optty do not see or handle any of these payments pr the commercial agreements.
We can't recommend this enough: test early and test often. It's a great way to identify potential issues with your integration, and it also gives you ample opportunities to get familiar with Optty.
The Optty sandbox
The sandbox is a test environment that is almost identical to our production environment. Within your sandbox, you can setup Payment Methods, run transactions using test credit card numbers, and explore the full functionality of Optty.
Get started by signing up for an [Optty sandbox account!]
Sandbox versus production
There are a few key differences to keep in mind:
Sandbox processing options, currencies, and features can vary by Payment Methods.
IMPORTANT
Your sandbox account is not linked to your production account in any way. Nothing created in the sandbox will transfer to production.
Your login information, merchant ID, and API keys will also be different for the Sandbox and Production environments.
Switching from sandbox to production
Once you're ready to start accepting real payments, you can begin your production integration.
The Optty UPP (Universal Payments Platfrom) is the user interface for your Optty account. The Optty UPP (Universal Payments Platfrom) is used to:
• Enable / Disable Payment Methods
• Configure the Payment Method parameters
• Manage the widgets displayed on your online store
• Manage “Call To Actions”
• View Payment Method Performance Reports
Dashboard
The Dashboard gives you a quick look at your sales volume, transaction volume, totals, and averages across all of your Payment Methods and Currencies. You can expect to see your Optty transactions appearing in real time on the Dashboard.
Environments
There are two Control Panel environments:
• [Sandbox Control Centre]: Testing environment
• [Production Control Centre]: Live production environment
Both environments are mutually exclusive; they do not interact with each other, and it is possible to have different login credentials for each environment. [Learn more about differences between the environments.]
There are several different identifiers associated with your Optty account. Here are some important ones you'll need to know.
Optty API credentials
Optty API credentials are unique account identifiers that must be added to the Optty plugin on your online store. They form the connection between your online store and the Optty UPP (Universal Payments Platform). The API credentials are:
• ClientID
• ClientSecret
• HashSecret
When you sign-up for a merchant account, you will be emailed your Sandbox API Keys. Once you complete your Business Registration Form, we will send you your Production API Keys.
Optty UPP (Universal Payments Platform) credentials
The UPP credentials allow you to logon to the Optty UPP (Universal Payments Platform) to manage your Optty account. The credentials are:
• Email Address
• Password
Payment Method API credentials
Payment method API credentials are unique account identifiers that must be added to the UPP (Universal Payments Platform) to activate the payment method on your online store. They authenticate your online store and the payment method. The API credentials are:
• API Key
• Secret
Refer to this [page] for information on how to obtain your payment methods API Keys and how to use them.
IMPORTANT
Sandbox API keys are different from those in the production environment, so they must be updated when switching between environments. More information about switching environments is available in our [developer docs].
With Optty you can add a new payment method to your online store in minutes. Before you start you will need your payment method API Credentials and your login to the Optty UPP (Universal Payments Platform)
• Sign in to your Optty UPP (Universal Payments Platform)
• Select Payments Management from the left-hand menu. You will see the list of payment methods that you had previously setup.
• Select Add New from the top right of the page. You will see a list of available payment methods. Use the currency selector in the top right of the page to refine the list.
• Click the desired payment method and click Next.
• Enter your payment method API Credentials in the “API Key” and “Secret” fields and then click Test Connection
With Optty you have full control of when a payment method will appear on your store. You can set minimum/maximum values for the payment method and also temporarily deactivate payment methods. Before you start you will need your logon to the Optty UPP (Universal Payments Platform)
Setup Minimum and Maximum Values
• Sign in to your Optty UPP (Universal Payments Platform)
• Select Payments Management from the left-hand menu. You will see the list of payment methods that you had previously setup.
• Click the payment method you want to amend and click Manage
• Select Display Rules & Configuration from the top menu
• You can control when this payment method is displayed on your store based on the value of the checkout, by using the Min Checkout Value and Max Checkout Value fields. It will only be displayed when the checkout total is between the numbers you enter.
• To make this payment method always visible in your store, leave both fields blank.
Deactivate / Reactivate a Payment Method
• Sign in to your Optty UPP (Universal Payments Platform)
• Select Payments Management from the left-hand menu. You will see the list of payment methods that you had previously setup.
• Click the payment method you want to amend and click Manage
• To deactivate the payment method, click the Deactivate button at the top of the page.
• To reactivate the payment method, click the Reactivate button at the top of the page.
With Optty you can configure how the payment methods are displayed within your product pages and your online checkout. You can also edit marketing Call To Action content in minutes that are visible to your customers immediately.
Our simple to use editor allows you to add text and images to the individual payment methods CTA’s across your site in minutes. As soon as you click save, the content is live on your site.
• Sign in to your Optty UPP (Universal Payments Platform)
• Select Payments Management from the left-hand menu. You will see the list of payment methods that you had previously setup.
• Click the payment method you want to amend and click Manage
• Select Product Widget Configuration from the top menu
• You can control when this payment method is displayed on your store based on the value of the checkout, by using the Min Checkout Value and Max Checkout Value fields. It will only be displayed when the checkout total is between the numbers you enter.
• To make this payment method always visible in your store, leave both fields blank.
• Sign in to your Optty UPP (Universal Payments Platform)
• Select Payments Management from the left-hand menu. You will see the list of payment methods that you had previously setup.
• Click the payment method you want to amend and click Manage
• To deactivate the payment method, click the Deactivate button at the top of the page.
• To reactivate the payment method, click the Reactivate button at the top of the page.
With Optty you have full visibility of how your payment methods are performing on your store. Our simple to use dashboard will give you a view of each payment method as well as a summary by currency.
You can see the number of attempts and successful transactions per payment method and compare against a previous timeframe.
• Sign in to your Optty UPP (Universal Payments Platform)
• Select Reports & Analytics from the left-hand menu.
• Click the calendar in the top left to set a timeframe for the dashboard.
• Click the calendar in the top right to set a comparison timeframe to see, for example, day on day, week on week or month on month comparisons.
With Optty you have full control over how the payment methods will be displayed on your store. You can change the styling for the Footer, the Product Listing page, the Product detail page as well as the Shopping Cart.
In each of these locations you can turn the branding on/off, as well as amending the content and colours.
Page Footer
• Sign in to your Optty UPP (Universal Payments Platform)
• Select Widget Display from the left-hand menu.
• Select Footer Widget from the top menubar.
Theme1
Theme 1 is an initially collapsed theme, that expands when the customer hovers their mouse over the text.
Initially the footer is displayed as:
When you hover your mouse over, this expands to display:
You can change the fonts, colours, logos and text in the “Edit Widget Style” section.
Theme 2
Theme 2 will display all of the available payment methods, which you have setup on your store, horizontally across the page footer.
Initial footer display:
With this theme, you can change the font, colour and text that appears above the payment method's logos, using the “Edit Widget Style” settings.
Product Listing Page
• Sign in to the Universal Payment Platform
• Select Widget Display from the left-hand menu.
• Select Product Listing Widget from the top menubar.
Theme 1
Theme 2
Product Details
• Sign in to the Universal Payments Platform
• Select Widget Display from the left-hand menu.
• Select Product Details Widget from the top menubar.
Theme 1
Theme 1 will display details of the payment methods under the product price. When the customer hovers over the information icon they will be shown more details of the options and providers.
Initially the footer is displayed as:
When you hover your mouse over, this expands to display:
You can change the fonts, colours, and text in the “Edit Widget Style” section.
Theme 2
Theme 2 will display all of the available payment methods, which you have setup on your store, horizontally under the product price.
You can change the font, colour and text via the “Edit Widget Style” section.
Cart
• Sign in to the Universal Payment Platform
• Select Widget Display from the left-hand menu.
• Select Cart Widget from the top menubar.
Theme 1
Theme 1 will display the payment methods in your stores mini cart.
You can change the font, text and colour via the “Edit Widget Style” section.
Theme 2
Theme 2 will display the list of available payment methods in your stores mini cart.
You can change the font, text and colour via the “Edit Widget Style” section.
As an Optty customer, you have access to all of the payment methods on our platform, and whenever we add a new provider they are automatically added to your Optty UPP (Universal Payments Platform).
Sign-Up
You can sign-up for a new payment method from within the Optty UPP (Universal Payments Platform).
Logon with you credentials, and then select Payments Management from the left hand menu.
Select the Add New button (top tight of the screen) and then select the payment method of your choice. You can use the currency dropdown to filter the available payment methods by currency.
You can also click [HERE] to see all of the payment methods we have integrated with and their sign-up links.
Support
You can find the regional support details for each payment method from within the Optty UPP (Universal Payments Platform).
Logon with you credentials, and then select Payments Management from the left hand menu.
Select the payment method and click Next.
The support details and links are shown on the main display.
You can also click [HERE] to see all of the payment methods we have integrated with and their support links.
API Credentials
Can’t remember where to find your API Credentials for the payment method– don’t worry, we’ve pulled together a comprehensive list of the locations.
Click [HERE] to see all of the payment methods we have integrated with and how to find your API Credentials.
Integrating with Optty offers your customers many different ways to pay – and we’re working on adding more. Here’s a quick list of what we currently offer, and whom they are available to. For an overview of how to add payment providers to your integration, see our [Optty Universal Payments Platform].