For AI agents: visit https://docs.nmi.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
NMI Developer Documentation
HomeGuidesRecipesAPI Reference
Explore SandboxPartner PortalMerchant PortalNMI Developer Documentation
Guides
Explore SandboxPartner PortalMerchant Portal
HomeGuidesRecipesAPI Reference

Get Started

  • Explore Payment Solutions
  • Get Your API Keys
  • Third Party Integrations
  • Classic API Migration Playbook
    • Code Examples

Design Toolkits for Developers

  • Online Checkout Flow
  • Customer-Friendly Surcharge
  • Merchant Sign-Up

Online Payments

  • Online Payments Overview
  • Hosted Checkout
    • Quick Start Guide
    • Advanced Integration
  • Payment Component
    • Integrating the Frontend Component
    • Implement Backend
    • Test and Deploy
    • Customize Styling
    • Surcharging with Card Type Detection
  • Custom Checkout
    • Adding Digital Wallet Data to the Customer Vault
      • Full Transaction Lifecycle Example
    • Preparing Subscriptions using Digital Wallet Data
      • Full Transaction Lifecycle Example
    • Account Funding Transactions
    • FSA/HSA
  • Customer Vault
    • Adding Customers to Vault
    • Managing Entries
    • Using for Transactions
    • Credential on File Best Practices
  • Recurring Transactions
  • Collect.js
    • Quick Start Guide
    • Advanced Integrations
    • Digital Wallet Setup
    • Surcharging with Card Type Detection (Collect.js)

In-Person Payments

  • In-Person Payments Overview
    • 🚀Android All in One SmartPOS: Ingenico Axium
  • Enabling Test Mode
    • EMV Sandbox Environment
      • Getting Started
      • Requests & Responses
      • Validation Errors
  • 🍎Tap to Pay on iPhone
    • Enable Tap to Pay
    • Downloading the SDK
    • Unboxing the iOS SDK
    • Creating and Managing Security Keys
    • Preparing for Development
    • Firewall Configuration
    • Transaction Flow
    • Sequence Diagrams
    • Modes of Operation
    • Configuration
    • Configuration and Utility Methods
    • Configuration and Utility Events
    • Start Transaction
    • Transaction Events
    • Receipts
    • Supported Features
    • User Experience Requirements
    • Regional Requirements
    • Preparing for Release
    • Entitlement Review
    • Frequently Asked Questions
  • 🤖Tap to Pay on Android
    • Enable Tap to Pay
    • Downloading the Android SDK
    • Unboxing the Android SDK
    • Creating and Managing Security Keys
    • Preparing for Development
    • App Onboarding
    • Firewall Configuration
    • Transaction Flow
    • Sequence Diagrams
    • Modes of Operation
    • Configuration
    • Configuration and Utility Methods
    • Configuration and Utility Events
    • Start Transaction
    • Transaction Events
    • Receipts
    • Supported Features
    • Contactless Symbol Reproduction Requirements
    • Frequently Asked Questions
  • 📱VP3350
    • Unboxing your VP3350 device
    • Enable Test Mode
    • Downloading the Android/iOS SDK
    • Unboxing the Android/iOS SDK
    • Creating and Managing Security Keys
    • Platform Specific Requirements
    • Firewall Configuration
    • Transaction Flow
    • Configuration
    • Configuration and Utility Methods
    • Configuration and Utility Events
    • Payment Methods
    • Payment Events
    • Deferred Authorizations
    • TMS Properties
    • Receipts
    • App Submission
    • Appendix: Quick Reference Tables
  • 🚀Axium SmartPOS
    • Unboxing your Axium device
    • Device setup
    • Platform-specific requirements
    • Configuration
    • Transaction flow
    • Configuration and utility events
    • Offline transactions
    • Device disconnection
    • OTA updates
    • Retrieving log files
    • All-in-One Development
      • Setup for development
      • Hosted Estate Manager (HEM)
      • Partner onboarding with a Partner Code
      • Managing devices & estates
      • Software library & campaigns
      • MDM profiles
      • User management & access
      • Application signing
    • Appendix 1 — Supported API methods
    • Appendix 2 — Unsupported features
  • 🖥️Lane/Series
    • Unboxing your Lane device
    • Enabling Encrypted Devices
    • Introduction to the Customer Present Cloud API
    • Registering Your Device
    • Device Estate Management
    • Standalone Device Inputs
    • Processing
    • AsyncStatus Polling
    • POI Device Prompts
    • FSA Support
    • Virtual PIN Pad
    • Error Recovery Tips
  • 📔Self/Series
    • Enable Encrypted Devices
    • Downloading the Windows & Linux SDK
    • Enable Allowlisting on Your Payment Device
  • 🧪Test Card Simulator
  • 🛠️Device SDKs & APIs
    • 📱SDKs for Android & iOS
    • 🪟SDKs for Windows & Linux
    • ☁️Customer Present Cloud API
  • 🪄Direct Connect
    • Direct Connect API & SDKs
    • Terminal Management

Reporting

  • Deposit Summary Component
    • Deposit History Component
  • Transaction History Component

Extensions

  • Gateway Components (Gateway.js)
    • Payer Authentication (3DS)
      • Testing
      • Testing - Sandbox
    • Kount Fraud Management
    • CardEase 3DS Server Integration

MCP Server

  • MCP

Embedded Components

  • The Appearance API

Sequence Diagrams

Running a Tap To Mobile Transaction

CONFIGURED WITH JUST TAP TO MOBILE

CONFIGURED WITH TTM & PAYMENT DEVICE

    • Running a Tap To Mobile Transaction
      • CONFIGURED WITH JUST TAP TO MOBILE
      • CONFIGURED WITH TTM & PAYMENT DEVICE
Privacy Policy Terms and Conditions