For the complete documentation index, see llms.txt. This page is also available as Markdown.

Gateway Settings

The Gateway Settings API allows you to configure terminal-level settings that control payment processing behavior, security rules, and integrations.

Use the gateway settings API to:

  • Configure duplicate transaction checks

  • Manage terminal settings and time zones

  • Enable and configure recurring payment settings (RPS)

  • Configure reporting and batch processing settings

  • Manage Paylink and Hosted Payment Page (HPP) settings

  • Set security rules such as AVS and CSC

  • Manage transaction alerts

The sections below describe the respective gateway settings.

Duplicate Transaction

The Duplicate Transaction resource allows you to configure and manage duplicate transaction check settings for a terminal.

Terminal

The Terminal resource allows you to manage general configuration settings for a payment terminal.

RPS

The RPS (Recurring Payment Settings) resource allows you to configure recurring payment settings at the terminal level.

Report

The Report resource allows you to configure the terminal settings report.

The Paylink resource allows you to configure settings for payment link-based transactions.

Integrating the Paylink lets you send a payment link to customers by text message (SMS) or e-mail as an invoice payment request to accept payments online. This secure link directs your customers to a pre-generated payment form where they can pay by credit card, debit card, or ACH.

Integrate the securely hosted Paylink into your website using the Paylink Settings API.

To protect the hosted payment form from fraudulent card testing and payment delays.

1

Secure access to the payment page

Require login credentials to access the hosted payment form. This helps deter card‑testing attempts and indexing by search engines.

Creating an additional authorization fee protects the payment form on your site from malicious activity.

2

Enable Card Security Code (CSC)

Require customers to enter a Card Security Code (CSC) when making payments on the hosted payment form. This helps verify card authenticity.

Enable CSC for Virtual Terminal

To enable CSC for the Virtual Terminal:

  1. In the Merchant Portal, go to Virtual Terminal > VT Settings > Card Security Code (CSC).

  2. Enable the Card Security Code (CSC) setting.

Enable CSC for Paylink

To enable CSC for the Paylink:

  1. In the Merchant Portal, go to Virtual Terminal > VT Settings > Paylink > Configurable Payment Page Properties > Card Payment Properties.

  2. Set CVC required to True.

The CVC required property is set to True by default for Paylink settings.

CSC

The CSC (Card Security Code) resource allows you to configure card security code validation rules for transactions.

AVS

The AVS (Address Verification Service) resource allows you to enable or disable AVS and configure address verification rules for card transactions.

Transaction Alert

The Transaction Alert resource allows you to configure transaction alert settings for a specific merchant and terminal, including the callback URL used to receive transaction webhook notifications.

Verify transaction webhook signature

Verify each webhook signature before processing its payload.

1

Receive the webhook payload

Configure your callback URL to receive transaction webhook notifications.

Each notification includes the transaction payload and a signature field.

2

Verify the signature

Verify the signature locally with the public key for the processing terminal.

Alternatively, send the complete payload to the Hosted Payment Page signature verification service. Process the transaction only after successful verification.

For more details about transaction webhooks, see Transaction Webhooks.

Last updated

Was this helpful?