Payment Gateway Screen

Last verified with: 10.8.6.0

Overview #

Payment gateways are used to process account payments through integrated payment providers. Once a payment gateway is configured, it can support online payment methods, payment processing, and related account-payment workflows.

The screen supports provider-specific configuration. Depending on the selected payment provider and gateway type, the available fields, compatibility options, authentication settings, and merchant-account controls can vary.

Prerequisites #

• Any deployment-level prerequisites for the selected payment provider must already be completed.
• The credentials and connection details supplied by the payment provider must be available before the gateway is configured.

Payment Gateway Panel #

The Payment Gateway panel on the left lists the configured gateways. Select a gateway to view or edit its details in the panel on the right.

Actions #

Icon	Description
	Adds a new payment gateway

Edit Payment Gateway Panel #

The Edit Payment Gateway panel displays the configuration for the selected gateway.

Core Fields #

• Name: Identifies the payment gateway.
• Description: Stores an optional description for the gateway configuration.
• Active: Enables or disables the gateway for payment processing.
• Payment Provider: Defines the provider framework used by the gateway, such as Spreedly or Adyen.
• Gateway Type: Defines the specific gateway integration available under the selected provider.
• Is 3DS2: Enables 3DS2 behavior when that option is supported for the selected provider.

Provider And Gateway Type #

The combination of Payment Provider and Gateway Type determines how the rest of the screen behaves.

Different providers can expose different setup sections, credential requirements, payment-entry behavior, and compatibility controls. For that reason, administrators should first decide which provider and gateway type they are configuring before completing the remaining fields.

Spreedly Configuration #

When a Spreedly-based provider is selected, the screen can display the gateway payment URL and dynamic gateway-specific credentials.

Spreedly Field #

• Payment URL: Stores the payment API URL used by the configured Spreedly-based gateway.

Adyen Configuration #

When an Adyen-based provider is selected, the screen exposes additional Adyen-specific configuration areas.

Adyen Fields #

• Management URL: Stores the Adyen management API URL.
• Production Prefix: Stores the production URL prefix used for live gateway communication when applicable.
• Test Gateway: Indicates that the gateway is configured for test or non-production use.
• Capture Setting: Controls the configured payment-capture behavior for the gateway.
• Is 3DS2: Enables 3DS2 behavior for the gateway when required.

Authentication And Security #

The Authentication and Security section is used to store provider credentials and security-related values.

Authentication And Security Fields #

• API Key: Stores the API key used to authenticate the gateway connection.
• Callback User ID: Identifies the callback user associated with provider communication.
• User Agent: Stores the user-agent value used for provider communication when required.
• HMAC Key: Stores the HMAC key used for signed or verified provider communication.

Some gateway types can also expose additional credentials dynamically. These credential fields depend on the selected gateway type and may differ between integrations.

Merchant Accounts #

For providers that support merchant-account mapping, the screen includes a Merchant Accounts section.

This area allows administrators to review available merchant accounts, filter the merchant-account list, and map merchant accounts to countries. It also supports separate drop-in merchant-account mapping where applicable.

Merchant Account Actions #

• Pull Merchant Accounts: Synchronizes or refreshes the merchant-account list from the provider. This action should be used after the gateway configuration has been saved and is in a stable state.

Merchant Account Country Grid #

The merchant-account grid can include:

• Country: The country for the mapping row.
• Merchant Account: The merchant account used for the country.
• Drop-in Merchant Account: An alternate merchant account used for drop-in payment-entry behavior when supported.

Services And Compatibility #

The gateway configuration can also include compatibility settings that control what the gateway supports in the application.

Compatibility Options #

• Payment Types: Defines which payment base types are active for the gateway, such as credit card or ACH.
• Card Types: Defines which supported card brands are enabled for the gateway.
• CVV Required: Controls whether card payments require CVV entry when that behavior is supported.
• Regions: Displays the supported payment regions for the gateway.

Guides #

Adding Payment Gateways #

1. In the Payment Gateway panel, click Add.
2. Enter the Name and Description, if needed.
3. Select the Payment Provider.
4. Select the Gateway Type.
5. If the gateway should be available immediately, enable Active.
6. Complete the provider-specific configuration fields.
7. Complete the Authentication and Security section.
8. Review any compatibility settings, such as payment types, card types, or regions.
9. Click Save.

Editing Payment Gateways #

1. In the Payment Gateway panel, select the gateway you want to update.
2. Update the gateway details as needed.
3. Review provider-specific sections such as Adyen settings, credentials, merchant accounts, and compatibility settings.
4. Click Save.