NMI · Schema

Response - Customer Vault Report Type

PaymentsPayment GatewayPayment ProcessingTokenizationRecurring BillingCustomer VaultFintechEmbedded PaymentsPayment Facilitation

Properties

Name Type Description
nm_response object
View JSON Schema on GitHub

JSON Schema

nmi-query-customer-vault-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/nmi/json-schema/nmi-query-customer-vault-response-schema.json",
  "title": "Response - Customer Vault Report Type",
  "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/QueryCustomerVaultResponse",
  "type": "object",
  "properties": {
    "nm_response": {
      "type": "object",
      "properties": {
        "customer_vault": {
          "type": "object",
          "properties": {
            "customer": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Customer ID"
                  },
                  "first_name": {
                    "type": "string",
                    "description": "First name of the customer"
                  },
                  "last_name": {
                    "type": "string",
                    "description": "Last name of the customer"
                  },
                  "address_1": {
                    "type": "string",
                    "description": "Primary address line of the customer"
                  },
                  "address_2": {
                    "type": "string",
                    "description": "Secondary address line of the customer"
                  },
                  "company": {
                    "type": "string",
                    "description": "Company name associated with the customer"
                  },
                  "city": {
                    "type": "string",
                    "description": "City of the customer's address"
                  },
                  "state": {
                    "type": "string",
                    "description": "State of the customer's address"
                  },
                  "postal_code": {
                    "type": "string",
                    "description": "Postal code of the customer's address"
                  },
                  "country": {
                    "type": "string",
                    "description": "Country of the customer's address"
                  },
                  "email": {
                    "type": "string",
                    "description": "Email address of the customer"
                  },
                  "phone": {
                    "type": "string",
                    "description": "Phone number of the customer"
                  },
                  "fax": {
                    "type": "string",
                    "description": "Fax number of the customer"
                  },
                  "cell_phone": {
                    "type": "string",
                    "description": "Cell phone number of the customer"
                  },
                  "customertaxid": {
                    "type": "string",
                    "description": "Customer's tax identification number"
                  },
                  "website": {
                    "type": "string",
                    "description": "Website associated with the customer"
                  },
                  "shipping_first_name": {
                    "type": "string",
                    "description": "First name for shipping details"
                  },
                  "shipping_last_name": {
                    "type": "string",
                    "description": "Last name for shipping details"
                  },
                  "shipping_address_1": {
                    "type": "string",
                    "description": "Primary shipping address line"
                  },
                  "shipping_address_2": {
                    "type": "string",
                    "description": "Secondary shipping address line"
                  },
                  "shipping_company": {
                    "type": "string",
                    "description": "Shipping company name"
                  },
                  "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": "Email address for shipping"
                  },
                  "shipping_carrier": {
                    "type": "string",
                    "description": "Shipping carrier details"
                  },
                  "tracking_number": {
                    "type": "string",
                    "description": "Shipping tracking number"
                  },
                  "shipping_date": {
                    "type": "string",
                    "description": "Shipping date"
                  },
                  "shipping": {
                    "type": "string",
                    "description": "Shipping cost"
                  },
                  "cc_number": {
                    "type": "string",
                    "description": "Credit card number (masked)"
                  },
                  "cc_hash": {
                    "type": "string",
                    "description": "Credit card hash"
                  },
                  "cc_exp": {
                    "type": "string",
                    "description": "Credit card expiration date"
                  },
                  "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 details"
                  },
                  "check_hash": {
                    "type": "string",
                    "description": "Check hash value"
                  },
                  "check_aba": {
                    "type": "string",
                    "description": "Check ABA routing number"
                  },
                  "check_name": {
                    "type": "string",
                    "description": "Name on the check"
                  },
                  "account_holder_type": {
                    "type": "string",
                    "description": "Account holder type"
                  },
                  "account_type": {
                    "type": "string",
                    "description": "Type of bank account"
                  },
                  "sec_code": {
                    "type": "string",
                    "description": "SEC code for ACH transactions"
                  },
                  "processor_id": {
                    "type": "string",
                    "description": "Processor ID"
                  },
                  "cc_bin": {
                    "type": "string",
                    "description": "Credit card BIN number"
                  },
                  "cc_type": {
                    "type": "string",
                    "description": "Credit card type"
                  },
                  "created": {
                    "type": "string",
                    "description": "Creation date"
                  },
                  "updated": {
                    "type": "string",
                    "description": "Last update date"
                  },
                  "account_updated": {
                    "type": "string",
                    "description": "Last account update date"
                  },
                  "customer_vault_id": {
                    "type": "string",
                    "description": "Customer vault ID"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

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.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/nmi-query-customer-vault-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.