Get Transaction Data

post

https://sandbox.nmi.com/api/v4/transactions/reports

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.

Usage

This is a query to find live transactions by merchants under your partner account. The query will respond in Universal Time Coordinated (UTC).

If you provide a specific transaction id, then it will return that transaction.

If you provide a sub-affiliates' merchant id in the merchant id list, it will return that merchant's transactions.

Body Params

merchantId

string

The merchant gateway ID to which the transactions belong.

merchantIds

array of strings

The merchants gateway IDs to which the transactions belong.

merchantIds

maxResults

string

required

Maximum number of results per page.

offset

string

Offset value for pagination, or null if not used.

orderId

string

The order ID of the transaction.

par

string

The Payment Account Reference ID to search for.

hmac

string

The Hash-based Message Authentication Code ID to search for.

serviceId

string

The ID of the processor platform you want to search for.

platformId

string

The ID of the platform.

firstName

string

The first name of the merchant's company contact.

lastName

string

The last name of the merchant's company contact.

string

The email of the merchant's company contact.

accountNumber

string

Account Number.

transactionType

string

Transaction type.

customerId

string

Customer ID.

phone

string

The phone number of the merchant's company contact.

transactionIds

array of strings

Transactions IDs to search.

transactionIds

statuses

array of strings

The list of statuses to query.

statuses

actionTypes

array of strings

The type of transaction to query.

actionTypes

amount

object

Min and max amount for transactions to search.

date

object

Start and End date for query transactions.

Headers

Content-Type

string

required

The Content-Type representation header is used to indicate the original media type of the resource (prior to any content encoding applied for sending).

Authorization

string

required

Your v4 API key that was generated in the Partner portal.

Response

200Success