NMI · Schema
Response
PaymentsPayment GatewayPayment ProcessingTokenizationRecurring BillingCustomer VaultFintechEmbedded PaymentsPayment Facilitation
Properties
| Name | Type | Description |
|---|---|---|
| nm_response | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/nmi/json-schema/nmi-query-response-schema.json",
"title": "Response",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/nmi-data-and-transaction-reporting-api-openapi.yml#/components/schemas/QueryResponse",
"type": "object",
"properties": {
"nm_response": {
"type": "object",
"properties": {
"transaction": {
"type": "array",
"items": {
"type": "object",
"properties": {
"transaction_id": {
"type": "string",
"description": "Transaction id"
},
"partial_payment_id": {
"type": "string",
"description": "Partial payment id"
},
"partial_payment_balance": {
"type": "string",
"description": "Partial payment balance"
},
"platform_id": {
"type": "string",
"description": "Platform id"
},
"transaction_type": {
"type": "string",
"description": "Transaction type"
},
"condition": {
"type": "string",
"description": "Condition"
},
"order_id": {
"type": "string",
"description": "Order id"
},
"authorization_code": {
"type": "string",
"description": "Authorization code"
},
"ponumber": {
"type": "string",
"description": "PO Number"
},
"order_description": {
"type": "string",
"description": "Order description"
},
"first_name": {
"type": "string",
"description": "First name"
},
"last_name": {
"type": "string",
"description": "Last name"
},
"address_1": {
"type": "string",
"description": "Address 1"
},
"address_2": {
"type": "string",
"description": "Address 2"
},
"company": {
"type": "string",
"description": "Company"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"postal_code": {
"type": "string",
"description": "Postal code"
},
"country": {
"type": "string",
"description": "Country"
},
"email": {
"type": "string",
"description": "Email"
},
"phone": {
"type": "string",
"description": "Phone"
},
"fax": {
"type": "string",
"description": "Fax"
},
"cell_phone": {
"type": "string",
"description": "Cell phone"
},
"customertaxid": {
"type": "string",
"description": "Customer tax id"
},
"customerid": {
"type": "string",
"description": "Customer id"
},
"website": {
"type": "string",
"description": "Website"
},
"shipping_first_name": {
"type": "string",
"description": "Shipping first name"
},
"shipping_last_name": {
"type": "string",
"description": "Shipping last name"
},
"shipping_address_1": {
"type": "string",
"description": "Shipping address 1"
},
"shipping_address_2": {
"type": "string",
"description": "Shipping address 2"
},
"shipping_company": {
"type": "string",
"description": "Shipping company"
},
"shipping_city": {
"type": "string",
"description": "Shipping city"
},
"shipping_state": {
"type": "string",
"description": "Shipping state"
},
"shipping_postal_code": {
"type": "string",
"description": "Shipping postal code"
},
"shipping_country": {
"type": "string",
"description": "Shipping country"
},
"shipping_email": {
"type": "string",
"description": "Shipping email"
},
"shipping_carrier": {
"type": "string",
"description": "Shipping carrier"
},
"tracking_number": {
"type": "string",
"description": "Tracking number"
},
"shipping_date": {
"type": "string",
"description": "Shipping date"
},
"shipping": {
"type": "string",
"description": "Shipping"
},
"shipping_phone": {
"type": "string",
"description": "Shipping phone"
},
"cc_number": {
"type": "string",
"description": "Credit card number"
},
"cc_hash": {
"type": "string",
"description": "Credit card hash"
},
"cc_exp": {
"type": "string",
"description": "Credit card expiration"
},
"cavv": {
"type": "string",
"description": "Cavv"
},
"cavv_result": {
"type": "string",
"description": "Cavv result"
},
"xid": {
"type": "string",
"description": "Xid"
},
"eci": {
"type": "string",
"description": "Eci"
},
"directory_server_id": {
"type": "string",
"description": "Directory server id"
},
"three_ds_version": {
"type": "string",
"description": "3DS version"
},
"avs_response": {
"type": "string",
"description": "AVS response"
},
"csc_response": {
"type": "string",
"description": "CSC response"
},
"cardholder_auth": {
"type": "string",
"description": "Cardholder auth"
},
"cc_start_date": {
"type": "string",
"description": "Credit card start date"
},
"cc_issue_number": {
"type": "string",
"description": "Credit card issue number"
},
"check_account": {
"type": "string",
"description": "Check account"
},
"check_hash": {
"type": "string",
"description": "Check hash"
},
"check_aba": {
"type": "string",
"description": "Check ABA"
},
"check_name": {
"type": "string",
"description": "Check name"
},
"account_holder_type": {
"type": "string",
"description": "Account holder type"
},
"account_type": {
"type": "string",
"description": "Account type"
},
"sec_code": {
"type": "string",
"description": "Sec code"
},
"drivers_license_number": {
"type": "string",
"description": "Drivers license number"
},
"drivers_license_state": {
"type": "string",
"description": "Drivers license state"
},
"drivers_license_dob": {
"type": "string",
"description": "Drivers license dob"
},
"social_security_number": {
"type": "string",
"description": "Social security number"
},
"processor_id": {
"type": "string",
"description": "Processor id"
},
"tax": {
"type": "string",
"description": "Tax"
},
"currency": {
"type": "string",
"description": "Currency"
},
"surcharge": {
"type": "string",
"description": "Surcharge"
},
"convenience_fee": {
"type": "string",
"description": "Convenience Fee"
},
"misc_fee": {
"type": "string",
"description": "Miscelaneous Fee"
},
"misc_fee_name": {
"type": "string",
"description": "Miscelaneous Fee Name"
},
"cash_discount": {
"type": "string",
"description": "Cash discount"
},
"tip": {
"type": "string",
"description": "Tip"
},
"card_balance": {
"type": "string",
"description": "Card balance"
},
"card_available_balance": {
"type": "string",
"description": "Card available balance"
},
"entry_mode": {
"type": "string",
"description": "Entry mode"
},
"cc_bin": {
"type": "string",
"description": "Credit card bin"
},
"cc_type": {
"type": "string",
"description": "Credit card type"
},
"signature_image": {
"type": "string",
"description": "Signature image"
},
"product": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "SKU"
},
"quantity": {
"type": "string",
"description": "Quantity"
},
"description": {
"type": "string",
"description": "Description"
},
"amount": {
"type": "string",
"description": "Amount"
}
}
},
"duty_amount": {
"type": "string",
"description": "Duty amount"
},
"discount_amount": {
"type": "string",
"description": "Discount amount"
},
"national_tax_amount": {
"type": "string",
"description": "National tax amount"
},
"summary_commodity_code": {
"type": "string",
"description": "Summary commodity code"
},
"vat_tax_amount": {
"type": "string",
"description": "Vat tax amount"
},
"vat_tax_rate": {
"type": "string",
"description": "Vat tax rate"
},
"alternate_tax_amount": {
"type": "string",
"description": "Alternate tax amount"
},
"action": {
"type": "array",
"items": {
"type": "object",
"properties": {
"amount": {
"type": "string",
"description": "Amount"
},
"action_type": {
"type": "string",
"description": "Action type"
},
"date": {
"type": "string",
"description": "Date"
},
"success": {
"type": "string",
"description": "Success"
},
"ip_address": {
"type": "string",
"description": "IP address"
},
"source": {
"type": "string",
"description": "Source"
},
"api_method": {
"type": "string",
"description": "API method"
},
"tap_to_mobile": {
"type": "string",
"description": "Tap to mobile"
},
"username": {
"type": "string",
"description": "Username"
},
"response_text": {
"type": "string",
"description": "Response text"
},
"batch_id": {
"type": "string",
"description": "Batch id"
},
"processor_batch_id": {
"type": "string",
"description": "Processor batch id"
},
"response_code": {
"type": "string",
"description": "Response code"
},
"processor_response_text": {
"type": "string",
"description": "Processor response text"
},
"processor_response_code": {
"type": "string",
"description": "Processor response code"
},
"requested_amount": {
"type": "string",
"description": "Requested amount"
},
"device_license_number": {
"type": "string",
"description": "Device license number"
},
"device_nickname": {
"type": "string",
"description": "Device nickname"
}
}
}
}
}
}
}
}
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/nmi-query-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.