Adding a Gateway
This article provides instructions to manage your gateways and gateway categories.
Add a Gateway Category
You will want to categorize your gateways by the corp they were acquired by. This is necessary to prevent cross-corping.
Select Gateways → Gateway List. Click the green + Category button.
A pop up box will appear. Enter a category name. Click on the green Create Category button.
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
Select Gateways → Gateway List. Click the smaller green + button.
Enter a Title and select a gateway provider with the Gateway dropdown under the General Details section.
Enter gateway provider credentials and fill in the Descripter and Mid # underneath the Gateway Details section and any additional fields as wanted.
Title, Gateway, Descriptor, Mid # are required fields.
Please review all information for accuracy before creating a new gateway.
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.
When you are finished entering your gateway information, click the green Create Gateway button.
Gateway Fields
General Details
Title
A name or identifier for the gateway.
This value can be dynamically added to auto-responders 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.
For more information on your specific gateway, please locate it in Gateways.
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 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 as the cs_email token.
URL
A support web page related to the gateway.
This value can be dynamically added to auto-responders 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: "Gateway capped".
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.
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 Free
This is a flat rate that is charged by the gateway for each RDR refund. See RDR 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.
Additional Options
Enabled
If disabled, Sale and Authorize transactions, including rebill transactions, will decline with the response: "Biller has been disabled".
This only applies to Sale and Authorize transactions. It will not affect Refunds, Voids, and Captures.
Disabled gateways will still display under the Live Gateways View option (unless deleted) but will display with red, crossed-out text.
Block Prepaid Cards
If disabled, Sale and Authorize transactions, including rebill transactions, will decline with the response: "Prepaid Credit Cards Are Not Accepted".
Block Debit Cards
If disabled, Sale and Authorize transactions, including rebill transactions, will decline with the response: "Debit Cards Are Not Accepted".
Direct Cascade Profile
The ATRI Cascade Profile to use to immediately reattempt new sale transactions that soft-declined on this gateway.
Accepted Payment
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.
eCheck
If disabled, transactions will decline with the response : "ACH Transactions Disabled"
MasterCard
If disabled, transactions will decline with the response : "MASTERCARD is not a supported card type."
Visa
If disabled, transactions will decline with the response : "VISA is not a supported card type."
AmEx
If disabled, transactions will decline with the response : "AMEX is not a supported card type."
Discover
If disabled, transactions will decline with the response : "DISCOVER is not a supported card type."
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 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.
Mid #
The merchant account's MID Number.
Processor
The name of the merchant account's processor.
Merchant Category Code
The Merchant Category Code (MCC) of the merchant account.
Acquirer Bin
The acquirer bin number of the merchant account.
Last updated
