NMI

NMI Devices API

Cloud device management and payment request endpoints

Documentation GitHub OpenAPI

Operations 19

GET /v5/devices List Cloud Devices #

POST /v5/devices Register Cloud Device #

GET /v5/devices/{device_id} Get Cloud Device #

PATCH /v5/devices/{device_id} Update Cloud Device #

DELETE /v5/devices/{device_id} Deregister Cloud Device #

DELETE /v5/devices/{device_id}/display Cancel Display on Device #

POST /v5/devices/{device_id}/display/qr-code Display QR Code on Device #

DELETE /v5/devices/{device_id}/payment-requests Cancel Payment Request on Device #

POST /v5/devices/{device_id}/payment-requests/auth Create Authorization Payment Request on Device #

POST /v5/devices/{device_id}/payment-requests/credit Create Credit Payment Request on Device #

POST /v5/devices/{device_id}/payment-requests/sale Create Sale Payment Request on Device #

POST /v5/devices/{device_id}/payment-requests/validate Create Validation Payment Request on Device #

GET /v5/devices/{device_id}/payment-requests/{request_id} Get Payment Request Status #

POST /v5/devices/{device_id}/prompt/sign Prompt Device for Signature #

GET /v5/devices/{device_id}/prompt/sign/{reference} Get Signature Prompt Status #

POST /v5/devices/{device_id}/prompt/yes-no Prompt Device for Yes/No Response #

GET /v5/devices/{device_id}/prompt/yes-no/{reference} Get Yes/No Prompt Status #

Documentation

https://docs.nmi.com/docs

Specifications

https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/openapi/nmi-devices-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-conversation-amount-input-schema.json

https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-conversation-expiration-date-input-schema.json

https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-conversation-instructions-schema.json

https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-nmi-record-id-schema.json

https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-conversation-id-schema.json

https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-conversation-customer-phone-with-dashes-schema.json

https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-response-schema.json

https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-credit-card-payment-in-full-partial-request-schema.json

https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-credit-card-sale-request-schema.json

https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-achcredit-request-schema.json

https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-achsale-request-schema.json

https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-credit-card-capture-request-schema.json

https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-package-fields-schema.json

https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-application-document-schema.json

https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-package-collection-schema.json

https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-full-application-schema.json

https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-subscription-schema.json

https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-pagination-schema.json

Other Resources

https://docs.nmi.com/docs/sandbox-testing

Work with this as data

Every API 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 apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
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 API

curl "https://apis.io/api/v1/apis/nmi:nmi-devices-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  version: 1.0.0
  title: Payments Devices API
  description: Our payments platform exposes two generations of API.
  x-logo:
    url: https://www.nmi.com/app/themes/nmi/images/NMI_Logo_Primary.webp
servers:
- url: https://sandbox.nmi.com/api
security: []
tags:


# --- truncated at 32 KB (95 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/openapi/nmi-devices-api-openapi.yml