Adyen · JSON Structure

Pos Terminal Find Terminal Response Structure

FindTerminalResponse schema from Adyen API

Type: object Properties: 5 Required: 2
PaymentsFinancial ServicesFintech

FindTerminalResponse is a JSON Structure definition published by Adyen, describing 5 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

companyAccount merchantAccount merchantInventory store terminal

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/pos-terminal-find-terminal-response-structure.json",
  "description": "FindTerminalResponse schema from Adyen API",
  "type": "object",
  "properties": {
    "companyAccount": {
      "description": "The company account that the terminal is associated with. If this is the only account level shown in the response, the terminal is assigned to the inventory of the company account.",
      "type": "string"
    },
    "merchantAccount": {
      "description": "The merchant account that the terminal is associated with. If the response doesn't contain a `store` the terminal is assigned to this merchant account.",
      "type": "string"
    },
    "merchantInventory": {
      "description": "Boolean that indicates if the terminal is assigned to the merchant inventory. This is returned when the terminal is assigned to a merchant account.\n\n- If **true**, this indicates that the terminal is in the merchant inventory. This also means that the terminal cannot be boarded.\n\n- If **false**, this indicates that the terminal is assigned to the merchant account as an in-store terminal. This means that the terminal is ready to be boarded, or is already boarded.",
      "type": "boolean"
    },
    "store": {
      "description": "The store code of the store that the terminal is assigned to.",
      "type": "string"
    },
    "terminal": {
      "description": "The unique terminal ID.",
      "type": "string"
    }
  },
  "required": [
    "companyAccount",
    "terminal"
  ],
  "name": "FindTerminalResponse"
}