Change Log

  • 15-Mar-2021| v5.9.0 | Added note about eWay sandbox environment being a separate account
  • 24-Feb-2021 | v5.5.0 | Added further PayPal setup info and updated Gateway feature table
  • 07-Oct-2020 | v5.5.0 | All new article

Contributors:

Adam Wilson - Logo Pogo

Payment Settings

Integrate various payment gateways, for multiple countries and currencies, into WebinOne for form payments, subscriptions and eCommerce workflows.

Gateway

Here you can view the payment gateways currently configured for your supported countries, access their settings and set up new payment gateway integrations.

You can configure one payment gateway (plus “Pay with PayPal”) for each ‘Currency/Country’ your website supports.
See Site Domain Setting for configuring multiple country domains and/or currencies.

The ‘Currency/Country’ you assign here for the payment gateway will determine when this gateway is used for the site user (based on the domain they are visiting your site on).

Below are further details and setup instructions for each supported payment gateway.

Supported Gateways

OVERVIEW

Gateway
Type
Currencies
Extra Features
Seamless
 Recurring Billing
 Two-Step Card Payments
 SCA (3D Secure)
 Customisable Inputs
 Stripe Customer Portal
Seamless
 Customisable Inputs
Seamless
 Two-Step Card Payments
Seamless
 Recurring Billing*
External
 Recurring Billing

SETUP

Stripe

https://stripe.com/

Log into your Payment Gateway account to gather the credentials required (as displayed in the WebinOne admin) in order to set up the gateway integration.

You may need to check the gateway provider’s help documentation or contact their support agents to determine this information.

At time of writing this documentation, the gateway's API credentials could be retrieved from your Stripe account "Dashboard" under 'Developers' > 'API keys' and the below screenshots show the corresponding credentials.

Live Endpoints

Stripe Live API Credentials

Test Endpoints

Stripe Test API Credentials

SETTINGS

Setting
Description
Key
Credentials from your gateway account. Either of the Stripe Test keys or Live keys can be used here depending on if you are running test transactions or are accepting live transactions.
Secret
Credentials from your gateway account. Either of the Stripe Test keys or Live keys can be used here depending on if you are running test transactions or are accepting live transactions.
Two-step card payments

With this option enabled, the customer's card payment, at time of form submission, is authorised only and the funds will be captured later, after a second step has been completed - such as processing the payment from the Order details pages in the WebinOne admin once the purchase has been delivered, for example.

In this scenario, the Order and any email notifications are generated as normal, however the amount and Order status is set to “Pending”. Once the payment has been processed successfully the status is set to “Success”.

If the payment fails, is canceled via the admin, or is not processed within the 7 days hold period, the order status will be set to “Canceled”.

Orders with failed payments can be amended by adding manual “cash” payments against them via the Order detail page, or by initiating the Deferred Payment workflow.

If the order consists of only digital/downloadable products then this Two-step payment flow will be ignored and the default, Instant payment flow will be used.

APPEARANCE

These styling/layout options provide a way of customising this gateway's interface elements to better suit your site's design.

Setting
Description
Hide Postal Code
Hides the postal code field from the payment providers input fields. Default is true since you are typically already collecting a full billing address or postal code in the payment form. However, if not, deselect this checkbox to have the payment provider collect the postal code (which may be required).
Hide Icon
Hides the icons that are rendered in the payment fields.
Icon Style
Changes the style of the icons that are rendered in the payment fields. Options are Default or Solid.
Icon Color
The color of the icons that are rendered in the payment fields.
Color
The text color of the input fields.
Font Size
The text size (px) of the input fields.
Line height
Increases the height of the area the input text occupies. This can be use to increase the height of the input fields.
Font Smoothing
The 'font-smoothing' CSS property for all text (default is 'antialiased').
Placeholder Color
The text color of the input fields placeholder text (before any user text has been input).
Invalid Color
The text color of the input fields after an invalid value has been entered.
Invalid Icon Color
The color of the icons that are rendered in the payment fields after an invalid value has been entered.
Background Color
The background color of the input fields container element.

eWay

https://eway.io/

Currently, eWay's Rapid API implementation does not allow recurring payment methods.

Log into your Payment Gateway account to gather the credentials required (as displayed in the WebinOne admin) in order to set up the gateway integration.

You may need to check the gateway provider’s help documentation or contact their support agents to determine this information.

At time of writing this documentation, the gateway's API credentials could be retrieved from your "MYeWAY Business Centre" account under 'My Account' > 'API Key' and the below screenshot shows the corresponding credentials.

eWay’s sandbox test environment is a completely separate account that you’ll need to sign up to as a developer, using a different email address to that assigned to any live eWay account. More information can be found in the eWay help articles for Sandbox accounts here.

eWay API Credentials

SETTINGS

Setting
Description
Public API Key
Credentials from your gateway account.
Rapid API Key
Credentials from your gateway account.
Password
Credentials from your gateway account.
Endpoint

Production
Instructs the gateway to use the live production interface for accepting real transactions. Typically used for live sites ready for accepting real-world payments.

Sandbox
Instructs the gateway to use the test/sandbox interface for accepting test transactions. Typically used for trial sites or when setting up/testing a payment flow.

APPEARANCE

These styling/layout options provide a way of customising this gateway's interface elements to better suit your site's design.

Setting
Description
Autocomplete
Enables or disables browser autocomplete features for the payment input fields.
Rows
The number of rows the payment elements will be divided over.
Cells
The proportional configuration of cells the payment elements will be spaced within each row (values here are dependant upon the number of 'Rows' selected).
Row Styles
A set of inline CSS styles for the containing DIV of the row.
Cell Styles
A set of inline CSS styles for the containing DIV of the cell.
Cell Col Span
A value from 1-12 describing what portion of the row the cell consumes when the browser width is greater than 480px.
Field Styles
A set of inline CSS styles for the input field element.
Field Div Styles
A set of inline CSS styles for the containing DIV of the input field element.
Field Col Span
A value from 1-12 describing what portion of the cell is consumed by the control when the browser width is greater than 480px.

Bambora EU

https://www.bambora.com/

Log into your Payment Gateway account to gather the credentials required (as displayed in the WebinOne admin) in order to set up the gateway integration.

You may need to check the gateway provider’s help documentation or contact their support agents to determine this information.

At time of writing this documentation, the gateway's API credentials could be retrieved by following the instructions here https://developer.bambora.com/europe/checkout/getting-started/access-api.

SETTINGS

Setting
Description
Access Key
Credentials from your gateway account.
Secret Key
Credentials from your gateway account.
Merchant Number
Credentials from your gateway account.
MD5 hash key
Credentials from your gateway account.
Two-step card payments

With this option enabled, the customer's card payment, at time of form submission, is authorised only and the funds will be captured later, after a second step has been completed - such as processing the payment from the Order details pages in the WebinOne admin once the purchase has been delivered, for example.

In this scenario, the Order and any email notifications are generated as normal, however the amount and Order status is set to “Pending”. Once the payment has been processed successfully the status is set to “Success”.

If the payment fails, is canceled via the admin, or is not processed within the 7 days hold period, the order status will be set to “Canceled”.

Orders with failed payments can be amended by adding manual “cash” payments against them via the Order detail page, or by initiating the Deferred Payment workflow.

If the order consists of only digital/downloadable products then this Two-step payment flow will be ignored and the default, Instant payment flow will be used.

APPEARANCE

There are currently no styling options available for this gateway's input fields.

Authorize.Net

https://www.authorize.net/

Log into your Payment Gateway account to gather the credentials required (as displayed in the WebinOne admin) in order to set up the gateway integration.

You may need to check the gateway provider’s help documentation or contact their support agents to determine this information.

At time of writing this documentation, the gateway's API credentials could be setup here https://developer.authorize.net/hello_world/sandbox.html.

Authorize.Net requires the customer's first and last name be submitted with payment requests. So if First and Last Name system fields are not present in your payment form an error may be presented and the payment may not be processed.

SETTINGS

Setting
Description
API LOGIN ID
Credentials from your gateway account.
Transaction Key
Credentials from your gateway account.
Client Key
Credentials from your gateway account.
Signature Key
Credentials from your gateway account.
Endpoint

Production
Instructs the gateway to use the live production interface for accepting real transactions. Typically used for live sites ready for accepting real-world payments.

Sandbox
Instructs the gateway to use the test/sandbox interface for accepting test transactions. Typically used for trial sites or when setting up/testing a payment flow.

Subscription Access

*Potential issue for recurring subscriptions: Authorize.Net does not charge the customer’s card immediately, but rather on the next day at 2:00am (PST) Authorize.Net documentation.
Since secure zone access is based on successful payment, the user may not be granted access until a day later.
These are two options relating to this delayed payment issue.

Give access once payment received only
Leave the delayed payment process in place and wait for the customer to be assigned to the secure zone if a successful payment is made. (Subsequent recurring cycles will be charged without this delay)

Give one-day access before payment received
Apply a one-day subscription, allowing the customer to login initially.
If the charge is later successful then the subscription will be extended for the desired number of days.

APPEARANCE

There are currently no styling options available for this gateway's input fields.

PayPal

https://www.paypal.com/

Log into your Payment Gateway account to gather the credentials required (as displayed in the WebinOne admin) in order to set up the gateway integration.

You may need to check the gateway provider’s help documentation or contact their support agents to determine this information.

At time of writing this documentation, the gateway's API credentials could be retrieved, after logging into your PayPal account, from PayPal's Developer website here https://developer.paypal.com/, under 'My Apps & Credentials' then creating a new REST API App for either the Sandbox or Live environments.

The WebinOne PayPal integration uses the “PayPal Commerce” service. PayPal PayFlow, PayPal Pro, or other paid services are NOT required for this integration. However, your PayPal account may need to be approved for ‘Advanced Payments’ to allow the payment fields to display. To apply for ‘Advanced Payments’, or if you are experiencing issues with PayPal gateway setup, see the troubleshooting section below for further steps.

Create REST API App

PayPal REST API App

App Credentials

PayPal API Credentials

SETTINGS

Setting
Description
Api Key
Credentials from your gateway account.
Secret
Credentials from your gateway account.
Endpoint

Production
Instructs the gateway to use the live production interface for accepting real transactions. Typically used for live sites ready for accepting real-world payments.

Sandbox
Instructs the gateway to use the test/sandbox interface for accepting test transactions. Typically used for trial sites or when setting up/testing a payment flow.

APPEARANCE

There are currently no styling options available for this gateway's input fields.

TROUBLESHOOTING

If you are experiencing issues with PayPal gateway setup, such as payment fields are not displaying and you’re seeing an error in your browsers console saying “hosted fields are not eligible”, below are some steps to check to resolve the issue:

  • Ensure your developer account is linked/created with the PayPal business account that will be used.
  • Create the Sandbox/Live App account/s from the linked developer account.
  • The Sandbox/Live App account/s should also be setup as PayPal business accounts and both Sandbox and Live accounts need to be enabled for advanced payments (use this link for more info and to apply)

If you continue to experience issues, reach out to PayPal support to see if there are any issues with your account setup or App credentials.

Pay with PayPal

https://www.paypal.com/

Log into your Payment Gateway account to gather the credentials required (as displayed in the WebinOne admin) in order to set up the gateway integration.

You may need to check the gateway provider’s help documentation or contact their support agents to determine this information.

At time of writing this documentation, the gateway's API credentials could be retrieved, after logging into your PayPal account, from PayPal's Developer website here https://developer.paypal.com/, under 'My Apps & Credentials' then creating a new REST API App for either the Sandbox or Live environments.

If you are receiving errors when testing PayPal payments, it could be due to your PayPal account still pending approval. Check your PayPal account for any notifications asking for further setup details.

Create REST API App

PayPal REST API App

App Credentials

PayPal API Credentials

SETTINGS

Setting
Description
Api Key
Credentials from your gateway account.
Secret
Credentials from your gateway account.
Endpoint

Production
Instructs the gateway to use the live production interface for accepting real transactions. Typically used for live sites ready for accepting real-world payments.

Sandbox
Instructs the gateway to use the test/sandbox interface for accepting test transactions. Typically used for trial sites or when setting up/testing a payment flow.

APPEARANCE

There are currently no styling options available for this gateway's input fields.