NMI

https://docs.nmi.com/
Admin
NMI is a payment processing platform that provides APIs, SDKs, and developer tools to build, test,...
Tokens:800,270
Snippets:3,502
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### List Applications Request Example

Source: https://docs.nmi.com/reference/getapplications

Example of a GET request to the applications endpoint with multiple query filters applied.

```http
GET /applications?status=submitted&updated_from=2025-01-01&updated_to=2025-03-01&sort_dir=asc
```

--------------------------------

### AsyncStatus Request Examples

Source: https://docs.nmi.com/docs/asyncstatus-polling

Examples of GET requests using cURL, demonstrating both default and explicit response method parameters.

```bash
curl --request GET --header "Authorization: Bearer {MERCHANT_API_KEY}"
            "https://secure.networkmerchants.com/api/asyncstatus/70a6272c-4949-4515-956a-6e5ae4d5a10c"
```

```bash
curl --request GET --header "Authorization: Bearer {MERCHANT_API_KEY}"
            "https://secure.networkmerchants.com/api/asyncstatus/70a6272c-4949-4515-956a-6e5ae4d5a10c?responseMethod=asynchronous"
```

```bash
curl --request GET --header "Authorization: Bearer {MERCHANT_API_KEY}"
            "https://secure.networkmerchants.com/api/asyncstatus/70a6272c-4949-4515-956a-6e5ae4d5a10c?responseMethod=synchronous"
```

--------------------------------

### Product Description Examples

Source: https://docs.nmi.com/reference/products-management

Examples of valid product description strings for the product_description field.

```text
1 Gallon Milk
```

```text
Phone Case
```

--------------------------------

### Get Sub-Affiliate List Request Example

Source: https://docs.nmi.com/reference/get-sub-affiliate-list

Example JSON payload for querying sub-affiliate accounts under a partner account.

```json
{
  "maxResults": 100,
  "ids": [
    "10490"
  ],
  "parentAffiliateId": "10123",
  "search": "",
  "offset": 0
}
```

--------------------------------

### Get Sub-Affiliate List Response Example

Source: https://docs.nmi.com/reference/get-sub-affiliate-list

Example JSON response containing a list of sub-affiliate objects and pagination links.

```json
{
  "objectType": "report",
  "reportId": 34567345,
  "offset": null,
  "maxResults": 100,
  "totalResults": 43,
  "hasMore": false,
  "links": {
    "first": "https://sandbox.nmi.com/api/v4/merchants/reports/34567345?maxResults=100",
    "last": "https://sandbox.nmi.com/api/v4/merchants/reports/34567345?offset=0&maxResults=100",
    "next": "https://sandbox.nmi.com/api/v4/merchants/reports/34567345?offset=100&maxResults=100",
    "previous": "https://sandbox.nmi.com/api/v4/merchants/reports/34567345?offset=0&maxResults=100"
  },
  "results": [
    {
      "objectType": "affiliate",
      "id": "10",
      "firstName": "Jane",
      "lastName": "Doe",
      "company": "ACME, Merchants Inc.",
      "email": "someone@example.com",
      "replyToEmail": "",
      "phone": "555-555-5555",
      "fax": "",
      "url": "",
      "address1": "123 Main St",
      "address2": "",
      "city": "Chicago",
      "state": "IL",
      "zip": "60601",
      "country": "US"
```

--------------------------------

### Get Processor Config Example Response

Source: https://docs.nmi.com/reference/get-processor-config

Represents the structure of a service configuration response, detailing the fields required for boarding.

```json
{
  "objectType": "serviceConfig",
  "processorFields": [
    {
      "id": "1",
      "name": "Rapid Connect Merchant Number",
      "optional": false,
      "validationRegex": "/^.{0,256}$/",
      "helpText": "",
      "type": "text",
      "disabled": false,
      "readonly": false,
      "highlight": false,
      "defaultValue": "",
      "selectOptions": null
    },
    {
      "id": "2",
      "name": "Rapid Connect Terminal ID",
      "optional": false,
      "validationRegex": "/^[0-9A-Za-z]{3,18}$/",
      "helpText": "",
      "type": "text",
      "disabled": false,
      "readonly": false,
      "highlight": false,
      "defaultValue": "",
      "selectOptions": null
    },
    {
      "id": "5",
      "name": "Amex Charge Description",
      "optional": true,
      "validationRegex": "/^[0-9a-zA-Z_]{1,23}$/",
      "helpText": "Note:  Only applicable to eCommerce American Express transactions.",
      "type": "text",
      "disabled": false,
      "readonly": false,
      "highlight": false,
      "defaultValue": "",
      "selectOptions": null
    },
    {
      "id": "6",
```

--------------------------------

### Subscription Response Examples

Source: https://docs.nmi.com/reference/sendapplicationcancelledevent

Examples of successful subscription creation and common validation error responses.

```json
{
  "id": "sub_a32ab32dc3209320",
  "callback_url": "https://your_callback_url.com",
  "events": [
    "application.updated.data.requested",
    "application.approved",
    "application.declined",
    "application.cancelled",
    "application.merchant.boarded"
  ],
  "status": "active",
  "created_at": "2025-01-01T00:00:00Z",
  "updated_at": "2025-01-01T00:00:00Z"
}
```

```json
{
  "code": "VALIDATION_ERROR",
  "message": "The current URL does not respond to our request. Please ensure that it's available to receive requests.",
  "errors": [
    "The current URL does not respond to our request. Please ensure that it's available to receive requests."
  ]
}
```

```json
{
  "code": "VALIDATION_ERROR",
  "message": "The selected events is invalid.",
  "errors": [
    "The selected events is invalid."
  ]
}
```

--------------------------------

### Content-Type Header Example

Source: https://docs.nmi.com/reference/check-username-availability

Example value for the Content-Type header.

```json
application/json
```

--------------------------------

### Event Data Examples

Source: https://docs.nmi.com/reference/get-sub-affiliate-list

Examples of event payloads for account updates and chargeback batches.

```json
"recurring_count_updated_closed_account": 1,
            "recurring_updates": [
              {
                "subscription_id": "281474976710727",
                "cc_number": "601101******0002",
                "cc_exp": "11/32",
                "first_name": "Bob",
                "last_name": "Smith",
                "email": "bsmith@example.co.uk",
                "phone": "+440111122222"
              }
            ]
          }
        }
      },
      "acu.summary.contactcustomer": {
        "summary": "Contact Support",
        "description": "Contact Support",
        "value": {
          "event_id": "7bbd4af6-4075-4902-af56-9fc59ab71362",
          "event_type": "acu.summary.contactcustomer",
          "event_body": {
            "updated_date": "2022-08-23",
            "merchant": {
              "id": 123456,
              "name": "Test Account"
            },
            "cards_checked": {
              "customer_vault": {
                "checked": 123,
                "updated": 2
              },
              "subscriptions": {
                "checked": 232,
                "updated": 1
              }
            },
            "vault_count_updated_contact_customer": 2,
            "vault_updates": [
              {
                "customer_vault_id": "40403043545",
                "billing_id": "34544356",
                "cc_number": "445343******7432",
                "cc_exp": "06/29",
                "first_name": "Happy",
                "last_name": "Customer",
                "email": "frequent@shopper.com",
                "phone": "5555559999"
              },
              {
                "customer_vault_id": "281474976710722",
                "billing_id": "230304034",
                "cc_number": "434343******0123",
                "cc_exp": "11/25",
                "first_name": "Bill",
                "last_name": "Thompson",
                "email": "bill@anothercustomer.com",
                "phone": "6025551213"
              }
            ],
            "recurring_count_updated_contact_customer": 1,
            "recurring_updates": [
              {
                "subscription_id": "323232232445",
                "cc_number": "465333******4232",
                "cc_exp": "04/30",
                "first_name": "Recurring",
                "last_name": "Customer",
                "email": "buy@repeatedly.com",
                "phone": "8185552323"
              }
            ]
          }
        }
      },
      "chargeback.batch.complete": {
        "summary": "Chargeback Batch Completed",
        "description": "Chargeback Batch Completed",
        "value": {
          "event_id": "7bbd4af6-4075-4902-af56-9fc59ab71362",
          "event_type": "chargeback.batch.complete",
          "event_body": {
            "merchant": {
              "id": "123456",
              "name": "Test Account"
            },
            "processor": {
              "id": "ccprocessor",
              "name": "CC Processor",
              "type": "cc"
            },
            "count": 1,
            "chargeback_amount": "12.34",
            "chargebacks": [
              {
                "id": "12345678",
                "date": "2023-08-11",
                "customer_name": "John Doe",
                "cc_number": "411111******1111",
                "amount": "12.34",
                "reason": "Cardholder Does Not Recognize"
              }
            ]
          }
        }
      }
```

--------------------------------

### Yes/No Prompt Example

Source: https://docs.nmi.com/docs/standalone-device-inputs

Example cURL request and JSON response for a yes/no prompt.

```bash
curl --request GET \
--header "Authorization: Bearer {MERCHANT_API_KEY}" \
"https://secure.networkmerchants.com/api/v2/devices/yesno/d352da6e-8772-4433-92f6-a77c4926fd80"
```

```json
{
    "async_status_guid": "118d6276-dfd4-4613-acfc-75d22bcdd189",
    "status": "in_progress"
}
```

--------------------------------

### OpenAPI Application Response Example

Source: https://docs.nmi.com/reference/sendapplicationupdateddatarequestedevent

Example JSON structure for a successful application list response.

```json
{
  "applications": [
    {
      "id": "app_d4b24397ac2e7e6d",
      "package_id": "pkg_merrick_tsys",
      "status": "draft",
      "created_at": "2025-03-03T18:42:42+00:00",
      "updated_at": "2025-03-03T18:43:01+00:00"
    },
    {
      "id": "app_4ce586f17e2e82bc",
      "package_id": "pkg_merrick_tsys",
      "status": "submitted"
```

--------------------------------

### Signature Capture Example

Source: https://docs.nmi.com/docs/standalone-device-inputs

Example cURL request and JSON response for signature capture.

```bash
curl --request GET \
--header "Authorization: Bearer {MERCHANT_API_KEY}" \
"https://secure.networkmerchants.com/api/v2/devices/sign/d352da6e-8772-4433-92f6-a77c4926fd80"
```

```json
{
    "async_status_guid": "118d6276-dfd4-4613-acfc-75d22bcdd189",
    "status": "in_progress"
}
```

--------------------------------

### Get Settlement Time Example Response

Source: https://docs.nmi.com/reference/get-settlement-time

Example JSON response returned by the Get Settlement Time endpoint.

```json
[
  {
    "objectType": "processor",
    "id": "304",
    "processorType": "feature",
    "processorId": "",
    "processorName": "",
    "serviceId": "mobile",
    "merchantId": "15",
    "mcc": "0000",
    "accountClassification": "ecommerce",
    "maxTicketAmount": "",
    "maxMonthlyVolume": "0.00",
    "applyToAllCardType": false,
    "enableDuplicateChecking": true,
    "allowMerchantOverride": false,
    "duplicateTime": "1200",
    "status": "closed",
    "condition": "offered",
    "extraDetails": {},
    "freeTrialEndDate": null,
    "freeTrialDaysLeft": "",
    "hasBeenActive": false,
    "created": "2012-04-26T14:34:50+00:00",
    "updated": "2012-04-26T15:36:55+00:00",
    "supportsReroutedRefunds": false,
    "shouldDisableFields": false,
    "disabled": null,
    "refundProcessor": null,
    "avsCvvPreCheck": null,
    "skipAvsCvv": false,
    "processorFields": {},
    "paymentTypes": [],
    "descriptor": {
      "descriptor": null,
      "phone": null,
      "city": null,
      "state": null,
      "url": null
    },
    "currencies": [
      ""
    ],
    "requiredFields": {
      "name": false,
      "company": false,
      "address": false,
      "city": false,
      "state": false,
      "zip": false
    }
  }
]
```

--------------------------------

### Device and Update Examples

Source: https://docs.nmi.com/reference/update-device-v5

Examples for retrieving registered cloud device details and updating device settings.

```json
{
  "object": "device",
  "id": "DEV123456789",
  "device_nickname": "Store Front Counter",
  "make": "Ingenico",
  "model": "Telium 2",
  "serial_number": "SN123456789",
  "registration_status": "registered",
  "last_transaction_date": "2025-01-15T10:30:00+00:00",
  "date_registered": "2025-01-01T08:00:00+00:00",
  "date_deregistered": null,
  "connection_status": true,
  "last_connected_date": "2025-01-15T10:25:00+00:00",
  "last_disconnected_date": null,
  "battery_info": null,
  "wifi_info": null
}
```

```json
{
  "nickname": "Updated Store Counter",
  "default": false
}
```

--------------------------------

### Perform Authenticated GET Request

Source: https://docs.nmi.com/reference/nmi-gateway-features

Example of a paginated GET request including the required Authorization header.

```JavaScript
GET: https://secure.nmi.com/api/v4/merchants/reports/123?offset=50&maxResults=50
Headers:
  Authorization: `{{your v4 api key}}`
```

--------------------------------

### Standard Package Configuration Example

Source: https://docs.nmi.com/reference/getpackagebyid

Example of a successful package configuration response, including package rules and field definitions.

```json
{
  "id": "pkg_merrick_tsys",
  "name": "Merrick TSYS Application Package",
  "description": "Merrick TSYS Application Package",
  "package_rules": [
    "Field 'fld_qual_rate' is required when 'Flat Rate' pricing type is selected",
    "Field 'fld_qual_rate_per_auth' is required when 'Flat Rate' pricing type is selected",
    "Field 'fld_cost_plus' is required when 'Cost Plus' pricing type is selected",
    "Field 'fld_cost_plus_per_auth' is required when 'Cost Plus' pricing type is selected",
    "Field 'fld_business_website' is required when 'fld_percent_of_ecommerce' > 0",
    "The total percentage of the 'fld_percent_of_retail', 'fld_percent_key_entered', 'fld_percent_of_ecommerce' and 'fld_percent_of_moto' fields must be 100%",
    "B2C Sales is required when 'fld_percent_of_moto' > 25 %",
    "B2B Sales is required when 'fld_percent_of_moto' > 25 %",
    "Bank or Processing Statements are required when 'fld_average_ticket' ≥ 1000 or 'fld_high_ticket' ≥ 2500"
  ],
  "fields": [
    {
      "id": "fld_amex_annual_volume",
      "name": "Amex Annual Volume",
      "type": "integer",
      "required": false,
      "default": null,
      "min": 0,
      "max": 999999999
    },
    {
      "id": "fld_average_ticket",
      "name": "Average Ticket",
      "type": "integer",
      "required": true,
      "default": null,
      "min": 1,
      "max": 9999999999
    },
    {
      "id": "fld_individual_with_control_address",
      "name": "Address",
      "type": "string",
      "required": true,
      "default": null,
      "min": 3,
      "max": 32,
      "regex": null
    },
    {
      "id": "fld_individual_with_control_city",
      "name": "City",
      "type": "string",
      "required": true,
      "default": null,
      "min": 3,
      "max": 13,
      "regex": null
    },
    {
      "id": "fld_individual_with_control_country",
      "name": "Country",
      "type": "choice",
      "required": false,
      "default": "US",
      "choices": [
        "US"
      ]
    },
    {
      "id": "fld_individual_with_control_dob",
      "name": "Date of Birth",
      "type": "date",
      "required": true,
      "default": null,
      "min": null,
      "max": null
    },
    {
      "id": "fld_individual_with_control_first_name",
      "name": "First Name",
      "type": "string",
      "required": true,
      "default": null,
      "min": 2,
      "max": 25,
      "regex": null
    },
    {
      "id": "fld_individual_with_control_last_name",
      "name": "Last Name",
      "type": "string",
      "required": true,
      "default": null,
      "min": 2,
      "max": 25,
      "regex": null
    },
    {
      "id": "fld_individual_with_control_ownership_percentage",
      "name": "Percent of Ownership",
      "type": "integer",
      "required": false,
      "default": null,
      "min": 0,
      "max": 100
    },
    {
      "id": "fld_individual_with_control_postal_code",
      "name": "Zip Code",
      "type": "postal_code",
      "required": true,
      "default": null
    },
    {
      "id": "fld_individual_with_control_ssn",
      "name": "SSN",
      "type": "ssn",
      "required": true,
      "default": null
    },
    {
      "id": "fld_individual_with_control_state",
      "name": "State",
      "type": "string",
      "required": true,
      "default": null,
      "min": 2,
      "max": 2,
      "regex": null
    }
  ]
}
```

--------------------------------

### Manual Device Data Collection with Gateway.js

Source: https://docs.nmi.com/docs/payer-authentication-3ds

This example demonstrates how to manually capture browser device data and initialize the 3DS interface using Gateway.js.

```html
        <html>
    <body>
    <script src="https://secure.networkmerchants.com/js/v1/Gateway.js"></script>
    <script>
        // Initialize Gateway.js
        const gateway = Gateway.create('YOUR_PUBLIC_KEY_HERE');

        // Initialize the ThreeDSService
        const threeDS = gateway.get3DSecure();

        // Create a 3DS Frame
        // This will start out 0px x 0px during fingerprinting.
        // If the customer is prompted to complete a challenge, it will resize automatically.

        // window.navigator.javaEnabled() is deprecated in modern browsers, use a try/catch to future-proof your code
        try {
            const userBrowserJavaEnabled = String(window.navigator.javaEnabled());
        } catch(e) {
            const userBrowserJavaEnabled = String(false);
        }

        const options = {
            cardNumber: "4111111111111111",
            cardExpMonth: "01",
            cardExpYear: "2024",
            currency: 'USD',
            amount: '10.00',
            email: 'none@example.com',
            phone: '8008675309',
            city: 'New York',
            state: 'NY',
            address1: '123 First St.',
            country: 'US',
            firstName: 'Jane',
            lastName: 'Doe',
            postalCode: '60001',
            browserJavaEnabled: userBrowserJavaEnabled,
            browserJavascriptEnabled: String(true),
            browserLanguage: window.navigator.language || window.navigator.userLanguage,
            browserColorDepth: String(window.screen.colorDepth),
            browserScreenHeight: String(window.screen.height),
            browserScreenWidth: String(window.screen.width),
            browserTimeZone: String(new Date().getTimezoneOffset()),
            deviceChannel: 'Browser'
        };

        const threeDSecureInterface  = threeDS.createUI(options);

        // Mount the threeDSecureInterface to the DOM
        // This begins the collection of 3DS data.
        threeDSecureInterface.start('body');

        // Listen for the threeDSecureInterface to ask the user for a password
        threeDSecureInterface.on('challenge', function(e) {
            console.log('Challenged');
        });

        // Listen for the threeDSecureInterface to provide all the needed 3DS data
        threeDSecureInterface.on('complete', function(e) {
            fetch('direct-post-back-end.php', {
                method: 'POST',
                body: JSON.stringify({
                    ...options,
                    cavv: e.cavv,
                    xid: e.xid,
                    eci: e.eci,
                    cardHolderAuth: e.cardHolderAuth,
                    threeDsVersion: e.threeDsVersion,
                    directoryServerId: e.directoryServerId,
                    cardHolderInfo: e.cardHolderInfo,
                })
            })
        });

        // Listen for the threeDSecureInterface to indicate that the customer
        // has failed to authenticate
        threeDSecureInterface.on('failure', function(e) {
            console.log('failure');
            console.log(e);
        });

        // Listen for any errors that might occur.
        gateway.on('error', function (e) {
            console.error(e);
        })
    </script>
    </body>
</html>
```

--------------------------------

### Get Merchant List Response Example

Source: https://docs.nmi.com/reference/get-merchant-list

Example JSON response containing merchant details, pagination links, and metadata.

```json
{
  "objectType": "report",
  "reportId": 34567345,
  "offset": null,
  "maxResults": 100,
  "totalResults": 43,
  "hasMore": false,
  "links": {
    "first": "https://sandbox.nmi.com/api/v4/merchants/reports/34567345?maxResults=100",
    "last": "https://sandbox.nmi.com/api/v4/merchants/reports/34567345?offset=0&maxResults=100",
    "next": "https://sandbox.nmi.com/api/v4/merchants/reports/34567345?offset=100&maxResults=100",
    "previous": "https://sandbox.nmi.com/api/v4/merchants/reports/34567345?offset=0&maxResults=100"
  },
  "results": [
    {
      "objectType": "merchant",
      "id": "3465345",
      "type": "gateway",
      "created": "2011-02-04T12:17:17+00:00",
      "updated": "2012-04-23T15:36:59+00:00",
      "firstName": "John",
      "lastName": "Doe",
      "company": "ACME, Inc.",
      "email": "someone@example.com",
      "phone": "555-555-5555",
      "fax": "",
      "url": "https://acme.com",
      "address1": "123 Main St",
      "address2": "",
      "city": "Chicago",
      "state": "IL",
      "zip": "60601",
      "country": "US",
      "timezone": "America/Chicago",
      "costPlan": "4",
      "status": "active"
```

--------------------------------

### Example Multiple Choice Request

Source: https://docs.nmi.com/docs/standalone-device-inputs

A cURL example demonstrating how to send the header and options payload to the device endpoint.

```bash
curl --request GET \
--header "Authorization: Bearer {MERCHANT_API_KEY}" \
--header "Content-Type: application/json" \
-d '{"header": "Question", "options": ["opt1", "opt2", "opt3"]}' \
"https://secure.networkmerchants.com/api/v2/devices/menuselection/d352da6e-8772-4433-92f6-a77c4926fd80"
```

--------------------------------

### Success Example for Package List

Source: https://docs.nmi.com/reference/sendapplicationcancelledevent

Example JSON response structure for a successful package list retrieval.

```json
{
  "packages": [
    {
      "id": "pkg_merrick_tsys",
      "name": "Merrick TSYS Application Package",
      "description": "Merrick TSYS Application Package"
    }
  ],
  "current_page": 1,
  "per_page": 10,
  "last_page": 1,
  "total": 1
}
```

--------------------------------

### Get Merchant List Request Example

Source: https://docs.nmi.com/reference/get-merchant-list

Example JSON payload for requesting a list of merchants with a specified maximum result count.

```json
{
  "maxResults": 1000
}
```

--------------------------------

### Merchant Processing Start Webhook Payload

Source: https://docs.nmi.com/reference/createsubscription

Example payload for the merchant.processing.start event.

```json
{
  "event_id": "38cf9efa-8aec-4a4e-98e2-6bb2411fdc60",
  "event_type": "merchant.processing.start",
  "event_body": {
    "mid": "1234000000000011",
    "dba": "Network Merchant Inc"
  }
}
```

--------------------------------

### GET https://secure.networkmerchants.com/api/asyncstatus/{asyncStatusGuid}

Source: https://docs.nmi.com/docs/countertop-point-of-sale-lane3600

Polls the status of an asynchronous transaction using the provided GUID.

```APIDOC
## GET https://secure.networkmerchants.com/api/asyncstatus/{asyncStatusGuid}

### Description
Retrieves the status of an asynchronous transaction.

### Method
GET

### Endpoint
https://secure.networkmerchants.com/api/asyncstatus/{asyncStatusGuid}

### Parameters
#### Path Parameters
- **asyncStatusGuid** (string) - Required - The unique identifier for the asynchronous transaction status.
```

--------------------------------

### Initialize Gateway.js Library

Source: https://docs.nmi.com/docs/gatewayjs

Initialize the library using a public API key with Checkout permissions.

```javascript
const gateway = Gateway.create('YOUR_PUBLIC_KEY_HERE');
```

--------------------------------

### Poll Asynchronous Transaction

Source: https://docs.nmi.com/docs/asyncstatus-polling

The GET request structure for querying the status of a transaction using its GUID.

```text
GET /api/asyncstatus/:asyncStatusGuid
```

--------------------------------

### Application Update Request and Response Examples

Source: https://docs.nmi.com/reference/sendmerchantfirstbatchevent

Examples for updating application notes and handling success or validation error responses.

```json
{
  "note": "Additional documentation has been uploaded to support the application review process."
}
```

```json
{
  "code": "SUCCESS",
  "message": "Application information updated successfully"
}
```

```json
{
  "code": "VALIDATION_ERROR",
  "message": "The application information can only be updated when in the 'underwriter_requested_information' status. Current status: draft",
  "errors": [
    "The application information can only be updated when in the 'underwriter_requested_information' status. Current status: draft"
  ]
}
```

```json
{
  "code": "VALIDATION_ERROR",
  "message": "The note field is required.",
  "errors": [
    "The note field is required."
  ]
}
```

--------------------------------

### Get Fees Inside a Fee Schedule Example Response

Source: https://docs.nmi.com/reference/get-fees-in-schedule

Example JSON response showing a list of fees associated with a schedule, including fee types, billing amounts, and processor details.

```json
[
  {
    "objectType": "fee",
    "feeType": "13",
    "name": "Set Up Fee",
    "sort": "1",
    "description": "Billed once the service is boarded.",
    "processor": {
      "objectType": "service",
      "id": "acu",
      "name": "Automatic Card Updater",
      "type": "feature",
      "source": "internal"
    },
    "billMe": false,
    "value": {
      "objectType": "amount",
      "amount": "0.00",
      "currency": "USD"
    },
    "applyTo": [
      "gateway"
    ]
  },
  {
    "objectType": "fee",
    "feeType": "14",
    "name": "Monthly Fee",
    "sort": "2",
    "description": "Billed monthly for each gateway account.",
    "processor": {
      "objectType": "service",
      "id": "acu",
      "name": "Automatic Card Updater",
      "type": "feature",
      "source": "internal"
    },
    "billMe": false,
    "value": {
      "objectType": "amount",
      "amount": "5.00",
      "currency": "USD"
    },
    "applyTo": [
      "gateway"
    ]
  },
  {
    "objectType": "fee",
    "feeType": "15",
    "name": "Per Transaction Fee",
    "sort": "4",
    "description": "Billed per updated record.",
    "processor": {
      "objectType": "service",
      "id": "acu",
      "name": "Automatic Card Updater",
      "type": "feature",
      "source": "internal"
    },
    "billMe": false,
    "value": {
      "objectType": "amount",
      "amount": "5.00",
      "currency": "USD"
    },
    "applyTo": [
      "gateway"
    ]
  }
]
```

--------------------------------

### Define Subscription Webhook Examples

Source: https://docs.nmi.com/reference/add-processor-service

References for subscription-related webhook event examples within an OpenAPI component definition.

```json
"PlanDeleted": {
                  "$ref": "#/components/examples/plan-deleted"
                },
                "SubscriptionAdded": {
                  "$ref": "#/components/examples/subscription-added"
                },
                "SubscriptionUpdated": {
                  "$ref": "#/components/examples/subscription-updated"
                },
                "SubscriptionDeleted": {
                  "$ref": "#/components/examples/subscription-deleted"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Return a 200 status to indicate that the data was received successfully"
          }
        }
      }
    },
```

--------------------------------

### Configure Collect.js for Initial Transaction

Source: https://docs.nmi.com/docs/credential-on-file

Use this configuration to set up the initial payment tokenization. Set challengeIndicator to 04 for PSD2/3DS compliance.

```javascript
CollectJS.configure({
    callback: (e) => {
        const options = {
            paymentToken: e.token,
            currency: 'USD',
            amount: '1000',
            email: 'customer@example.com',
            phone: '8008675309',
            city: 'New York',
            state: 'NY',
            address1: '123 First St.',
            country: 'US',
            firstName: 'John',
            lastName: 'Doe',
            postalCode: '60001',
            challengeIndicator: '04' // Mandatory for 3DS transactions
        }
    }
});
```

--------------------------------

### GET /api/asyncstatus/:asyncStatusGuid

Source: https://docs.nmi.com/docs/asyncstatus-polling

Polls the status of an asynchronous transaction using the GUID provided in the initial transaction response.

```APIDOC
## GET /api/asyncstatus/:asyncStatusGuid

### Description
Polls the current status of an asynchronous transaction. This is used to determine if the consumer's interaction with the POI device is complete and if the transaction was successful.

### Method
GET

### Endpoint
https://secure.networkmerchants.com/api/asyncstatus/:asyncStatusGuid

### Parameters
#### Path Parameters
- **asyncStatusGuid** (string) - Required - The async_status_guid returned from the transaction response.

#### Query Parameters
- **responseMethod** (string) - Optional - The type of response desired. Set to 'synchronous' to wait for a final transaction ID, or 'asynchronous' to receive in-flight status. Default: 'asynchronous'.

### Request Example
curl --request GET --header "Authorization: Bearer {MERCHANT_API_KEY}" "https://secure.networkmerchants.com/api/asyncstatus/70a6272c-4949-4515-956a-6e5ae4d5a10c"

### Response
#### Success Response (200)
- **transaction** (object) - Contains transaction details including id, success, condition, and authCode.
- **platformId** (string) - The platform identifier.
- **asyncStatusGuid** (string) - The GUID of the status request.
- **asyncStatus** (string) - The current status of the transaction (e.g., 'inFlight', 'interactionComplete').

#### Response Example
{
   "transaction": {
       "id": 4869813602,
       "type": "sale",
       "success": true,
       "condition": "pendingsettlement",
       "authCode": "A99BUO"
   },
   "platformId": "70a6272c-4949-4515-956a-6e5ae4d5a10c",
   "asyncStatusGuid": "70a6272c-4949-4515-956a-6e5ae4d5a10c",
   "asyncStatus": "interactionComplete"
}
```

--------------------------------

### connectAndConfigure

Source: https://docs.nmi.com/docs/configuration-and-utility-methods-1

Connects to the PIN pad, downloads configuration data from TMS, and prepares the device for transactions.

```APIDOC
## Parameters connectAndConfigure(Parameters)

### Description
Connects to the PIN pad and configures the device. Can also be used to perform TMS or Firmware updates.

### Parameters
- **Parameters** (Object) - Required - Configuration parameters. Includes optional fields like 'ForceTmsUpdate' and 'ApplyFirmwareUpdate'.

### Response
- **Parameters** (Object) - Returns a Parameters object with the result of the connection attempt. Asynchronous updates are provided via 'configurationUpdate' and 'configureAndConnectFinished' callbacks.
```

--------------------------------

### Request Access Token Examples

Source: https://docs.nmi.com/reference/sendapplicationcancelledevent

Examples for the OAuth token request endpoint, demonstrating both successful authentication and failure scenarios.

```json
{
  "grant_type": "client_credentials",
  "client_id": "**********",
  "client_secret": "**********",
  "scope": "*"
}
```

```json
{
  "grant_type": "client_credentials",
  "client_id": "invalid_data",
  "client_secret": "invalid_data",
  "scope": "*"
}
```

--------------------------------

### Example Multiple Choice Response

Source: https://docs.nmi.com/docs/standalone-device-inputs

The response body returned after successfully initiating the prompt, containing the async status GUID.

```json
{
    "async_status_guid": "118d6276-dfd4-4613-acfc-75d22bcdd189",
    "status": "in_progress"
}
```

--------------------------------

### Get Merchant or Partner User Info Request

Source: https://docs.nmi.com/reference/get-merchant-partner-user-info

Example request payload for retrieving user information for a specific merchant ID.

```json
{
  "maxResults": 100,
  "merchantId": "1099191"
}
```

--------------------------------

### Subscription Response Example

Source: https://docs.nmi.com/reference/sendapplicationdeclinedevent

Example JSON response containing a list of active subscriptions with event hooks.

```json
"subscriptions": [
                        {
                          "id": "sub_d83116a5970d8700",
                          "callback_url": "https://your_registered_callback.com",
                          "events": [
                            "application.updated.data.requested",
                            "application.approved",
                            "application.cancelled",
                            "application.declined",
                            "application.merchant.boarded"
                          ],
                          "status": "active",
                          "created_at": "2025-02-25T18:07:23+00:00",
                          "updated_at": "2025-02-25T18:08:00+00:00"
                        },
                        {
                          "id": "sub_482385311458f55e",
                          "callback_url": "https://your_callback_url.com",
                          "events": [
                            "application.updated.data.requested",
                            "application.approved",
                            "application.cancelled",
                            "application.declined",
                            "application.merchant.boarded"
                          ],
                          "status": "active",
                          "created_at": "2025-02-21T19:40:51+00:00",
                          "updated_at": "2025-02-24T20:20:33+00:00"
                        }
                      ],
                      "current_page": 1,
                      "per_page": 10,
                      "last_page": 1,
                      "total": 2
```

--------------------------------

### Get Specific Merchant Information Response

Source: https://docs.nmi.com/reference/get-specific-merchant-information

Example JSON response body returned when successfully retrieving a specific merchant's details.

```json
{
  "objectType": "merchant",
  "id": "3465345",
  "type": "gateway",
  "created": "2011-02-04T12:17:17+00:00",
  "updated": "2012-04-23T15:36:59+00:00",
  "firstName": "John",
  "lastName": "Doe",
  "company": "ACME, Inc.",
  "email": "someone@example.com",
  "phone": "555-555-5555",
  "fax": "",
  "url": "https://acme.com",
  "address1": "123 Main St",
  "address2": "",
  "city": "Chicago",
  "state": "IL",
  "zip": "60601",
  "country": "US",
  "timezone": "America/Chicago",
  "costPlan": "4",
  "status": "active",
  "externalIdentifier": "",
  "lastTransactionDate": null,
  "parentAffiliateId": "2",
  "accountInfo": {
    "checkAba": "490000018",
    "checkAccount": "*****6789",
    "accountType": "checking",
    "accountHolderType": "personal"
  },
  "features": {
    "forceTos": false,
    "forceBillingAuth": false,
    "allowBlindCredits": false,
    "allowBlindCheckCredits": false,
    "advancedTransactionRouting": false,
    "sendBillingEmail": true,
    "braspag": {
      "advancedTransactionRouting": false
    },
    "verifi": {
      "enabled": false
    },
    "viewBillingStatement": true,
    "litle": {
      "reportGroup": false,
      "prePaidIndicator": false
```

--------------------------------

### threeDSecureInterface.start(selector)

Source: https://docs.nmi.com/docs/payer-authentication-3ds

Mounts the 3DS UI to the DOM and begins data collection.

```APIDOC
## threeDSecureInterface.start(selector)

### Description
Mounts the 3DS UI to the specified DOM element and initiates the 3DS data collection process.

### Parameters
- **selector** (String) - Required. The CSS selector for the DOM element where the UI should be mounted.
```

--------------------------------

### OpenAPI Definition for Get Yes/No Prompt Status

Source: https://docs.nmi.com/reference/get-device-prompt-yes-no-status-v5

The OpenAPI specification defining the endpoint, parameters, and response examples for checking prompt status.

```json
{
  "openapi": "3.1.0",
  "info": {
    "version": "1.0.0",
    "title": "NMI Payments",
    "x-logo": {
      "url": "https://www.nmi.com/app/themes/nmi/images/NMI_Logo_Primary.webp"
    }
  },
  "servers": [
    {
      "url": "https://sandbox.nmi.com/api"
    }
  ],
  "security": [],
  "tags": [
    {
      "name": "Webhook Events",
      "description": "Here you can find information about webhook events"
    },
    {
      "name": "Devices",
      "description": "Cloud device management and payment request endpoints"
    }
  ],
  "externalDocs": {
    "url": "https://www.postman.com/nmi-integration-support/workspace/nmi-public-documentation/request/5480015-f4b0ec7b-bd84-4094-98c2-67c0b6508a7f",
    "description": "NMI Public Documentation (Postman)"
  },
  "paths": {
    "/v5/devices/{device_id}/prompt/yes-no/{reference}": {
      "get": {
        "tags": [
          "Devices"
        ],
        "operationId": "get-device-prompt-yes-no-status-v5",
        "summary": "Get Yes/No Prompt Status",
        "description": "Retrieve the status of a yes/no prompt request initiated on a cloud device. The reference is obtained from the initial prompt request response (e.g., from POST /api/v5/devices/{deviceId}/prompt/yes-no).",
        "security": [
          {
            "merchantApiKey": []
          }
        ],
        "parameters": [
          {
            "name": "device_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "The unique identifier of the cloud device"
          },
          {
            "name": "reference",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "The unique identifier of the prompt request, obtained from the initial prompt request response"
          }
        ],
        "responses": {
          "200": {
            "description": "Prompt request status retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PromptRequestStatusResponse"
                },
                "examples": {
                  "in_progress": {
                    "summary": "Prompt request is in progress",
                    "value": {
                      "object": "request",
                      "id": "9519a52b-07e7-49e7-8e40-76ef69c053cc",
                      "status": "in_progress"
                    }
                  },
                  "completed": {
                    "summary": "Prompt request completed",
                    "value": {
                      "object": "request",
                      "id": "9519a52b-07e7-49e7-8e40-76ef69c053cc",
                      "status": "completed",
                      "result": "yes"
                    }
                  },
                  "cancelled": {
                    "summary": "Prompt request was cancelled",
                    "value": {
                      "object": "request",
                      "id": "9519a52b-07e7-49e7-8e40-76ef69c053cc",
                      "status": "cancelled"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          }
        }
      }
    }
  },
  "webhooks": {
    "transaction": {
      "post": {
        "tags": [
          "Webhook Events"
        ],
        "security": [],
        "summary": "Transaction Event",
        "description": "Sales, auths, captures, voids, refunds, and credits. Each transaction type can be filtered by successful, failed, and unknown transactions.",
        "operationId": "transactionEvent",
        "parameters": [
          {
            "$ref": "#/components/parameters/WebhookSignature"
          }
        ],
        "requestBody": {
          "description": "Event about a transaction",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "event_id",
                  "event_type",
                  "event_body"
                ],
                "properties": {
                  "event_id": {
                    "type": "string",
                    "description": "Event ID"
                  },

```

--------------------------------

### Application Created At Timestamp

Source: https://docs.nmi.com/reference/sendapplicationcancelledevent

Example of the date-time format used for application creation timestamps.

```json
"example": "2025-01-01T00:00:00Z"
```
Tokens:
Raw