Query API

post

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

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

condition

string

enum

A combination of values can be passed and should be separated by commas.

For example, to retrieve all transactions pending settlement or complete, the following could be used:

condition=pendingsettlement,complete

Conditions

Condition	Description
pending	'Auth Only' transactions that are awaiting capture.
pendingsettlement	Transaction is awaiting settlement.
in_progress	Three-Step Redirect API transaction has not yet been completed. The transaction condition will change to 'abandoned' if 24 hours pass with no further action.
abandoned	Three-Step Redirect API transaction has not been completed, and has timed out.
failed	Transaction has failed.
canceled	Transaction has been voided.
complete	Transaction has settled.
unknown	An unknown error was encountered while processing this transaction.

transaction_type

string

enum

Retrieves only transactions with the specified transaction type.

Transaction Types

Transaction Type	Description
cc	A credit card transaction.
ck	A check transaction.
cs	A cash transaction.

Allowed:

action_type

string

enum

Retrieves only transactions with the specified action types. A combination of the values can be used and
should be separated by commas.

For example, to retrieve all transactions with credit or refund actions, use the following:

action_type=refund,credit

Action Types

Action Type	Description
sale	Sale transactions.
refund	Refund transactions.
credit	Credit transactions.
auth	'Auth Only' transactions.
capture	Captured transactions.
void	Voided transactions.
return	Electronic Check (ACH) transactions that have returned, as well as credit card chargebacks.
validate	Validated transactions.

source

string

enum

Retrieves only transactions with a particular 'transaction source'. A combination of the values can be used
and should be separated by commas.

For example, to retrieve all transactions with api or recurring actions, use the following:

source=api,recurring

Sources

Source	Description
api	API transactions.
batch_upload	Batch Upload transactions.
mobile	Mobile (iProcess) transactions.
quickclick	QuickClick transactions.
quickbooks	QuickBooks SyncPay transactions.
recurring	Recurring transactions when using Recurring module.
swipe	Swipe transactions.
virtual_terminal	Virtual Terminal transactions.
internal	Internal transactions. Typically indicates settlement.

transaction_id

string

Specify a transaction ID or a comma separated list of transaction IDs to retrieve information on.
Alternatively, provide a Subscription ID to retrieve processed (approved and declined) transactions
associated with it.

subscription_id

string

Set a specific subscription record or comma separated list of records. Using this with a transaction search
will return all transactions associated with this subscription. This will return this subscription's payment/plan
information when used with report_type=recurring.

invoice_id

string

Set a specific Invoice ID. Should only be used when report_type=invoicing.

partial_payment_id

string

Retrieves only transactions with the specified partial payment ID.

order_id

string

Retrieves only transactions with the specified Order ID.

first_name

string

Retrieves only transactions with the specified first name.

last_name

string

Retrieves only transactions with the specified last name.

address1

string

Retrieves only transactions with the specified specified address.

city

string

Retrieves only transactions with the specified city.

state

string

Retrieves only transactions with the specified state.

Format: CC

zip

string

Retrieves only transactions with the specified zip/postal code.

phone

string

Retrieves only transactions with the specified phone number.

fax

string

Retrieves only transactions with the specified fax number.

order_description

string

Retrieves only transactions with the specified order description.

drivers_license_number

string

Retrieves only transactions with the specified driver's license number.

drivers_license_dob

string

Retrieves only transactions with the specified driver's license date of birth.

drivers_license_state

string

Retrieves only transactions with the specified driver's license state.

string

Retrieves only transactions with the specified billing email address.

cc_number

string

enum

required

Retrieves only transactions with the specified credit card number. You can use either the full number or the last 4 digits of the credit card number. Note: The last four digits in the test card number for Visa, MasterCard, and American Express are identical. In order to receive type-specific transactions, use the full test card number.

Allowed Card Numbers:

Card Type	Test Card Number
Visa	4111111111111111
MasterCard	5431111111111111
Discover	6011000991300009
American Express	341111111111111
Diner's Club	30205252489926
JCB	3541963594572595
Maestro	6799990100000000019
Visa, MasterCard, & American Express	1111
Discover	0009
Diner's Club	9926
JCB	2595
Maestro	0019

merchant_defined_field_1

string

Retrieves only transactions with the specified merchant defined field value.
Replace the '1' with a field number (1-20) (Example: merchant_defined_field_12=value)

start_date

date-time

Only transactions that have been modified on or after this date will be retrieved.
Note that any actions performed on a transaction will cause the modified date to be updated.

Format: YYYYMMDDhhmmss

end_date

date-time

Only transactions that have been modified on or before this date will be retrieved.
Note that any actions performed on a transaction will cause the modified date to be updated.

Format: YYYYMMDDhhmmss

report_type

string

enum

Sets the report type.

If you would like to query the Customer Vault to view what customer information is stored in the Customer Vault, you must set the customer_vault variable.
If you omit the customer_vault_id, the system will return all customers that are stored in the vault.
If you include a customer_vault_id, it will return the customer record associated with that ID.

Example: report_type=customer_vault&customer_vault _id=123456789

Report Types

Report Type	Description
receipt	Will return an html receipt for a specified transaction id.
customer_vault	Set the Query API to return Customer Vault data.
recurring	Set the Query API to return subscription data.
recurring_plans	Set the Query API to return plan data.
invoicing	Set the Query API to return invoicing data.
gateway_processors	Will return Processor details a user has permissions for. Specify a "user" by querying with that security key.
account_updater	Will return Customer Vault data that has been updated using the Account Updater service.
test_mode_status	Will return whether the account has test mode active or inactive.
profile	Return merchant profile (company, email, address, timezone, defined fields, gateway, favicon, status). It will also return card_schemes with 'processor_details' set to 'true'

mobile_device_license

string

Retrieves only transactions processed using the specified mobile device.

The device IDs for this parameter are available in the License Manager.
Use 'any_mobile' to retrieve all mobile transactions.
A combination of the values can be used and should be separated by commas.
Can not be used with 'mobile_device_nickname'.

Example 1: mobile_device_license=D91AC56A-4242-3131-2323-2AE4AA6DB6EB
Example 2: mobile_device_license=any_mobile

mobile_device_nickname

string

Retrieves only transactions processed using mobile devices with the specified nickname.

The nicknames for this parameter are available in the License Manager.
Can not be used with 'mobile_device_license'.

Example (URL encoded): mobile_device_nickname=Jim's%20iPhone

customer_vault_id

string

Set a specific Customer Vault record. Should only be used when report_type=customer_vault.

date_search

string

enum

Allows Customer Vault information to be returned based on the 'created' or 'updated' date.

If you would like to query the Customer Vault to view when customer information was created or updated, you must set the report_type variable with the customer_vault value.
If you omit the report_type variable, the system will ignore the date_search variable.

Example: report_type=customer_vault&date_search=created,updated&start_date=20170101000000&end_date=20201231232359

Value	Description
created	Will return Customer Vault data created during a specified date range.
updated	Will return Customer Vault data updated during a specified date range.

Allowed:

result_limit

integer

Determines the maximum number of results that may return for the current query.

page_number

integer

Determines which "page" of results are returned. For example, result_limit=100&page_number=0 will return the first 100 results. Using page_number=1 will return the next 100 results. Default - 0.

result_order

string

enum

Determines order of in which results are returned. Default - standard.

Result Orders

Result Order	Description
standard	Returns the results from oldest to newest.
reverse	Returns the results from newest to oldest.

Allowed:

invoice_status

string

enum

Specify a comma separated list of what invoice statuses will return when using an "invoicing" report type.

Example: invoice_status=open,closed,paid

Allowed:

processor_details

string

Can be use with "report_type"="profile", this will include merchant "card_schemes" in the response

additionalProperties

string

Up to 20 merchant_defined_field_# are allowed.

Response

200ok