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

All

Pages

Start typing to search…

Overview

Getting Started with NMI's APIs
Authentication
Testing Methods
Rate Limiting
Pagination
Response Codes

Merchant Sign-Up

Overview
Authentication
- Request an Access Tokenpost
Packages
- List all Packagesget
- Get Packageget
Applications
Webhook Subscriptions
Webhook Events
Legal Consent Helper

Online Payments

Transactions
- Transaction Processingpost
Invoices
- Invoice Managementpost
Subscriptions
- Subscription Managementpost
Plans
- Plan Managementpost
Customers
- Customer Managementpost
- Billing Information Managementpost
Products
- Product Managementpost
TXT2PAY (Powered by Authvia)

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 Listpost
Merchants
Settlement Time
- Get Settlement Timeget
- Updating Settlement Timepatch
Fee Schedule
- Pull All Fee Schedulespost
- Get Fees Inside a Fee Scheduleget
Processors and Services
Customer Token Vault
- Add Token Vault to a Gateway Accountpost

REPORTING

General
- Query APIpost
Transactions
- Get Transaction Datapost
Billing & Commission
- See Merchants' Billingpost
- See Your Commissionpost

ADMINISTRATION

Users
- Get Merchant or Partner User Infopost
- Username Availabilitypost
API Keys
- Create Merchant API Keyspost
Webhooks

Other Resources

Postman Collection

MCP Server

MCP

Classic APIs

Payment APIpost

Merchant: New Retrieval

wbhk

merchant.retrieval.added

This event is triggered when a retrieval is added for a merchant.

Privacy Policy Terms and Conditions