# Adding a Gateway

This article provides instructions to add/manage your gateways and gateway categories. Your gateway (sometimes referred to as the processor, payment processor, merchant account, or MID) is the bridge between your website and the financial institutions that are involved with processing each transaction.

***

## Add a Gateway Category <a href="#add-a-gateway-category" id="add-a-gateway-category"></a>

{% hint style="warning" %}
You will want to categorize your gateways by the corp they were acquired by. This is necessary to prevent cross-corping.
{% endhint %}

Select **Gateways →** **Gateway List.**  Click the green **+ Category** button.

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2FLOYqrTQbdFDlWW33HOab%2FUntitled.png?alt=media&#x26;token=b021c82e-bbce-415d-bde1-991789b707da" alt=""><figcaption></figcaption></figure>

A pop up box will appear. Enter a category name.  Click on the green **Create Category** button.

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2FDnBsLjXL8QzBsd9fI4xV%2FUntitled.png?alt=media&#x26;token=9766212e-c40b-4651-8ff3-286598a35518" alt=""><figcaption></figcaption></figure>

Once you create the categories, use the **Category** dropdown at the top of the gateway list to filter for a specific category.

***

## Create a New Gateway <a href="#create-a-new-gateway" id="create-a-new-gateway"></a>

Select **Gateways → Gateway List.** Click the smaller green **+** button.

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2FfsXIpnLV0fVlHxXekcHl%2FUntitled.png?alt=media&#x26;token=ad9a453b-3f9a-4cb7-888f-55ee4697c906" alt=""><figcaption></figcaption></figure>

Enter a **Title** and select a gateway provider with the **Gateway** dropdown under the **General Details** section.

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2Ft1DP5X0fICbf5YyZzL4m%2Fimage.png?alt=media&#x26;token=1b1c8f62-d47f-4e19-8a13-6d11eac3db39" alt=""><figcaption></figcaption></figure>

Enter gateway provider credentials and fill in the **Descripter** and **Mid #** underneath the **Gateway Details** section and any additional fields as wanted.

{% hint style="warning" %}
[Title](#title), [Gateway](#gateway), and [Descriptor](#descriptor) are required fields.
{% endhint %}

{% hint style="danger" %}
Please review all information for accuracy before creating a new gateway.
{% endhint %}

{% hint style="info" %}
The gateway version labels are our own internal versioning and might not match the actual API version that we are integrated with for that gateway.
{% endhint %}

When you are finished entering your gateway information, click the green <mark style="color:green;">**Create Gateway**</mark> button.

***

## **Gateway Fields**

### **General Details**

#### **Title**

A name or identifier for the gateway.

This value can be dynamically added to [auto-responders](https://help.checkoutchamp.com/crm/crm-setup/campaign-setup/auto-responder-setup) as the **midTitle** token.

#### **Category**

The category that this gateway corresponds to.

#### **Gateway**

The gateway provider.

#### Gateway Provider Specific Fields

These fields will be different depending on the gateway, but at least one will relate to required **credentials** as provided by the merchant provider.

{% hint style="info" %}
For more information on your specific gateway, please locate it in [Gateways](https://help.checkoutchamp.com/crm/gateway-setup/gateway-integrations).
{% endhint %}

***

### Customer Service

**(Optional)** Enter the contact information related to the Gateway.

#### **Phone #**

The customer service phone number that customers should call related to the gateway.

This value can be dynamically added to [auto-responders](https://help.checkoutchamp.com/crm/crm-setup/campaign-setup/auto-responder-setup) as the **cs\_phone** token.

#### **Chargeback #**

The customer service phone number for chargebacks on the gateway.

#### **Email**

The customer service email that customers should use related to the gateway.

This value can be dynamically added to [auto-responders](https://help.checkoutchamp.com/crm/crm-setup/campaign-setup/auto-responder-setup) as the **cs\_email** token.

#### **URL**

A support web page related to the gateway.

This value can be dynamically added to [auto-responders](https://help.checkoutchamp.com/crm/crm-setup/campaign-setup/auto-responder-setup) as the **cs\_url** token.

***

### Limits

**(Recommended)** These values are used in reporting for various calculations related to gateway costs and available capacity.

#### **Monthly Cap**

This is the total volume per month that is allowed to process on the gateway. The CRM can calculate your cap usage two different ways:

* The first calculation includes only gross billings against the gateway and ignores refunds (this is default).
* The second calculation shows net billings and includes refunds to give the net billings for the month. You can enable the second option by checking **Include Refunds**.

If set (not the default 0.00), and the current transaction amount will put the gateway over the Monthly Cap value, then Sale and Authorize transactions, including rebill transactions, will decline with the response: "<mark style="color:red;">Gateway capped</mark>".

{% hint style="info" %}
This is not enforce if an upsell item is using the **Use Offer Gateway** option.

The upsell transaction will still run on the offer gateway if the gateway has capped since the offer transaction.
{% endhint %}

#### **Discount Rate**

The discount rate associated with the processor. This a percentage of volume taken by the bank on every sale.

#### **Reserve Rate**

This is a percentage on billings that the bank keeps in a rolling reserve.

#### **Transaction Fee**

This is a flat rate that is charged by the gateway for each transaction.

#### **Chargeback Fee**

This is a flat rate that is charged by the gateway for each chargeback.

#### **RDR Fee**

This is a flat rate that is charged by the gateway for each RDR refund. See [RDR](https://help.checkoutchamp.com/crm/gateway-setup/rdr) for more information.

#### **Ethoca Fee**

This is a flat rate that is charged by the gateway for each Ethoca refund. See [Ethoca Refunds](https://help.checkoutchamp.com/crm/gateway-setup/ethoca-refunds) for more information.

***

### Trial Limits

**(Optional)**

#### Validate Card Amount

This value will be used when validating a credit card against this gateway. Enter a custom amount used to validate the customer's card (the default is 1.00). You can enter any value less than 15.00.&#x20;

***

### Additional Options

#### Enabled

If disabled, Sale and Authorize transactions, including rebill transactions, will decline with the response: "<mark style="color:red;">Biller has been disabled</mark>".&#x20;

{% hint style="info" %}
This only applies to Sale and Authorize transactions. It will not affect Refunds, Voids, and Captures.
{% endhint %}

Disabled gateways will still display under the Live Gateways View option (unless deleted) but will display with red, crossed-out text.

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2FSY7eyuvFM925HsB9cmkf%2Fimage.png?alt=media&#x26;token=54b62ece-217a-47ea-a32b-b5a42669c072" alt=""><figcaption></figcaption></figure>

#### Block Prepaid Cards

If disabled, Sale and Authorize transactions, including rebill transactions, will decline with the response: "<mark style="color:red;">Prepaid Credit Cards Are Not Accepted</mark>".&#x20;

#### Block Debit Cards

If disabled, Sale and Authorize transactions, including rebill transactions, will decline with the response: "<mark style="color:red;">Debit Cards Are Not Accepted</mark>".&#x20;

#### Direct Cascade Profile

The ATRI Cascade Profile to use to immediately reattempt new sale transactions that soft-declined on this gateway.

***

### Accepted Payment

{% hint style="info" %}
Disabling a card payment type will prevent new sales. It will not affect existing rebills.

Disabling eCheck will affect both new sale and rebill transactions.

This only applies to Sale and Authorize transactions. It will not affect Refunds, Voids, and Captures.
{% endhint %}

#### eCheck

If disabled, transactions will decline with the response : "<mark style="color:red;">ACH Transactions Disabled</mark>"

#### MasterCard

If disabled, transactions will decline with the response : "<mark style="color:red;">MASTERCARD is not a supported card type.</mark>"

#### Visa

If disabled, transactions will decline with the response : "<mark style="color:red;">VISA is not a supported card type.</mark>"

#### AmEx

If disabled, transactions will decline with the response : "<mark style="color:red;">AMEX is not a supported card type.</mark>"

#### Discover

If disabled, transactions will decline with the response : "<mark style="color:red;">DISCOVER is not a supported card type.</mark>"

***

### Gateway Details

#### Descriptor

The short text description that appears on a customer's credit card statement or bank statement when a transaction is processed through this gateway.

This value can be dynamically added to some [auto-responders](https://help.checkoutchamp.com/crm/crm-setup/campaign-setup/auto-responder-setup) as the **midDescriptor** token.

Descriptors can also be set dynamically by campaign product or via Import Order or Import Upsale API calls. See [Dynamic Descriptors](https://help.checkoutchamp.com/crm/gateway-setup/dynamic-descriptors).

#### Mid \#

The merchant account number from the gateway.  This is optional for all gateways except NMI and Fluid Pay.

#### Processor

The name of the merchant account's processor.  This is optional.

#### Merchant Category Code

The Merchant Category Code (MCC) of the merchant account.  This is optional for all gateways except NMI and Fluid Pay.

#### Acquirer Bin

The acquirer bin number of the merchant account.  This is optional for all gateways except NMI and Fluid Pay.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.checkoutchamp.com/crm/gateway-setup/adding-a-gateway.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.