# NMI Devices API

**Canonical:** https://apis.io/apis/nmi/nmi-devices-api/  
**Provider:** NMI — https://apis.io/providers/nmi/  
**Base URL:** https://secure.networkmerchants.com  
**Documentation:** https://secure.networkmerchants.com/gw/merchants/resources/integration/integration_portal.php

NMI Devices API is one of 28 APIs that [NMI](https://apis.io/providers/nmi/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 18 JSON Schema definitions. Tagged areas include Devices. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 18 JSON Schemas.

Cloud device management and payment request endpoints

## Operations (19)

| Method | Path | Summary |
|---|---|---|
| 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/menu` | Prompt Device for Menu Selection |
| GET | `/v5/devices/{device_id}/prompt/menu/{reference}` | Get Menu Prompt 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 |

## Machine-readable artifacts (21)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/openapi/nmi-devices-api-openapi.yml
- **Documentation** — https://docs.nmi.com/docs
- **Sandbox** — https://docs.nmi.com/docs/sandbox-testing
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-conversation-amount-input-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-conversation-expiration-date-input-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-conversation-instructions-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-nmi-record-id-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-conversation-id-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-conversation-customer-phone-with-dashes-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-credit-card-payment-in-full-partial-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-credit-card-sale-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-achcredit-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-achsale-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-credit-card-capture-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-package-fields-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-application-document-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-package-collection-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-full-application-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-subscription-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/nmi/refs/heads/main/json-schema/nmi-pagination-schema.json

## Other NMI APIs (12)

- [NMI Three Step Redirect API](https://apis.io/apis/nmi/nmi-three-step-redirect-api/)
- [NMI Customer-Present Cloud API](https://apis.io/apis/nmi/nmi-customer-present-cloud-api/)
- [NMI Webhook Events API](https://apis.io/apis/nmi/nmi-payments-api/)
- [NMI Affiliates API](https://apis.io/apis/nmi/nmi-affiliates-api/)
- [NMI Apple Pay API](https://apis.io/apis/nmi/nmi-apple-pay-api/)
- [NMI Applications API](https://apis.io/apis/nmi/nmi-applications-api/)
- [NMI Authentication API](https://apis.io/apis/nmi/nmi-authentication-api/)
- [NMI Authvia TXT2PAY API](https://apis.io/apis/nmi/nmi-authvia-txt2pay-api/)
- [NMI Billing & Commission API](https://apis.io/apis/nmi/nmi-billing-commission-api/)
- [NMI Component Sessions API](https://apis.io/apis/nmi/nmi-component-sessions-api/)
- [NMI Customers API](https://apis.io/apis/nmi/nmi-customers-api/)
- [NMI Data and Transaction Reporting API](https://apis.io/apis/nmi/nmi-data-and-transaction-reporting-api/)

## Tags

Devices

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/nmi/nmi-devices-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/nmi/.