Invoice Management

post

https://sandbox.nmi.com/api/transact.php

Never Use Real API Keys

Never use real API Keys when testing. The gateway allows Partners to create Test Merchant Accounts. Testing should always use keys from the Test Accounts and never keys from a Standard Account.

Methodology

Steps:

The customer sends their payment information to the merchant's web site.
The merchant web site posts the payment data to the Payment Gateway.
The Payment Gateway responds immediately with the results of the transactions.
The merchant web site displays the appropriate message to the customer.

The communication method used to send messages to the Payment Gateway's server is the standard HTTP protocol over an SSL connection.

In the Payment API method, the communications with the cardholder (Steps 1 and 4) are developed completely by the merchant and therefore are not defined by the Payment Gateway. Step 1 should simply collect the payment data from the cardholder and Step 4 should display the appropriate transaction receipt or declined message.

In Step 2, transaction details should be delivered to the Payment Gateway using the POST method with the appropriate variables defined below posted along with the request.

In Step 3, the transaction responses are returned in the body of the HTTP response in a query string name/value format delimited by ampersands. For example: variable1=value1&variable2=value2&variable3=value3

Customer Vault

The Customer Vault was designed specifically for businesses of any size to address concerns about handling customer payment information. Visa and MasterCard have instituted the Payment Card Industry (PCI) Data Security to protect cardholder data, wherever it resides, ensuring that members, merchants, and service providers maintain the highest information security standards.

These associations have also deemed that merchants will be held liable for any breach of cardholder data. This has become a major concern for merchants who handle credit card or electronic check payments. The Customer Vault is designed for these merchants who desire to avoid the tremendous costs and resources involved in becoming PCI compliant under these circumstances.

The Customer Vault does this by allowing merchants to transmit their payment information through a Secure Sockets Layer (SSL) connection for storage in our Level 1 PCI certified data facility. Once the customer record has been securely transmitted to the Customer Vault, the merchant can then initiate transactions remotely without having to access cardholder information directly. This process is accomplished without the merchant storing the customer's payment information in their local database or payment application.

Click to see invoice related notes

Update Invoice

All variables (besides currency) on an invoice may be updated. Updating an invoice will not result in a new invoice being sent to the customer.

Send Invoice

To send the invoice after updating an invoice, use the send_invoice request after making changes.

Response Code Table

Code	Description
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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Form Data

security_key

string

required

API Security Key assigned to a merchant account. New keys can be generated from the merchant control panel in Settings > Security Keys

invoicing

string

enum

required

Create a new invoice and email it to the customer.

Allowed:

amount

string

required

Total amount to be invoiced. Must be greater than 0.00.

Format: x.xx

string

required

Billing email address

payment_terms

string

When the invoice should be paid. Values: 'upon_receipt', or integers from 0-999. Default - upon_receipt.

payment_methods_allowed

string

What payment methods a customer may use when paying invoice.

Defaults to all available payment methods available in your merchant account Values: 'cc', 'ck', and 'cs'. Multiple payment types can be selected by comma-separating values.

processor_id

string

If using Multiple MIDs, route to this processor (processor_id is obtained under Settings → Transaction Routing in the Control Panel).

If allowing multiple payment types, one processor_id can be selected per payment type by submitting comma-separated values.

currency

string

The transaction currency.

Format: ISO 4217

order_description

string

Order description. Legacy variable includes: orderdescription

orderid

string

Order ID.

customer_id

string

Customer ID.

customer_tax_id

string

Customer Tax ID.

tax

float

Total sales tax amount.

shipping

float

Total shipping amount.

ponumber

string

Original purchase order.

first_name

string

Cardholder's first name. Legacy variable includes: firstname

last_name

string

Cardholder's last name. Legacy variable includes: lastname

company

string

Cardholder's company.

address1

string

Card billing address.

address2

string

Card billing address, line 2.

city

string

Card billing city.

state

string

Card billing state.

Format: CC

zip

string

Card billing zip code.

country

string

Card billing country. Country codes are as shown in ISO 3166-1 alpha-2.

Format: CC

phone

string

Billing phone number.

fax

string

Billing fax number.

website

string

Customer website.

shipping_firstname

string

Shipping first name.

shipping_lastname

string

Shipping last name.

shipping_company

string

Shipping company.

shipping_address1

string

Shipping address.

shipping_address2

string

Shipping address, line 2.

shipping_city

string

Shipping city.

shipping_state

string

Shipping state.

Format: CC

shipping_zip

string

Shipping zip code.

shipping_country

string

Shipping country. Country codes are as shown in ISO 3166-1 alpha-2.

Format: CC

shipping_email

string

Shipping email address.

merchant_defined_field_1

string

Merchant defined field which can be set up in merchant control panel under Settings->Merchant Defined Fields. You can pass custom information in up to 20 fields.

Format: merchant_defined_field_1=Value1, merchant_defined_field_2=Value2, etc...

item_product_code_1

string

Merchant defined description code of the item being purchased.

item_description_1

string

Description of the item(s) being supplied.

item_commodity_code_1

string

International description code of the individual good or service being supplied. The acquirer or processor will provide a list of current codes.

item_unit_of_measure_1

string

Code for units of measurement as used in international trade. Default: 'EACH'

item_unit_cost_1

float

Unit cost of item purchased, may contain up to 4 decimal places.

item_quantity_1

integer

Quantity of the item(s) being purchased. Default: '1'

item_total_amount_1

float

Purchase amount associated with the item. Defaults to: 'item_unit_cost_#' x 'item_quantity_#' rounded to the nearest penny.

item_tax_amount_1

float

Amount of sales tax on specific item. Amount should not be included in 'total_amount_#'. Default: '0.00'

item_tax_rate_1

float

Percentage representing the value-added tax applied. Default: '0.00'

item_discount_amount_1

float

Discount amount which can have been applied by the merchant on the sale of the specific item. Amount should not be included in 'total_amount_#'.

item_discount_rate_1

float

Discount rate for the line item. 1% = 1.00. Default: '0.00'

item_tax_type_1

string

Type of value-added taxes that are being used.

item_alternate_tax_id_1

string

Tax identification number of the merchant that reported the alternate tax amount.

Response

200Invoice operation completed successfully