November 28, 2018
UPDATED March 1, 2020
To configure NMI PaySafe Gateway into your sticky.io CRM, you will go to Payments>Gateways, under ACTIONS select Add New Provider Profile.Select the type = Payment/Gateway and select NMI PaySafe from the drop down.Fill out the gateway parameters which are outlined below and click “Save”.
For more information on this Gateway click here https://www.nmi.com/
These parameters are briefly described here for your reference:
Alias: Name that you will assign to the gateway. This is for internal purposes only; it helps you identify a specific gateway account among several of them in your CRM.
Username: Will be provided to you by Network Merchants Inc.
Password: Same password that you have set up for your account with Network Merchants Inc.
Currency: Network Merchants Inc currently supports AED, ARS, AUD, BOB, BRL, CAD, CHF, CLP, CNY, COP, DKK, EUR, GBP, HKD, IDR, ILS, INR, JPY, KRW, MXN, MYR, NOK, NZD, PEN, PHP, PLN, PYG, RUB, SEC, SGD, THB, TRY, TWD, USD & ZAR currencies. You can select one currency per gateway account.
Use Pre-Auth Filter?: Set to YES only if using the Pre-Auth Filter* service through this gateway account. Optional.
Void Pre-Auth: Set to YES if you want to void a successful Pre-Auth immediately; set to NO if you want to hold a successful Pre-Auth and capture it at the rebill charge. Optional
Capture on Shipment: Set to YES if you want to capture an authorization once an order is marked a shipped in the CRM. Also, an order will remain as pending in the system until the authorization is captured upon shipment. Set to No if you want the standard authorization and capture process for your orders. Optional.
Sticky.io 3D Verify: Set to YES if you are using the 3D Verify service
Test Mode: Set to YES if you would like to use this gateway in test mode.
Required SSN: Set to Yes if the social security number is required. Optional
CIT/MIT Parameters: CIT/MIT Parameters: Set to Yes to introduce Merchant Initiated Transaction/Customer Initiated Transaction parameters to the request to NMI. This is necessary to comply to recent Visa regulations.
Please refer to the Visa document located here containing additional detailed level information regarding these requirements in support of the mandate for updating merchant systems and processes.
Post Phone: Set to Yes to post the customer phone number in the sale request. Optional.
Post Processor ID: Set to YES only if you will be doing Payment Routing with Sticky Processing* through this gateway account. Optional.
Post Descriptor?: Set to YES to post the descriptor from your profile to the gateway. Optional.
Post Product Description?: Set to YES if you desire to post product descriptions to your gateway account. Optional.
Enable Delayed Capture: allows you to authorize the payment on day 1 and capture it in “x” number of days. Applies to initials and recurring orders, it creates the orders in a “Pending” status and they won’t be sent to fulfillment until the charge is captured and the status is updated to “Approved”.
Delayed Capture Days: number of days in which you wish to capture the charge, this is to be used with Enable Delayed Capture.
MDF1- MDF20: Merchant Defined Fields* are described below. These are optional fields.
Gateway Alias: Name that you will assign to the gateway. This is for internal purposes only; it helps you identify a specific gateway account among several of them in your CRM.
There are 2 Required Fields on the Merchant Account Details tab. *Descriptor - This will be the MID Descriptor *Customer Service Number - The customer service number assigned to the MID
There is 1 Required Field on the Limits and Fees tab *Global Monthly Cap - This will be the sales amount allowed monthly on this MID
To maximize the efficiency of sticky.io Reporting Analytics we suggest you take a moment and fill out the rest of the fields. These will all be used in sticky.io’s profitability reports.
For field definitions on all of the fields on the Merchant Account Details Tab and the Limits & Fees Tab - click here- overview of gateway providers
Once your gateway profile has been created, then you will go through your campaigns and assign the gateway to the corresponding campaign(s).
Merchant Defined Fields:
Network Merchants Inc. contains several Merchant Defined Fields (MDF1-MDF20) that allow you to customize the transactions that you will be processing through this gateway. These MDFs will append certain information to these transactions based on the order details. Please be aware that these fields are optional.
To ease the process of using the MDFs, we have created various Tokens that you can use to dynamically insert certain values into these Merchant Defined Fields depending on what values you want to send over to the gateway.
These are the tokens** you can use and a brief description of the values that each one will insert in your MDF:
{ACQUISITIONDATE}
Passes to the gateway the date of the original parent order on rebills in MM/DD/YYYY format.
{AFFILIATEID}
Inserts the affiliate id from the order. It will obtain this value from the AFFID, AFID or AID field, whichever is populated; if none of them have data, it will not include it on the post.
{CAMPAIGNDESCRIP}
Inserts the campaign description of the campaign from where the order is generated.
{CAMPAIGNID}
Inserts the campaign id from where the order is generated.
{CATEGORYNAME}
Inserts the category name that the main product sold belongs to.
{COUPONDISCOUNTAMOUNT}
This is populated with the coupon discount on the order, i.e. 1.00.
{CUSTOMERID}
Provides the customer id of the order being billed. Please be aware that this is only valid on rebills; on new initial orders, the customer id will be 0 because a new customer will not have a customer id until after he has a successful order in your system.
{INITIALTRANSID} This will return the transaction id for the initial order.
{PRODUCTID}
Inserts the product id of the main product sold.
{PRODUCTNAME}
Inserts the product name of the main product sold.
{PRODUCTSKU}
Inserts the product SKU number of the main product sold.
{REBILLDEPTH}
This will insert the current rebill depth of the order. For example, if the order is the first rebill for a customer, this would be 1, if it was the second rebill, it would be 2, and so on. For initial new orders, this will be 0.
{REPROCESSINGATTEMPTS}
This is populated with the current reprocessing attempt for the order, which will be populated with 0 if the order is not being reprocessed.
{RETRYCOUNT}
Inserts what retry count the order is at. For example, if a rebill has declined two times, then this would be 3, meaning it is the third attempt to get an approval.
{SHIPPINGID}
Inserts the shipping id of the order.
{SHIPPINGMETHOD}
Inserts the shipping method of the order.
{SUBAFFILIATEID}
Inserts the sub affiliate id. It will post all the sub id's based on the affiliate id of that order. For example, for AFFID, it will post the value of C1, C2 and C3 as a concatenated string separated by commas: C1value,C2value,C3value For AFID and AID it will just be the value of SID or OPT respectively.
{THM_SESSION_ID}
Passes a session Id to the gateway. In order to set the value received from Threat Matrix after they give you a session ID on the webforms, use a javascript to set the value of a hidden field that is in the HTML form on your credit card payment page. Example: document.getElementById("thm_session_id").value = threatMatrixID;
To use with our API, submit the value that Threat Matrix responds back in an example like this where the threat matrix session id is 12345: &thm_session_id=12345
The {THM_SESSION_ID} token can only be used in the MDF17 field.
**These tokens can be placed in any of the 20 Merchant Defined Fields. For an explanation of what each MDF is actually used for, please look at your gateway API documentation, as this will vary per gateway.
Pre-Auth Filter: This service applies to initials orders only. It allows you to pre-auth a higher dollar amount on the consumer’s credit card before approving the current order to verify if extra funds are available. If the pre-auth is successful, it gets voided immediately and the current order is approved. If the pre-auth fails, the current order gets declined and the system will keep log of the decline reason under the declined order details.
This is of great benefit when doing Free Trials as it helps you increase your chances of a successful rebill.
To enable this feature, you will set the Pre-Auth Filter to YES under the gateway profile within your CRM, as indicated in the above parameters description. Next, you will assign the gateway to the campaign where you would like to use the filter, and you will set the amount that you want to pre-auth at the campaign level. This will be disabled by default with a $0.00 amount in it, and it gets enabled as soon as you enter a valid dollar amount to pre-auth.
You can assign the same gateway to multiple campaigns and set different pre-auth amounts based on your needs per campaign.
Once your gateway profile has been created, then you will go through your campaigns and assign the gateway to the corresponding campaign(s).
{THM_SESSION_ID}
Passes a session Id to the gateway. In order to set the value received from Threat Matrix after they give you a session ID on the webforms, use a javascript to set the value of a hidden field that is in the HTML form on your credit card payment page. Example: document.getElementById("thm_session_id").value = threatMatrixID;
To use with our API, submit the value that Threat Matrix responds back in an example like this where the threat matrix session id is 12345: &thm_session_id=12345
· The {THM_SESSION_ID} token can only be used in the MDF17 field.
Additional Network Merchants Inc Gateway Notes
If a subscription rebill attempt fails for one of the reasons listed below, the subscription will not proceed through decline salvage. Instead, the subscription order will be placed on an immediate hold. This also applies to cascade, any orders that decline with the reasons below will not be eligible to cascade as they are considered hard declines.
250 Pick up card 251 Lost card 252 Stolen card 253 Fraudulent card