Adyen · JSON Structure

Management Terminal Settings Structure

TerminalSettings schema from Adyen API

Type: object Properties: 20
PaymentsFinancial ServicesFintech

TerminalSettings is a JSON Structure definition published by Adyen, describing 20 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

cardholderReceipt connectivity gratuities hardware localization nexo offlineProcessing opi passcodes payAtTable payment receiptOptions receiptPrinting refunds signature standalone surcharge tapToPay timeouts wifiProfiles

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/management-terminal-settings-structure.json",
  "description": "TerminalSettings schema from Adyen API",
  "type": "object",
  "properties": {
    "cardholderReceipt": {
      "description": "Settings to define the header of the shopper receipt.",
      "$ref": "#/components/schemas/CardholderReceipt"
    },
    "connectivity": {
      "description": "Settings for terminal connectivity features.",
      "$ref": "#/components/schemas/Connectivity"
    },
    "gratuities": {
      "description": "Settings for tipping with or without predefined options to choose from. The maximum number of predefined options is four, or three plus the option to enter a custom tip.",
      "items": {
        "$ref": "#/components/schemas/Gratuity"
      },
      "type": "array"
    },
    "hardware": {
      "description": "Settings for terminal hardware features.",
      "$ref": "#/components/schemas/Hardware"
    },
    "localization": {
      "description": "Settings for localization.",
      "$ref": "#/components/schemas/Localization"
    },
    "nexo": {
      "description": "Settings for a Terminal API integration.",
      "$ref": "#/components/schemas/Nexo"
    },
    "offlineProcessing": {
      "description": "Settings for [offline payment](https://docs.adyen.com/point-of-sale/offline-payments) features.",
      "$ref": "#/components/schemas/OfflineProcessing"
    },
    "opi": {
      "description": "Settings for an Oracle Payment Interface (OPI) integration.",
      "$ref": "#/components/schemas/Opi"
    },
    "passcodes": {
      "description": "Settings for [passcodes](https://docs.adyen.com/point-of-sale/managing-terminals/menu-access?tab=manage_passcodes_with_an_api_call_2#manage-passcodes) features.",
      "$ref": "#/components/schemas/Passcodes"
    },
    "payAtTable": {
      "description": "Settings for [Pay-at-table](https://docs.adyen.com/point-of-sale/pay-at-x) features.",
      "$ref": "#/components/schemas/PayAtTable"
    },
    "payment": {
      "description": "Settings for payment features.",
      "$ref": "#/components/schemas/Payment"
    },
    "receiptOptions": {
      "description": "Generic receipt settings.",
      "$ref": "#/components/schemas/ReceiptOptions"
    },
    "receiptPrinting": {
      "description": "Transaction outcomes that you want the terminal to print a merchant receipt or a shopper receipt for.",
      "$ref": "#/components/schemas/ReceiptPrinting"
    },
    "refunds": {
      "description": "Settings for refunds.",
      "$ref": "#/components/schemas/Refunds"
    },
    "signature": {
      "description": "Settings to skip signature, sign on display, or sign on receipt.",
      "$ref": "#/components/schemas/Signature"
    },
    "standalone": {
      "description": "Settings for [standalone](https://docs.adyen.com/point-of-sale/standalone/standalone-build/set-up-standalone#set-up-standalone-using-an-api-call) features.",
      "$ref": "#/components/schemas/Standalone"
    },
    "surcharge": {
      "description": "Settings for payment [surcharge](https://docs.adyen.com/point-of-sale/surcharge) features.",
      "$ref": "#/components/schemas/Surcharge"
    },
    "tapToPay": {
      "description": "Settings for Tap to Pay.",
      "$ref": "#/components/schemas/TapToPay"
    },
    "timeouts": {
      "description": "Settings for device [time-outs](https://docs.adyen.com/point-of-sale/pos-timeouts#device-time-out).",
      "$ref": "#/components/schemas/Timeouts"
    },
    "wifiProfiles": {
      "description": "Remote Wi-Fi profiles for WPA and WPA2 PSK and EAP Wi-Fi networks.",
      "$ref": "#/components/schemas/WifiProfiles"
    }
  },
  "name": "TerminalSettings"
}