TABLE OF CONTENTS
The following gateway types are currently supported in the Spreedly Payment Plugin.
- Authorize.net
- Cybersource
- VersaPay (NMI)
- Vantiv Express (formerly Element)
To configure these payment methods, navigate to: System Settings > Plugins > Installed Plugins > Spreedly > Configuration Sets > “Add New” Button.
A page opens with the title “ADD CONFIGURATION SET- Spreedly”. The page is divided into three types of settings as below:
General Settings:
These settings are common for all the gateway types. The table below explains each field in the General settings.
Detail | Description |
Configuration Code | Unique code that differentiates configuration sets. Consider incorporating the gateway type. |
Display Name | Name that will be displayed on the Storefront for the payment method. |
Display Order | Display the order of the payment method. The sequence in which the payment methods are displayed on the Storefront depends on this order. |
Display Setting | Enable this option to display the payment method in the checkout flow on the Storefront. |
Gateway Type | Identifies the payment gateway being configured. The supported payment gateways can be selected from this dropdown. |
Gateway Settings:
The Gateway Settings options change based on the gateway type selected in the “Select Gateway Type” dropdown. The gateway type selection identifies which gateway the payment method is being created.
Configuring Gateway Settings for Authorize.net
The table below describes the fields that are required for Authorize.net
Detail | Description |
Select Gateway Mode | Gateway modes: Test Mode - Should be used for testing purposes. In test mode, the payment workflow remains the same as in live mode, except that the payment configuration and transactions are processed against a non-production environment. When in test mode, payment-related data (e.g., gateway credentials, credit card details) needs to be valid for the gateway’s non-production environment to avoid errors. Live Mode - Should be used for production processing. Payment configurations and transactions are processed against a production environment. When in live mode, payment-related data (e.g., gateway credentials, credit card details) needs to be valid for the gateway’s production environment to avoid errors.
|
Login | The login ID needs to be added in this field. |
Password | The password needs to be added in this field. |
Gateway Token | The gateway token is a read-only field that is not populated until the configuration set is saved. This value is provided by Spreedly and represented in the Znode Admin as confirmation that the payment configuration has been saved in the Spreedly system. |
Gateway Status | The “Gateway Status” is also a read-only field that is not populated until the configuration set is saved. This value is provided by Spreedly. It reflects the current operational state of the gateway as registered in Spreedly. |
Select Payment Type | Select the type of payment that applies to the payment configuration. The payment types available in the drop-down will change based on the payment gateway selected in the “Select a Gateway” drop-down. For Authorize.net, both the payment types, credit card and ACH, are available. |
Configuring Gateway Settings for Cybersource:
The fields like Select Gateway Mode, Gateway Token, and Gateway Status are common and explained above in the “Configuring Gateway Settings for Authorize.net”.
The table below shows the additional fields that are required for Cybersource
Detail | Description |
Merchant Id | The cybersource merchant ID needs to be added in this field. |
Private Key | The private key was generated in the Cybersource account. |
Public Key | The public key provided by Cybersource. |
Select Payment Type | The Select Payment Type is a read-only field, and it is set to credit card. As only the credit card payment type is currently supported for Cybersource. |
Configuring Gateway Settings for VersaPay (NMI):
The fields like Select Gateway Mode, Gateway Token, and Gateway Status are common and explained above in the “Configuring Gateway Settings for Authorize.net”.
The table below shows the additional fields that are required for VersaPay (NMI)
Detail | Description |
Authentication Mode | The Authentication Mode is a read-only field, and it is set to Security Key Only. VersaPay authenticates the account to the payment gateway using a secret key instead of a username and password. |
Security Key | The unique API key or secret provided by the VersaPay payment gateway. VersaPay uses this to securely communicate with the gateway. |
Select Payment Type | The Select Payment Type is a read-only field, and it is set to credit card. As only the credit card payment type is currently supported for VersaPay (NMI) |
The fields like Select Gateway Mode, Gateway Token, and Gateway Status are common and explained above in the “Configuring Gateway Settings for Authorize.net”.
The table below shows the additional fields that are required for Vantiv Express (formerly Element):
Detail | Description |
Acceptor Id | A unique identifier for your merchant account with Vantiv/Element. Used by the gateway to know which merchant account to process the transaction under. |
Account Id | Identifies the specific account within your Vantiv setup.
Often used along with Acceptor ID to route the payment properly. |
Application Id | Identifies the specific application or integration sending transactions to the gateway. Useful for reporting and tracking transaction sources. |
Application Name | A human-readable name for your application/integration. |
Application Version | Version of your payment integration. Helps the gateway track which version of your application is sending requests. |
Account Token | A secure token representing your merchant account credentials. |
Select Payment Type | The Select Payment Type is a read-only field, and it is set to credit card. Only the credit card payment type is currently supported for Vantiv Express. |
Znode Payment Settings
The Znode Payment Settings options may change based on the payment type selected in the “Select Payment Type” dropdown. For example, selecting the Authorize.Net gateway type and a payment type of credit card requires Znode payment settings to be configured. However, selecting a payment type of ACH, there are no required Znode payment settings, so the section is removed from display.
When the “Select Payment Type” option is set to Credit Card, the “Select Payment Setting” dropdown becomes visible under the “Znode Payment Settings” section. The table below explains the functionality of each option available in this dropdown.
Detail | Description |
Authorize and Capture | When this option is selected for the payment setting, the transaction is authorized, and the payment gets captured during order placement. |
Authorize Only | When this option is selected for the payment setting, the transaction gets authorized while placing the order. Additionally, when this option is selected, the “Display Capture in OMS” checkbox becomes visible on the configuration screen. If checked, a “Capture” option appears on the Manage Order screen below the “Save and Close” dropdown, allowing the admin to capture the payment manually. |
Verify Only | When this option is selected for the payment setting, the transaction is verified ($0 verification) during order placement. Additionally, the “Display Authorize in OMS” checkbox becomes visible on the configuration screen. If checked, an “Authorize” option appears on the Manage Order screen below the “Save and Close” dropdown, allowing the admin to manually authorize the payment. Furthermore, once this checkbox is checked, the “Display Capture in OMS” checkbox appears below it on the configuration screen. If enabled, a “Capture” option is displayed on the Manage Order screen below the “Save and Close” dropdown, allowing the admin to manually capture the payment.
|
Verify and Authorize | When this option is selected for the payment setting, the transaction gets verified ($0 verification) and authorized while placing the order. Also, the “Display Capture in OMS” checkbox becomes visible on the configuration screen for admins to capture the payment manually from the manage order screen.
|
Verify, Authorize, and Capture | When this option is selected for the payment setting, the transaction is verified and authorized, and the payment gets captured during order placement. |
