×
Menu
Search
 
   
   
   
 
  (c) PCI Pal 2020. The content on this page is subject to the Disclaimer Section (found on the Introduction page)

NMI Payment Gateway

 
This page details the inputs, secure inputs and outputs available for the NMI Payment Gateway, how to complete each field, and an external link to the NMI integration documentation.
 
PCI Pal must check any payment gateway integrations prior to going live.  The documentation disclaimer (which applies throughout this guide) should be read before commencing any configuration of payment gateways.
 

Inputs

Input Fields
Required
Character Limits/
Required Input
Description
username
Yes
n/a
Unique API Client Username provided by NMI
password
Yes
n/a
Unqiue API User Password provided by NMI
type
Yes
4 char
The type of transaction to be processed.
- sale
- auth
amount
No (sale or auth type only)
n/a
Total amount to be charged to two decimal places, e.g. 12.40
currency
No
3 char
The transaction currency. Format: ISO 4217
processor_id
No
n/a
If using Multiple MIDs, route to this processor (processor_id is obtained under Settings->Transaction Routing in the Control Panel).
order_description
No
n/a
Order description.
orderid
Yes
n/a
Order Id
first_name
No
n/a
Cardholder's first name.
last_name
No
n/a
Cardholder's last name
company
No
n/a
Cardholder's company
address_1
No
n/a
Card billing address
address_2
No
n/a
Card billing address, line 2
city
No
n/a
Card billing city
state
No
2 char
Card billing state. 2 digit code e.g. NY
zip
No
n/a
Card billing zip code
country
No
2 char
Card billing country. Country codes are as shown in ISO 3166. Format: CC
phone
No
n/a
Billing phone number
email
No
n/a
Billing email address
shipping_firstname
No
n/a
Shipping first name
shipping_lastname
No
n/a
Shipping last name
shipping_company
No
n/a
Shipping company
shipping_address1
No
n/a
Shipping address
shipping_address2
No
n/a
Shipping address, line 2
shipping_city
No
n/a
Shipping city
shipping_state
No
2 char
Shipping state. 2 digit code e.g. NY
shipping_zip
No
n/a
Shipping zip code
shipping_country
No
2 char
Shipping country. Country codes are as shown in ISO 3166. Format: CC
shipping_email
No
n/a
Shipping email address
customer_vault
No (vault only)
3 char
The type of action for vault
- add
merchant_defined_field_#
No
n/a
(# gets defined on the number of defined fields the customer wants). Custom field
 
 
Secure Inputs
Input Fields
Required
Character Limits/
Required Input
Description
ccnumber
Yes
19 num
Secure input of the card number
ccexp
Yes
2 num
Secure input of the card expiry - in the format MM
cvv
Yes
3 or 4 num
Secure input of the card CVV, either three or four digits long depending on the card
 
Outputs
Output Fields
Description
authcode
Transaction authorization code
responseText
Textual response
response
1 = Transaction Approved
2 = Transaction Declined
3 = Error in transaction data or system error
transactionid
Payment gateway transaction id
avsresponse
AVS response code
X     Exact match, 9-character numeric ZIP
Y     Exact match, 5-character numeric ZIP
D     Exact match, 5-character numeric ZIP
M     Exact match, 5-character numeric ZIP
2     Exact match, 5-character numeric ZIP, customer name
6     Exact match, 5-character numeric ZIP, customer name
A     Address match only
B     Address match only
3     Address, customer name match only
7     Address, customer name match only
W     9-character numeric ZIP match only
Z     5-character ZIP match only
P     5-character ZIP match only
L     5-character ZIP match only
1     5-character ZIP, customer name match only
5     5-character ZIP, customer name match only
N     No address or ZIP match only
C     No address or ZIP match only
4     No address or ZIP or customer name match only
8     No address or ZIP or customer name match only
U     Address unavailable
G     Non-U.S. issuer does not participate
I     Non-U.S. issuer does not participate
R     Issuer system unavailable
E     Not a mail/phone order
S     Service not supported
0     AVS not available
O     AVS not available
B     AVS not available
cvvresponse
CVV response code
M     CVV2/CVC2 match
N     CVV2/CVC2 no match
P     Not processed
S     Merchant has indicated that CVV2/CVC2 is not present on card
U     Issuer is not certified and/or has not provided Visa encryption keys
response_code
Numeric mapping of processor responses
100     Transaction was approved.
200     Transaction was declined by processor.
201     Do not honor.
202     Insufficient funds.
203     Over limit.
204     Transaction not allowed.
220     Incorrect payment information.
221     No such card issuer.
222     No card number on file with issuer.
223     Expired card.
224     Invalid expiration date.
225     Invalid card security code.
226     Invalid PIN.
240     Call issuer for further information.
250     Pick up card.
251     Lost card.
252     Stolen card.
253     Fraudulent card.
260     Declined with further instructions available. (See response text)
261     Declined-Stop all recurring payments.
262     Declined-Stop this recurring program.
263     Declined-Update cardholder data available.
264     Declined-Retry in a few days.
300     Transaction was rejected by gateway.
400     Transaction error returned by processor.
410     Invalid merchant configuration.
411     Merchant account is inactive.
420     Communication error.
421     Communication error with issuer.
430     Duplicate transaction at processor.
440     Processor format error.
441     Invalid transaction information.
460     Processor feature not available.
461     Unsupported card type.
customer_vault_id
Specifies a customer vault id.
errormessage
PCI Pal error message
 
Further information can be found by viewing the integration documentation:
NMI Integration Documentation
The help manual was created with Dr.Explain