top of page

Inspect account records with MCP

Use the authenticated account connector for bounded, read-only troubleshooting after connecting documentation.

Understand the account boundary

NMI’s local @nmipayments/nmi-mcp package requires Node.js 18+ and a merchant key. Its current tools only read records and check readiness; they cannot change transactions.

Sandbox configuration for VS Code

Use sandbox credentials and test data. Merge this example into local MCP configuration; never commit an actual private key. { "servers": { "NMI": { "type": "stdio", "command": "npx", "args": [ "-y", "@nmipayments/nmi-mcp" ], "env": { "NMI_MERCHANT_API_KEY": "<sandbox-merchant-api-key>", "NMI_API_BASE_URL": "https://sandbox.nmi.com", "NMI_ENVIRONMENT": "sandbox" } } } } NMI_API_BASE_URL selects the host and defaults to https://secure.nmi.com. NMI_ENVIRONMENT=sandbox disables masking; it does not select a sandbox host. Use only test credentials and data.

Select the appropriate tool

Verify the actual account context before requesting a record. Tool Documented purpose preflight Readiness for payments, Customer Vault, invoicing, recurring and mobile; not every product. fetch_by_type One customer, payment, subscription, plan, product, invoice or device. Products use SKU; devices use UUID.

Troubleshoot with a narrow question

Recommended workflow: give the assistant one relevant record identifier and a precise question, such as comparing a payment outcome with your own order state. Avoid supplying unrelated customer records. Review which machine and configuration will hold the credential. Confirm the host and merchant before allowing an account lookup. Inspect the tool result separately from the assistant’s explanation. Use your normal operational workflow for any corrective action.

Interpret access and masking

Listing tools does not verify credentials; lookup may fail authentication. Asterisks mean identifying values were withheld, not changed. Avoid sharing credential-error screenshots. Do not treat an assistant explanation or readiness check as merchant approval, reconciliation completion or permission to move money.

Join the community and get the latest biz news & tips

Thanks for submitting!

© 2025 Betterpay. All Rights Reserved.

bottom of page