Jump to Content
Home
Guides
Recipes
API Reference
Explore Sandbox
Partner Portal
Merchant Portal
API Reference
Explore Sandbox
Partner Portal
Merchant Portal
Home
Guides
Recipes
API Reference
Customer Token Vault
All
Pages
Start typing to search…
JUMP TO
Overview
Getting Started with NMI's APIs
Authentication
Testing Methods
Rate Limiting
Pagination
Response Codes
Merchant Sign-Up
Overview
Authentication
Request an Access Token
post
Packages
List all Packages
get
Get Package
get
Applications
List all Applications
get
Create a new application
post
Get Application Information
get
Update an Application
patch
Get Legal Consent
get
Download Signed Agreement
get
Upload Document
post
Submit Application
post
Update Application Information
post
Webhook Subscriptions
List all Subscriptions
get
Create a Subscription
post
Get Subscription Information
get
Update a Subscription
patch
Delete a Subscription
del
Webhook Events
Underwriter Requested Information
post
Application is approved
post
Application is declined
post
Application is cancelled
post
Merchant is ready to process
post
Merchant account is closed
post
Merchant: New Chargeback
post
Merchant: New Deposit
post
Merchant: First Batch
post
Merchant: Started Processing
post
Merchant: Stopped Processing
post
Merchant: Residual Report Published
post
Merchant: New Retrieval
post
Merchant: New Statement
post
Legal Consent Helper
Online Payments
Transactions
Transaction Processing
post
Invoices
Invoice Management
post
Subscriptions
Subscription Management
post
Plans
Plan Management
post
Customers
Customer Management
post
Billing Information Management
post
Products
Product Management
post
TXT2PAY (Powered by Authvia)
Create a new conversation
post
List and filter conversations
get
Get a conversation
get
Close a conversation
del
IN-PERSON PAYMENTS
In-Person Payments Overview
Customer Present Cloud API
Download SDK for iOS/Android
Download SDK for Windows/Linux
ACCOUNT MANAGEMENT
Overview
Affiliates
Get Sub-Affiliate List
post
Merchants
Create Merchant
post
Assign Fee Schedule to Merchant / Complete and Send Welcome Email / Agree to TOS and Fees for a Merchant
patch
Get a Specific Merchant's Information
get
Get Merchant List
post
Settlement Time
Get Settlement Time
get
Updating Settlement Time
patch
Fee Schedule
Pull All Fee Schedules
post
Get Fees Inside a Fee Schedule
get
Processors and Services
Add Processor / Value-Added Service
post
Get Merchant Processors and Value Added Services Details
post
Card Type Lookup
post
Get Processor Config
get
Apple Pay
Adding Apple Pay to a Merchant
post
Querying A Merchant's Apple Pay Status
get
Get Available Services
post
Customer Token Vault
Add Token Vault to a Gateway Account
post
REPORTING
General
Query API
post
Transactions
Get Transaction Data
post
Billing & Commission
See Merchants' Billing
post
See Your Commission
post
ADMINISTRATION
Users
Get Merchant or Partner User Info
post
Username Availability
post
API Keys
Create Merchant API Keys
post
Webhooks
Overview
Retry Logic
Transaction Events
Check Status
Recurring Events
Settlement Events
Chargeback Events
Automatic Card Updater Events
Other Resources
Postman Collection
Gateway Emulator
MCP Server
MCP
Classic APIs
Payment API
post
Customer Token Vault
Ask AI
Onboard a merchant to Customer Token Vault
