National Australia Bank Device Search API

Search and Retrieve Devices.

Operations 1

POST /dms/v3/devices/search Retrieve List of Devices for a given search query #

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/national-australia-bank:national-australia-bank-device-search-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

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

OpenAPI Specification

national-australia-bank-device-search-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
  version: 0.0.1
  title: CyberSource Merged Spec Device Search API
servers:
- url: https://apitest.cybersource.com/
tags:
- name: Device Search
  description: Search and Retrieve Devices.
paths:
  /dms/v3/devices/search:
    post:
      summary: Retrieve List of Devices for a given search query
      description: 'Search for devices matching a given search query.


        The search query supports serialNumber, readerId, terminalId, status, statusChangeReason or organizationId


        Matching results are paginated.'
      tags:
      - Device Search
      operationId: postSearchQueryV3
      responses:
        '200':
          description: Retrieved all Devices matched by the search query
          content:
            application/json;charset=UTF-8:
              schema:
                type: object
                properties:
                  totalCount:
                    type: integer
                    description: Total number of results.
                  offset:
                    type: integer
                    description: 'Controls the starting point within the collection of results, which defaults to 0. The first item in the collection is retrieved by setting a zero offset.


                      For example, if you have a collection of 15 items to be retrieved from a resource and you specify limit=5, you can retrieve the entire set of results in 3 successive requests by varying the offset value like this:


                      `offset=0`

                      `offset=5`

                      `offset=10`


                      **Note:** If an offset larger than the number of results is provided, this will result in no embedded object being returned.

                      '
                  limit:
                    type: integer
                    description: 'Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2500.

                      '
                  sort:
                    type: string
                    description: 'A comma separated list of the following form:


                      `terminalCreationDate:desc or serialNumber or terminalUpdationDate`

                      '
                  count:
                    type: integer
                    description: Results for this page, this could be below the limit.
                  devices:
                    type: array
                    description: A collection of devices
                    items:
                      type: object
                      properties:
                        readerId:
                          type: string
                          maxLength: 36
                        serialNumber:
                          type: string
                          maxLength: 256
                          pattern: '[0-9a-zA-Z][0-9a-zA-Z-]*'
                        model:
                          type: string
                          maxLength: 256
                          pattern: ^[0-9a-zA-Z_ ]*$
                        make:
                          type: string
                          maxLength: 100
                          pattern: ^[0-9a-zA-Z_ ]*$
                        hardwareRevision:
                          type: string
                          maxLength: 256
                          pattern: ^[0-9a-zA-Z][0-9a-zA-Z-/_.]*$
                        status:
                          type: string
                          description: "Status of the device.\nPossible Values:\n  - 'ACTIVE'\n  - 'INACTIVE'\n"
                          enum:
                          - ACTIVE
                          - INACTIVE
                        statusChangeReason:
                          type: string
                          description: Reason for change in status.
                        merchantId:
                          type: string
                          description: ID of the merchant to whom this device is assigned.
                        accountId:
                          type: string
                          description: ID of the account to whom the device assigned.
                        terminalCreationDate:
                          type: string
                          format: date-time
                          description: Timestamp in which the device was created.
                        terminalUpdationDate:
                          type: string
                          format: date-time
                          description: Timestamp in which the device was updated/modified.
                        paymentProcessorToTerminalMap:
                          type: object
                          description: Mapping between processor and Terminal.
                          properties:
                            processor:
                              type: string
                            terminalId:
                              type: string
        '400':
          description: Bad Request
          content:
            application/json;charset=UTF-8:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: The status of the submitted request.
                    enum:
                    - BAD_REQUEST
                  message:
                    type: string
                    description: The detail message related to the status and reason listed above.
                  code:
                    type: string
                    description: An optional short string which identifies the exact error.
                  details:
                    type: array
                    description: An optional array which provides more details of the error.
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          description: This is the flattened JSON object field name/path that is either missing or invalid.
                        reason:
                          type: string
                          description: 'Possible reasons for the error.

                            '
                        code:
                          type: string
                          description: An optional short string which identifies the exact field error.
                  submitTimeUtc:
                    type: string
                    description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`


                      Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the

                      time. The Z indicates UTC.

                      '
        '401':
          description: Unauthorized
          content:
            application/json;charset=UTF-8:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: 'The status of the submitted request.

                      '
                    enum:
                    - UNAUTHORIZED
                  message:
                    type: string
                    description: The detail message related to the status and reason listed above.
                  code:
                    type: string
                    description: An optional short string which identifies the exact error.
                  submitTimeUtc:
                    type: string
                    description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`


                      Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the

                      time. The Z indicates UTC.

                      '
        '403':
          description: Forbidden
          content:
            application/json;charset=UTF-8:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: 'The status of the submitted request.

                      '
                    enum:
                    - FORBIDDEN
                  message:
                    type: string
                    description: The detail message related to the status and reason listed above.
                  code:
                    type: string
                    description: An optional short string which identifies the exact error.
                  submitTimeUtc:
                    type: string
                    description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`


                      Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the

                      time. The Z indicates UTC.

                      '
        '404':
          description: Not Found
          content:
            application/json;charset=UTF-8:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: 'The status of the submitted request.

                      '
                    enum:
                    - NOT_FOUND
                  message:
                    type: string
                    description: The detail message related to the status and reason listed above.
                  code:
                    type: string
                    description: An optional short string which identifies the exact error.
                  submitTimeUtc:
                    type: string
                    description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`


                      Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the

                      time. The Z indicates UTC.

                      '
        '500':
          description: Unexpected system error or system timeout.
          content:
            application/json;charset=UTF-8:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: 'The status of the submitted request.

                      '
                    enum:
                    - INTERNAL_SERVER_ERROR
                  message:
                    type: string
                    description: The detail message related to the status and reason listed above.
                  code:
                    type: string
                    description: An optional short string which identifies the exact error.
                  submitTimeUtc:
                    type: string
                    description: 'Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`


                      Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the

                      time. The Z indicates UTC.

                      '
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              type: object
              properties:
                query:
                  type: string
                  description: The Search Query to retrieve the Terminals.(Example :- serialNumber:456345234 AND readerId:509353f0-86ca-4af4-a1c9-c2702bfd7431  AND terminalId:7854922 AND status:Inactive AND statusChangeReason:Other AND organizationId:London Store)
                sort:
                  type: string
                  description: terminalCreationDate:desc (default) or serialNumber or terminalUpdationDate
                offset:
                  type: integer
                  format: int64
                  description: The offset or page number.
                limit:
                  type: integer
                  format: int64
                  description: Number of devices to retrieve in one request.
        required: true