openapi: 3.1.0 info: version: '6' x-publicVersion: true title: Adyen Account acceptDispute Terminals API description: "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder\n```" x-timestamp: '2023-05-30T15:27:20Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi servers: - url: https://cal-test.adyen.com/cal/services/Account/v6 tags: - name: Terminals paths: /terminals: get: tags: - Terminals summary: Adyen Get a List of Terminals description: "Returns the payment terminals that the API credential has access to and that match the query parameters. \nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API — Terminal actions read" operationId: get-terminals x-sortIndex: 1 x-methodName: listTerminals security: - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: Returns terminals with an ID that contains the specified string. If present, other query parameters are ignored. name: searchQuery in: query required: false schema: type: string - description: Returns one or more terminals associated with the one-time passwords specified in the request. If this query parameter is used, other query parameters are ignored. name: otpQuery in: query required: false schema: type: string - description: Returns terminals located in the countries specified by their [two-letter country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). name: countries in: query required: false schema: type: string - description: Returns terminals that belong to the merchant accounts specified by their unique merchant account ID. name: merchantIds in: query required: false schema: type: string - description: Returns terminals that are assigned to the [stores](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores) specified by their unique store ID. name: storeIds in: query required: false schema: type: string - description: Returns terminals of the [models](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/companies/{companyId}/terminalModels) specified in the format *brand.model*. name: brandModels in: query required: false schema: type: string - description: The number of the page to fetch. name: pageNumber in: query required: false schema: format: int32 type: integer - description: The number of items to have on a page, maximum 100. The default is 20 items on a page. name: pageSize in: query required: false schema: format: int32 type: integer responses: '200': content: application/json: examples: success: $ref: '#/components/examples/get-terminals-success-200' schema: $ref: '#/components/schemas/ListTerminalsResponse' description: OK - the request has succeeded. '400': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: get-terminals400Example: summary: Default get-terminals 400 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: get-terminals401Example: summary: Default get-terminals 401 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Unauthorized - authentication required. '403': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: get-terminals403Example: summary: Default get-terminals 403 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: get-terminals422Example: summary: Default get-terminals 422 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: get-terminals500Example: summary: Default get-terminals 500 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /terminals/scheduleActions: post: tags: - Terminals summary: Adyen Create a Terminal Action description: "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. \n\nThe following restrictions apply:\n* You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. \n* The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. \n* If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. \n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal actions read and write" operationId: post-terminals-scheduleActions x-sortIndex: 1 x-methodName: createTerminalAction security: - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: application/json: examples: install-app: $ref: '#/components/examples/post-terminals-scheduleActions-install-app' uninstall-cert: $ref: '#/components/examples/post-terminals-scheduleActions-uninstall-cert' verification-error: $ref: '#/components/examples/post-terminals-scheduleActions-verification-error' schema: $ref: '#/components/schemas/ScheduleTerminalActionsRequest' responses: '200': content: application/json: examples: install-app: $ref: '#/components/examples/post-terminals-scheduleActions-install-app-200' uninstall-cert: $ref: '#/components/examples/post-terminals-scheduleActions-uninstall-cert-200' schema: $ref: '#/components/schemas/ScheduleTerminalActionsResponse' description: OK - the request has succeeded. '400': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: post-terminals-scheduleActions400Example: summary: Default post-terminals-scheduleActions 400 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: post-terminals-scheduleActions401Example: summary: Default post-terminals-scheduleActions 401 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Unauthorized - authentication required. '403': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: post-terminals-scheduleActions403Example: summary: Default post-terminals-scheduleActions 403 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Forbidden - insufficient permissions to process the request. '422': content: application/json: examples: verification-error: $ref: '#/components/examples/post-terminals-scheduleActions-verification-error-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: post-terminals-scheduleActions500Example: summary: Default post-terminals-scheduleActions 500 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /terminals/{terminalId}/reassign: post: tags: - Terminals summary: Adyen Reassign a Terminal description: 'Reassigns a payment terminal to a company account, merchant account, merchant account inventory, or a store. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Assign Terminal' x-addedInVersion: '3' operationId: post-terminals-terminalId-reassign x-sortIndex: 2 x-methodName: reassignTerminal security: - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/TerminalReassignmentRequest' parameters: - description: The unique identifier of the payment terminal. name: terminalId in: path required: true schema: type: string responses: '200': description: 'No Content - look at the actual response code for the status of the request. ' '400': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: post-terminals-terminalId-reassign400Example: summary: Default post-terminals-terminalId-reassign 400 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: post-terminals-terminalId-reassign401Example: summary: Default post-terminals-terminalId-reassign 401 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Unauthorized - authentication required. '403': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: post-terminals-terminalId-reassign403Example: summary: Default post-terminals-terminalId-reassign 403 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: post-terminals-terminalId-reassign422Example: summary: Default post-terminals-terminalId-reassign 422 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: post-terminals-terminalId-reassign500Example: summary: Default post-terminals-terminalId-reassign 500 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /terminals/{terminalId}/terminalLogos: get: tags: - Terminals summary: Adyen Get the Terminal Logo description: 'Returns the logo that is configured for the payment terminal identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write' operationId: get-terminals-terminalId-terminalLogos x-sortIndex: 4 x-methodName: getTerminalLogo security: - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: The unique identifier of the payment terminal. name: terminalId in: path required: true schema: type: string responses: '200': content: application/json: examples: success: $ref: '#/components/examples/get-terminals-terminalId-terminalLogos-success-200' schema: $ref: '#/components/schemas/Logo' description: OK - the request has succeeded. '400': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: get-terminals-terminalId-terminalLogos400Example: summary: Default get-terminals-terminalId-terminalLogos 400 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: get-terminals-terminalId-terminalLogos401Example: summary: Default get-terminals-terminalId-terminalLogos 401 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Unauthorized - authentication required. '403': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: get-terminals-terminalId-terminalLogos403Example: summary: Default get-terminals-terminalId-terminalLogos 403 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: get-terminals-terminalId-terminalLogos422Example: summary: Default get-terminals-terminalId-terminalLogos 422 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: get-terminals-terminalId-terminalLogos500Example: summary: Default get-terminals-terminalId-terminalLogos 500 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: tags: - Terminals summary: Adyen Update the Logo description: 'Updates the logo for the payment terminal identified in the path. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (store, merchant account, or company account), specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write' operationId: patch-terminals-terminalId-terminalLogos x-sortIndex: 6 x-methodName: updateLogo security: - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: application/json: examples: remove-logo: $ref: '#/components/examples/patch-terminals-terminalId-terminalLogos-remove-logo' upload-logo: $ref: '#/components/examples/patch-terminals-terminalId-terminalLogos-upload-logo' schema: $ref: '#/components/schemas/Logo' parameters: - description: The unique identifier of the payment terminal. name: terminalId in: path required: true schema: type: string responses: '200': content: application/json: examples: remove-logo: $ref: '#/components/examples/patch-terminals-terminalId-terminalLogos-remove-logo-200' upload-logo: $ref: '#/components/examples/patch-terminals-terminalId-terminalLogos-upload-logo-200' schema: $ref: '#/components/schemas/Logo' description: OK - the request has succeeded. '400': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: patch-terminals-terminalId-terminalLogos400Example: summary: Default patch-terminals-terminalId-terminalLogos 400 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: patch-terminals-terminalId-terminalLogos401Example: summary: Default patch-terminals-terminalId-terminalLogos 401 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Unauthorized - authentication required. '403': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: patch-terminals-terminalId-terminalLogos403Example: summary: Default patch-terminals-terminalId-terminalLogos 403 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: patch-terminals-terminalId-terminalLogos422Example: summary: Default patch-terminals-terminalId-terminalLogos 422 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: patch-terminals-terminalId-terminalLogos500Example: summary: Default patch-terminals-terminalId-terminalLogos 500 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /terminals/{terminalId}/terminalSettings: get: tags: - Terminals summary: Adyen Get Terminal Settings description: 'Returns the settings that are configured for the payment terminal identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write' operationId: get-terminals-terminalId-terminalSettings x-sortIndex: 3 x-methodName: getTerminalSettings security: - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: The unique identifier of the payment terminal. name: terminalId in: path required: true schema: type: string responses: '200': content: application/json: examples: success: $ref: '#/components/examples/get-terminals-terminalId-terminalSettings-success-200' schema: $ref: '#/components/schemas/TerminalSettings' description: OK - the request has succeeded. '400': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: get-terminals-terminalId-terminalSettings400Example: summary: Default get-terminals-terminalId-terminalSettings 400 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: get-terminals-terminalId-terminalSettings401Example: summary: Default get-terminals-terminalId-terminalSettings 401 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Unauthorized - authentication required. '403': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: get-terminals-terminalId-terminalSettings403Example: summary: Default get-terminals-terminalId-terminalSettings 403 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: get-terminals-terminalId-terminalSettings422Example: summary: Default get-terminals-terminalId-terminalSettings 422 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: get-terminals-terminalId-terminalSettings500Example: summary: Default get-terminals-terminalId-terminalSettings 500 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: tags: - Terminals summary: Adyen Update Terminal Settings description: 'Updates the settings that are configured for the payment terminal identified in the path. * To change a parameter value, include the full object that contains the parameter, even if you don''t want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write' operationId: patch-terminals-terminalId-terminalSettings x-sortIndex: 5 x-methodName: updateTerminalSettings security: - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: application/json: examples: add-eap-peap-and-psk-wifi-profiles: $ref: '#/components/examples/patch-terminals-terminalId-terminalSettings-add-eap-peap-and-psk-wifi-profiles' add-eap-tls-wifi-profile: $ref: '#/components/examples/patch-terminals-terminalId-terminalSettings-add-eap-tls-wifi-profile' schema: $ref: '#/components/schemas/TerminalSettings' parameters: - description: The unique identifier of the payment terminal. name: terminalId in: path required: true schema: type: string responses: '200': content: application/json: examples: add-eap-peap-and-psk-wifi-profiles: $ref: '#/components/examples/patch-terminals-terminalId-terminalSettings-add-eap-peap-and-psk-wifi-profiles-200' add-eap-tls-wifi-profile: $ref: '#/components/examples/patch-terminals-terminalId-terminalSettings-add-eap-tls-wifi-profile-200' schema: $ref: '#/components/schemas/TerminalSettings' description: OK - the request has succeeded. '400': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: patch-terminals-terminalId-terminalSettings400Example: summary: Default patch-terminals-terminalId-terminalSettings 400 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: patch-terminals-terminalId-terminalSettings401Example: summary: Default patch-terminals-terminalId-terminalSettings 401 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Unauthorized - authentication required. '403': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: patch-terminals-terminalId-terminalSettings403Example: summary: Default patch-terminals-terminalId-terminalSettings 403 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: patch-terminals-terminalId-terminalSettings422Example: summary: Default patch-terminals-terminalId-terminalSettings 422 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: patch-terminals-terminalId-terminalSettings500Example: summary: Default patch-terminals-terminalId-terminalSettings 500 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: TerminalConnectivityWifi: properties: ipAddress: description: The terminal's IP address in the Wi-Fi network. type: string macAddress: description: The terminal's MAC address in the Wi-Fi network. type: string ssid: description: The SSID of the Wi-Fi network that the terminal is connected to. type: string type: object Settings: properties: band: description: 'The preferred Wi-Fi band, for use if the terminals support multiple bands. Possible values: All, 2.4GHz, 5GHz.' type: string roaming: description: Indicates whether roaming is enabled on the terminals. type: boolean timeout: description: 'The connection time-out in seconds. Minimum value: 0.' format: int32 type: integer type: object LinksElement: properties: href: type: string type: object UninstallAndroidCertificateDetails: additionalProperties: false properties: certificateId: description: The unique identifier of the certificate to be uninstalled. type: string type: default: UninstallAndroidCertificate description: 'Type of terminal action: Uninstall an Android certificate.' enum: - UninstallAndroidCertificate type: string type: object JSONObject: type: object ReceiptPrinting: properties: merchantApproved: description: Print a merchant receipt when the payment is approved. type: boolean merchantCancelled: description: Print a merchant receipt when the transaction is cancelled. type: boolean merchantCaptureApproved: description: Print a merchant receipt when capturing the payment is approved. type: boolean merchantCaptureRefused: description: Print a merchant receipt when capturing the payment is refused. type: boolean merchantRefundApproved: description: Print a merchant receipt when the refund is approved. type: boolean merchantRefundRefused: description: Print a merchant receipt when the refund is refused. type: boolean merchantRefused: description: Print a merchant receipt when the payment is refused. type: boolean merchantVoid: description: Print a merchant receipt when a previous transaction is voided. type: boolean shopperApproved: description: Print a shopper receipt when the payment is approved. type: boolean shopperCancelled: description: Print a shopper receipt when the transaction is cancelled. type: boolean shopperCaptureApproved: description: Print a shopper receipt when capturing the payment is approved. type: boolean shopperCaptureRefused: description: Print a shopper receipt when capturing the payment is refused. type: boolean shopperRefundApproved: description: Print a shopper receipt when the refund is approved. type: boolean shopperRefundRefused: description: Print a shopper receipt when the refund is refused. type: boolean shopperRefused: description: Print a shopper receipt when the payment is refused. type: boolean shopperVoid: description: Print a shopper receipt when a previous transaction is voided. type: boolean type: object Passcodes: properties: adminMenuPin: description: The passcode for the Admin menu and the Settings menu. maxLength: 6 type: string refundPin: description: The passcode for referenced and unreferenced refunds on standalone terminals. maxLength: 6 type: string screenLockPin: description: The passcode to unlock the terminal screen after a timeout. maxLength: 6 minLength: 4 type: string txMenuPin: description: The passcode for the Transactions menu. maxLength: 6 type: string type: object Notification: properties: category: description: The type of event notification sent when you select the notification button. enum: - SaleWakeUp - KeyPressed type: string details: description: The text shown in the prompt which opens when you select the notification button. For example, the description of the input box for pay-at-table. type: string enabled: description: Enables sending event notifications either by pressing the Confirm key on terminals with a keypad or by tapping the event notification button on the terminal screen. type: boolean showButton: description: Shows or hides the event notification button on the screen of terminal models that have a keypad. type: boolean title: description: The name of the notification button on the terminal screen. type: string type: object Standalone: properties: currencyCode: description: The default currency of the standalone payment terminal as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. maxLength: 3 minLength: 3 type: string enableStandalone: description: Enable standalone mode. type: boolean type: object TerminalConnectivity: properties: bluetooth: $ref: '#/components/schemas/TerminalConnectivityBluetooth' cellular: $ref: '#/components/schemas/TerminalConnectivityCellular' ethernet: $ref: '#/components/schemas/TerminalConnectivityEthernet' wifi: $ref: '#/components/schemas/TerminalConnectivityWifi' type: object Logo: properties: data: description: The image file, converted to a Base64-encoded string, of the logo to be shown on the terminal. maxLength: 350000 type: string type: object ListTerminalsResponse: properties: _links: description: Pagination references. $ref: '#/components/schemas/PaginationLinks' data: description: The list of terminals and their details. items: $ref: '#/components/schemas/Terminal' type: array itemsTotal: description: Total number of items. format: int32 type: integer pagesTotal: description: Total number of pages. format: int32 type: integer required: - itemsTotal - pagesTotal type: object RestServiceError: properties: detail: description: A human-readable explanation specific to this occurrence of the problem. type: string errorCode: description: A code that identifies the problem type. type: string instance: description: A unique URI that identifies the specific occurrence of the problem. type: string invalidFields: description: Detailed explanation of each validation error, when applicable. items: $ref: '#/components/schemas/InvalidField' type: array requestId: description: A unique reference for the request, essentially the same as `pspReference`. type: string response: description: JSON response payload. $ref: '#/components/schemas/JSONObject' status: description: The HTTP status code. format: int32 type: integer title: description: A short, human-readable summary of the problem type. type: string type: description: A URI that identifies the problem type, pointing to human-readable documentation on this problem type. type: string required: - type - errorCode - title - detail - status type: object TerminalReassignmentRequest: properties: companyId: description: The unique identifier of the company account to which the terminal is reassigned. type: string inventory: description: 'Must be specified when reassigning terminals to a merchant account: - If set to **true**, reassigns terminals to the inventory of the merchant account and the terminals cannot process transactions. - If set to **false**, reassigns terminals directly to the merchant account and the terminals can process transactions.' type: boolean merchantId: description: The unique identifier of the merchant account to which the terminal is reassigned. When reassigning terminals to a merchant account, you must specify the `inventory` field. type: string storeId: description: The unique identifier of the store to which the terminal is reassigned. type: string type: object PaginationLinks: properties: first: description: The first page. $ref: '#/components/schemas/LinksElement' last: description: The last page. $ref: '#/components/schemas/LinksElement' next: description: The next page. Only present if there is a next page. $ref: '#/components/schemas/LinksElement' prev: description: The previous page. Only present if there is a previous page. $ref: '#/components/schemas/LinksElement' self: description: The current page. $ref: '#/components/schemas/LinksElement' required: - self - first - last type: object Opi: properties: enablePayAtTable: description: Indicates if Pay at table is enabled. type: boolean payAtTableStoreNumber: description: The store number to use for Pay at Table. type: string payAtTableURL: description: The URL and port number used for Pay at Table communication. type: string type: object ScheduleTerminalActionsRequest: properties: actionDetails: description: Information about the action to take. oneOf: - $ref: '#/components/schemas/InstallAndroidAppDetails' - $ref: '#/components/schemas/InstallAndroidCertificateDetails' - $ref: '#/components/schemas/ReleaseUpdateDetails' - $ref: '#/components/schemas/UninstallAndroidAppDetails' - $ref: '#/components/schemas/UninstallAndroidCertificateDetails' scheduledAt: description: "The date and time when the action should happen. \nFormat: [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339), but without the **Z** before the time offset. For example, **2021-11-15T12:16:21+01:00** \nThe action is sent with the first [maintenance call](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api#when-actions-take-effect) after the specified date and time in the time zone of the terminal. \nAn empty value causes the action to be sent as soon as possible: at the next maintenance call." type: string storeId: description: The unique ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores). If present, all terminals in the `terminalIds` list must be assigned to this store. type: string terminalIds: description: 'A list of unique IDs of the terminals to apply the action to. You can extract the IDs from the [GET `/terminals`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/terminals) response. Maximum length: 100 IDs.' items: type: string type: array type: object Payment: properties: contactlessCurrency: description: The default currency for contactless payments on the payment terminal, as the three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. maxLength: 3 minLength: 3 type: string hideMinorUnitsInCurrencies: description: Hides the minor units for the listed [ISO currency codes](https://en.wikipedia.org/wiki/ISO_4217). items: type: string type: array type: object TerminalReassignmentTarget: properties: companyId: description: The unique identifier of the company account to which the terminal is reassigned. type: string inventory: description: 'Indicates if the terminal is reassigned to the inventory of the merchant account. - If **true**, the terminal is in the inventory of the merchant account and cannot process transactions. - If **false**, the terminal is reassigned directly to the merchant account and can process transactions.' type: boolean merchantId: description: The unique identifier of the merchant account to which the terminal is reassigned. type: string storeId: description: The unique identifier of the store to which the terminal is reassigned. type: string required: - inventory type: object Connectivity: properties: simcardStatus: description: 'Indicates the status of the SIM card in the payment terminal. Can be updated and received only at terminal level, and only for models that support cellular connectivity. Possible values: * **ACTIVATED**: the SIM card is activated. Cellular connectivity may still need to be enabled on the terminal itself, in the **Network** settings. * **INVENTORY**: the SIM card is not activated. The terminal can''t use cellular connectivity.' enum: - ACTIVATED - INVENTORY type: string type: object Profile: properties: authType: description: 'The type of Wi-Fi network. Possible values: **wpa-psk**, **wpa2-psk**, **wpa-eap**, **wpa2-eap**.' type: string autoWifi: description: Indicates whether to automatically select the best authentication method available. Does not work on older terminal models. type: boolean bssType: description: Use **infra** for infrastructure-based networks. This applies to most networks. Use **adhoc** only if the communication is p2p-based between base stations. type: string channel: description: The channel number of the Wi-Fi network. The recommended setting is **0** for automatic channel selection. format: int32 type: integer defaultProfile: description: Indicates whether this is your preferred wireless network. If **true**, the terminal will try connecting to this network first. type: boolean eap: description: 'For `authType` **wpa-eap** or **wpa2-eap**. Possible values: **tls**, **peap**, **leap**, **fast**' type: string eapCaCert: description: For `authType` **wpa-eap** or **wpa2-eap**. The root certificate from the CA that signed the certificate of the RADIUS server that is part of your wireless network. $ref: '#/components/schemas/File' eapClientCert: description: For `eap` **tls**. The certificate chain for the terminals. All terminals in the same network will use the same EAP client certificate. $ref: '#/components/schemas/File' eapClientKey: description: For `eap` **tls**. The RSA private key for the client. Include the lines BEGIN RSA PRIVATE KEY and END RSA PRIVATE KEY. $ref: '#/components/schemas/File' eapClientPwd: description: For `eap` **tls**. The password of the RSA key file, if that file is password-protected. type: string eapIdentity: description: For `authType` **wpa-eap** or **wpa2-eap**. The EAP-PEAP username from your MS-CHAP account. Must match the configuration of your RADIUS server. type: string eapIntermediateCert: description: For `eap` **tls**. The EAP intermediate certificate. $ref: '#/components/schemas/File' eapPwd: description: For `eap` **peap**. The EAP-PEAP password from your MS-CHAP account. Must match the configuration of your RADIUS server. type: string hiddenSsid: description: Indicates if the network doesn't broadcast its SSID. Mandatory for Android terminals, because these terminals rely on this setting to be able to connect to any network. type: boolean name: description: Your name for the Wi-Fi profile. type: string psk: description: For `authType` **wpa-psk or **wpa2-psk**. The password to the wireless network. type: string ssid: description: The name of the wireless network. type: string wsec: description: 'The type of encryption. Possible values: **auto**, **ccmp** (recommended), **tkip**' type: string required: - ssid - bssType - authType - wsec type: object Gratuity: properties: allowCustomAmount: description: Indicates whether one of the predefined tipping options is to let the shopper enter a custom tip. If **true**, only three of the other options defined in `predefinedTipEntries` are shown. type: boolean currency: description: The currency that the tipping settings apply to. type: string predefinedTipEntries: description: 'Tipping options the shopper can choose from if `usePredefinedTipEntries` is **true**. The maximum number of predefined options is four, or three plus the option to enter a custom tip. The options can be a mix of: - A percentage of the transaction amount. Example: **5%** - A tip amount in [minor units](https://docs.adyen.com/development-resources/currency-codes). Example: **500** for a EUR 5 tip.' items: type: string type: array usePredefinedTipEntries: description: Indicates whether the terminal shows a prompt to enter a tip (**false**), or predefined tipping options to choose from (**true**). type: boolean type: object Currency: properties: amount: description: Surcharge amount per transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). format: int32 type: integer currencyCode: description: Three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). For example, **AUD**. type: string percentage: description: Surcharge percentage per transaction. The maximum number of decimal places is two. For example, **1%** or **2.27%**. format: double type: number required: - currencyCode type: object ReceiptOptions: properties: logo: description: The receipt logo converted to a Base64-encoded string. The image must be a .bmp file of < 256 KB, dimensions 240 (H) x 384 (W) px. maxLength: 350000 type: string promptBeforePrinting: description: Indicates whether a screen appears asking if you want to print the shopper receipt. type: boolean qrCodeData: description: "Data to print on the receipt as a QR code. This can include static text and the following variables:\n\n- `${merchantreference}`: the merchant reference of the transaction.\n- `${pspreference}`: the PSP reference of the transaction.\n\n For example, **http://www.example.com/order/${pspreference}/${merchantreference}**." type: string type: object MinorUnitsMonetaryValue: properties: amount: description: The transaction amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). format: int32 type: integer currencyCode: description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). type: string type: object Localization: properties: language: description: Language of the terminal. type: string secondaryLanguage: description: Secondary language of the terminal. type: string timezone: description: The time zone of the terminal. type: string type: object InstallAndroidAppDetails: additionalProperties: false properties: appId: description: The unique identifier of the app to be installed. type: string type: default: InstallAndroidApp description: 'Type of terminal action: Install an Android app.' enum: - InstallAndroidApp type: string type: object NotificationUrl: properties: localUrls: description: One or more local URLs to send notifications to when using Terminal API. items: $ref: '#/components/schemas/Url' type: array publicUrls: description: One or more public URLs to send notifications to when using Terminal API. items: $ref: '#/components/schemas/Url' type: array type: object TerminalAssignment: properties: companyId: description: The unique identifier of the company account to which terminal is assigned. type: string merchantId: description: The unique identifier of the merchant account to which terminal is assigned. type: string reassignmentTarget: description: Indicates where the terminal is in the process of being reassigned to. $ref: '#/components/schemas/TerminalReassignmentTarget' status: description: "The status of the reassignment. Possible values: \n * `reassignmentInProgress`: the terminal was boarded and is now scheduled to remove the configuration. Wait for the terminal to synchronize with the Adyen platform.\n * `deployed`: the terminal is deployed and reassigned. \n * `inventory`: the terminal is in inventory and cannot process transactions. \n * `boarded`: the terminal is boarded to a store, or a merchant account representing a store, and can process transactions. \n" enum: - boarded - deployed - inventory - reassignmentInProgress type: string storeId: description: The unique identifier of the store to which terminal is assigned. type: string required: - companyId - status type: object File: properties: data: description: The certificate content converted to a Base64-encoded string. type: string name: description: The name of the certificate. Must be unique across Wi-Fi profiles. type: string required: - name - data type: object ReleaseUpdateDetails: additionalProperties: false properties: type: default: ReleaseUpdate description: 'Type of terminal action: Update Release.' enum: - ReleaseUpdate type: string updateAtFirstMaintenanceCall: description: Boolean flag that tells if the terminal should update at the first next maintenance call. If false, terminal will update on its configured reboot time. type: boolean type: object InvalidField: properties: message: description: Description of the validation error. type: string name: description: The field that has an invalid value. type: string value: description: The invalid value. type: string required: - name - value - message type: object ScheduleTerminalActionsResponse: properties: actionDetails: description: Information about the action to take. oneOf: - $ref: '#/components/schemas/InstallAndroidAppDetails' - $ref: '#/components/schemas/InstallAndroidCertificateDetails' - $ref: '#/components/schemas/ReleaseUpdateDetails' - $ref: '#/components/schemas/UninstallAndroidAppDetails' - $ref: '#/components/schemas/UninstallAndroidCertificateDetails' items: x-addedInVersion: '1' description: A list containing a terminal ID and an action ID for each terminal that the action was scheduled for. items: $ref: '#/components/schemas/TerminalActionScheduleDetail' type: array scheduledAt: description: "The date and time when the action should happen. \nFormat: [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339), but without the **Z** before the time offset. For example, **2021-11-15T12:16:21+01:00** \nThe action is sent with the first [maintenance call](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api#when-actions-take-effect) after the specified date and time in the time zone of the terminal. \nAn empty value causes the action to be sent as soon as possible: at the next maintenance call." type: string storeId: description: The unique ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores). If present, all terminals in the `terminalIds` list must be assigned to this store. type: string terminalsWithErrors: additionalProperties: items: type: string type: array description: The validation errors that occurred in the list of terminals, and for each error the IDs of the terminals that the error applies to. type: object totalErrors: description: The number of terminals for which scheduling the action failed. format: int32 type: integer totalScheduled: description: The number of terminals for which the action was successfully scheduled. This doesn't mean the action has happened yet. format: int32 type: integer type: object TerminalConnectivityBluetooth: properties: ipAddress: description: The terminal's Bluetooth IP address. type: string macAddress: description: The terminal's Bluetooth MAC address. type: string type: object UninstallAndroidAppDetails: additionalProperties: false properties: appId: description: The unique identifier of the app to be uninstalled. type: string type: default: UninstallAndroidApp description: 'Type of terminal action: Uninstall an Android app.' enum: - UninstallAndroidApp type: string type: object Key: properties: identifier: description: The unique identifier of the shared key. type: string passphrase: description: The secure passphrase to protect the shared key. type: string version: description: The version number of the shared key. format: int32 type: integer type: object TerminalActionScheduleDetail: properties: id: description: The ID of the action on the specified terminal. type: string terminalId: description: The unique ID of the terminal that the action applies to. type: string type: object OfflineProcessing: properties: chipFloorLimit: description: The maximum offline transaction amount for chip cards, in the processing currency and specified in [minor units](https://docs.adyen.com/development-resources/currency-codes). format: int32 type: integer offlineSwipeLimits: description: The maximum offline transaction amount for swiped cards, in the specified currency. items: $ref: '#/components/schemas/MinorUnitsMonetaryValue' type: array type: object InstallAndroidCertificateDetails: additionalProperties: false properties: certificateId: description: The unique identifier of the certificate to be installed. type: string type: default: InstallAndroidCertificate description: 'Type of terminal action: Install an Android certificate.' enum: - InstallAndroidCertificate type: string type: object PayAtTable: properties: authenticationMethod: description: 'Allowed authentication methods: Magswipe, Manual Entry.' enum: - MAGSWIPE - MKE type: string enablePayAtTable: description: Enable Pay at table. type: boolean paymentInstrument: description: 'Sets the allowed payment instrument for Pay at table transactions. Can be: **cash** or **card**. If not set, the terminal presents both options.' enum: - Cash - Card type: string type: object Terminal: properties: assignment: x-addedInVersion: '2' description: Indicates the account level to which the terminal is assigned, the [assignment status](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api), and where the terminals is in the process of being reassigned to. $ref: '#/components/schemas/TerminalAssignment' connectivity: x-addedInVersion: '2' description: Information about bluetooth, cellular, ethernet and wifi connectivity for the terminal. $ref: '#/components/schemas/TerminalConnectivity' firmwareVersion: description: The software release currently in use on the terminal. type: string id: description: The unique identifier of the terminal. type: string lastActivityAt: x-addedInVersion: '2' description: Date and time of the last activity on the terminal. Not included when the last activity was more than 14 days ago. format: date-time type: string lastTransactionAt: x-addedInVersion: '2' description: Date and time of the last transaction on the terminal. Not included when the last transaction was more than 14 days ago. format: date-time type: string model: x-addedInVersion: '2' description: The model name of the terminal. type: string serialNumber: description: The serial number of the terminal. type: string type: object TerminalConnectivityCellular: properties: iccid: description: The integrated circuit card identifier (ICCID) of the SIM card in the terminal. type: string status: description: On a terminal that supports 3G or 4G connectivity, indicates the status of the SIM card in the terminal. enum: - activated - deactivated - deprecated - inventory - readyForActivation type: string type: object TapToPay: properties: merchantDisplayName: description: The text shown on the screen during the Tap to Pay transaction. type: string type: object WifiProfiles: properties: profiles: description: List of remote Wi-Fi profiles. items: $ref: '#/components/schemas/Profile' type: array settings: description: General Wi-Fi settings. $ref: '#/components/schemas/Settings' type: object Nexo: properties: displayUrls: description: The list of local and public URLs to send display notifications to when using Terminal API. $ref: '#/components/schemas/NotificationUrl' encryptionKey: description: The key you share with Adyen to secure local communications when using Terminal API. $ref: '#/components/schemas/Key' eventUrls: description: The list of local and public URLs to send event notifications to when using Terminal API. $ref: '#/components/schemas/EventUrl' nexoEventUrls: deprecated: true x-deprecatedInVersion: '1' x-deprecatedMessage: Use `eventUrls` instead. description: One or more URLs to send event messages to when using Terminal API. items: type: string type: array notification: description: Configures sending event notifications by pressing a button on a terminal, for example used for pay-at-table. $ref: '#/components/schemas/Notification' type: object Configuration: properties: brand: description: 'Payment method, like **eftpos_australia** or **mc**. See the [possible values](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api). ' type: string country: description: Countries, to filter different surcharge amounts for domestic or international cards. items: type: string type: array currencies: description: Currency, and surcharge percentage or amount. items: $ref: '#/components/schemas/Currency' type: array sources: description: 'Funding source. Possible values: * **Credit** * **Debit**' items: type: string type: array required: - brand - currencies type: object Signature: properties: askSignatureOnScreen: description: If `skipSignature` is false, indicates whether the shopper should provide a signature on the display (**true**) or on the merchant receipt (**false**). type: boolean deviceName: description: Name that identifies the terminal. type: string deviceSlogan: description: Slogan shown on the start screen of the device. maxLength: 50 type: string skipSignature: description: Skip asking for a signature. This is possible because all global card schemes (American Express, Diners, Discover, JCB, MasterCard, VISA, and UnionPay) regard a signature as optional. type: boolean type: object Hardware: properties: displayMaximumBackLight: description: The brightness of the display when the terminal is being used, expressed as a percentage. format: int32 type: integer resetTotalsHour: description: 'The hour of the day when the terminal is set to reset the Totals report. By default, the reset hour is at 6:00 AM in the timezone of the terminal. Minimum value: 0, maximum value: 23.' format: int32 type: integer restartHour: description: 'The hour of the day when the terminal is set to reboot to apply the configuration and software updates. By default, the restart hour is at 6:00 AM in the timezone of the terminal. Minimum value: 0, maximum value: 23.' format: int32 type: integer type: object EventUrl: properties: eventLocalUrls: description: One or more local URLs to send event notifications to when using Terminal API. items: $ref: '#/components/schemas/Url' type: array eventPublicUrls: description: One or more public URLs to send event notifications to when using Terminal API. items: $ref: '#/components/schemas/Url' type: array type: object Url: properties: encrypted: description: Indicates if the message sent to this URL should be encrypted. type: boolean password: description: The password for authentication of the notifications. type: string url: description: 'The URL in the format: http(s)://domain.com.' type: string username: description: The username for authentication of the notifications. type: string type: object Surcharge: properties: askConfirmation: description: Show the surcharge details on the terminal, so the shopper can confirm. type: boolean configurations: description: Surcharge fees or percentages for specific payment methods, funding sources (credit or debit), and currencies. items: $ref: '#/components/schemas/Configuration' type: array type: object Referenced: properties: enableStandaloneRefunds: description: Indicates whether referenced refunds are enabled on the standalone terminal. type: boolean type: object CardholderReceipt: properties: headerForAuthorizedReceipt: description: A custom header to show on the shopper receipt for an authorised transaction. Allows one or two comma-separated header lines, and blank lines. For example, `header,header,filler` type: string type: object Timeouts: properties: fromActiveToSleep: description: Indicates the number of seconds of inactivity after which the terminal display goes into sleep mode. format: int32 type: integer type: object TerminalSettings: 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' type: object Refunds: properties: referenced: description: Settings for referenced refunds. $ref: '#/components/schemas/Referenced' type: object TerminalConnectivityEthernet: properties: ipAddress: description: The terminal's ethernet IP address. type: string linkNegotiation: description: The ethernet link negotiation that the terminal uses. type: string macAddress: description: The terminal's ethernet MAC address. type: string type: object examples: patch-terminals-terminalId-terminalLogos-remove-logo: summary: Remove logo to restore the logo from a higher level description: Example request to remove the payment terminal logo configured at the current level, and inherit the logo from a higher level value: data: '' patch-terminals-terminalId-terminalSettings-add-eap-peap-and-psk-wifi-profiles-200: summary: Response code - 200 OK description: Example response for adding an EAP-PEAP Wi-Fi profile and a PSK Wi-Fi profile for a terminal value: cardholderReceipt: headerForAuthorizedReceipt: header1,header2,filler gratuities: - currency: EUR usePredefinedTipEntries: true predefinedTipEntries: - '100' - 1% - 5% allowCustomAmount: true nexo: displayUrls: localUrls: - password: BASIC_AUTH_PASSWORD url: https://your-display-notifications-endpoint.com username: BASIC_AUTH_USERNAME encryptionKey: identifier: KEY_IDENTIFIER passphrase: KEY_PASSPHRASE version: 1 eventUrls: eventPublicUrls: - password: BASIC_AUTH_PASSWORD url: https://your-event-notifications-endpoint.com username: BASIC_AUTH_USERNAME notification: showButton: true opi: enablePayAtTable: true payAtTableStoreNumber: '1' payAtTableURL: https:/your-pay-at-table-endpoint.com offlineProcessing: chipFloorLimit: 0 receiptOptions: qrCodeData: http://www.example.com/order/${pspreference}/${merchantreference} receiptPrinting: shopperApproved: true shopperRefused: true shopperCancelled: true shopperRefundApproved: true shopperRefundRefused: true shopperVoid: true signature: askSignatureOnScreen: true skipSignature: false deviceName: Amsterdam-236203386 wifiProfiles: profiles: - authType: wpa-eap autoWifi: false bssType: infra channel: 0 defaultProfile: true eap: peap eapCaCert: data: MD1rKS05M2JqRVFNQ...RTtLH1tLWo= name: eap-peap-ca.pem eapIdentity: admin eapIntermediateCert: data: PD3tUS1CRDdJTiGDR...EFoLS0tLQg= name: eap-peap-client.pem eapPwd: EAP_PEAP_PASSWORD hiddenSsid: false name: Profile-eap-peap-1 ssid: your-network wsec: ccmp - authType: wpa-psk autoWifi: false bssType: infra channel: 0 defaultProfile: false hiddenSsid: false name: Profile-guest-wifi psk: WIFI_PASSWORD ssid: your-network wsec: ccmp settings: band: 2.4GHz roaming: true timeout: 5 timeouts: fromActiveToSleep: 30 hardware: displayMaximumBackLight: 75 restartHour: 5 passcodes: adminMenuPin: '1234' txMenuPin: '1234' refundPin: '123456' screenLockPin: '1111' connectivity: simcardStatus: INVENTORY patch-terminals-terminalId-terminalLogos-remove-logo-200: summary: Response code - 200 OK description: Example response for removing a payment terminal logo to restore the logo from a higher level value: data: LOGO_INHERITED_FROM_HIGHER_LEVEL_BASE-64_ENCODED_STRING post-terminals-scheduleActions-uninstall-cert-200: summary: Response code - 200 OK description: Example response after scheduling the removal of an Android certificate value: actionDetails: certificateId: ANDC422LZ223223K5F78NVN9SL4VPH type: UninstallAndroidCertificate scheduledAt: 2021-12-12T20:21:22-0100 storeId: '' items: - id: TRAC422T2223223K5GFMQHM6WQ4KB6 terminalId: S1E-000150183300032 - id: TRAC4224X22338VQ5GD4CQJCQT5PC2 terminalId: S1E-000150183300033 - id: TRAC4224Z223223K5GD89RLBWQ6CWT terminalId: S1F2-000150183300034 terminalIds: - S1E-000150183300032 - S1E-000150183300033 - S1F2-000150183300034 terminalsWithErrors: {} totalScheduled: 3 totalErrors: 0 patch-terminals-terminalId-terminalLogos-upload-logo-200: summary: Response code - 200 OK description: Example response for uploading a payment terminal logo value: data: BASE-64_ENCODED_STRING_FROM_THE_REQUEST get-terminals-terminalId-terminalLogos-success-200: summary: Response code - 200 OK description: Example response when getting the logo of a payment terminal value: data: BASE-64_ENCODED_STRING post-terminals-scheduleActions-install-app-200: summary: Response code - 200 OK description: Example response after scheduling the installation of an Android app value: actionDetails: appId: ANDA422LZ223223K5F694GCCF732K8 type: InstallAndroidApp scheduledAt: 2021-12-12T20:21:22-0100 storeId: '' items: - id: TRAC422T2223223K5GFMQHM6WQ4KB6 terminalId: S1E-000150183300032 - id: TRAC4224X22338VQ5GD4CQJCQT5PC2 terminalId: S1E-000150183300033 - id: TRAC4224Z223223K5GD89RLBWQ6CWT terminalId: S1F2-000150183300034 terminalIds: - S1E-000150183300032 - S1E-000150183300033 - S1F2-000150183300034 terminalsWithErrors: {} totalScheduled: 3 totalErrors: 0 get-terminals-success-200: summary: List of terminals description: Example response when getting terminals that your API credential has access to. value: _links: first: href: https://management-test.adyen.com/v3/terminals?pageNumber=1&pageSize=20 last: href: https://management-test.adyen.com/v3/terminals?pageNumber=1&pageSize=20 next: href: https://management-test.adyen.com/v3/terminals?pageNumber=1&pageSize=20 self: href: https://management-test.adyen.com/v3/terminals?pageNumber=0&pageSize=20 itemsTotal: 1 pagesTotal: 1 data: - id: AMS1-000150183300032 model: AMS1 serialNumber: 150183300032 firmwareVersion: Castles_Android 1.89.4 assignment: companyId: YOUR_COMPANY_ACCOUNT merchantId: YOUR_MERCHANT_ACCOUNT storeId: YOUR_STORE_ID status: reassignmentInProgress reassignmentTarget: inventory: true connectivity: cellular: iccid: '6006491286999921374' wifi: ipAddress: 198.51.100.1 macAddress: C4:6E:33:26:36:E4 patch-terminals-terminalId-terminalSettings-add-eap-tls-wifi-profile-200: summary: Response code - 200 OK description: Example response for adding an EAP-TLS Wi-Fi profile for a terminal value: cardholderReceipt: headerForAuthorizedReceipt: header1,header2,filler gratuities: - currency: EUR usePredefinedTipEntries: true predefinedTipEntries: - '100' - 1% - 5% allowCustomAmount: true nexo: displayUrls: localUrls: - password: BASIC_AUTH_PASSWORD url: https://your-display-notifications-endpoint.com username: BASIC_AUTH_USERNAME encryptionKey: identifier: KEY_IDENTIFIER passphrase: KEY_PASSPHRASE version: 1 eventUrls: eventPublicUrls: - password: BASIC_AUTH_PASSWORD url: https://your-event-notifications-endpoint.com username: BASIC_AUTH_USERNAME notification: showButton: true opi: enablePayAtTable: true payAtTableStoreNumber: '1' payAtTableURL: https:/your-pay-at-table-endpoint.com offlineProcessing: chipFloorLimit: 0 receiptOptions: qrCodeData: http://www.example.com/order/${pspreference}/${merchantreference} receiptPrinting: shopperApproved: true shopperRefused: true shopperCancelled: true shopperRefundApproved: true shopperRefundRefused: true shopperVoid: true signature: askSignatureOnScreen: true skipSignature: false deviceName: Amsterdam-236203386 wifiProfiles: profiles: - authType: wpa-eap autoWifi: false bssType: infra channel: 0 defaultProfile: true eap: tls eapCaCert: data: LS0tLS05M2JqRVFNQ...EUtLS0tLQo= name: eap-tls-ca.pem eapClientCert: data: LS0tLS1CRUdJTiBDR...EUtLS0tLQo= name: eap-tls-client.pem eapClientKey: data: AAAB3NzaC1...Rtah3KLFwPU= name: rsa-private.key eapClientPwd: '' eapIdentity: admin hiddenSsid: false name: Profile-eap-tls-1 ssid: your-network wsec: ccmp settings: band: 2.4GHz roaming: true timeout: 5 timeouts: fromActiveToSleep: 30 hardware: displayMaximumBackLight: 75 restartHour: 5 passcodes: adminMenuPin: '1234' txMenuPin: '1234' refundPin: '123456' screenLockPin: '1111' connectivity: simcardStatus: INVENTORY patch-terminals-terminalId-terminalLogos-upload-logo: summary: Upload terminal logo description: Example request to upload a payment terminal logo value: data: LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING patch-terminals-terminalId-terminalSettings-add-eap-peap-and-psk-wifi-profiles: summary: Add EAP-PEAP and PSK Wi-Fi profiles description: Example request to add an EAP-PEAP Wi-Fi profile and a PSK Wi-Fi profile for a terminal value: wifiProfiles: profiles: - authType: wpa-eap autoWifi: false bssType: infra channel: 0 defaultProfile: true eap: peap eapCaCert: data: MD1rKS05M2JqRVFNQ...RTtLH1tLWo= name: eap-peap-ca.pem eapIdentity: admin eapIntermediateCert: data: PD3tUS1CRDdJTiGDR...EFoLS0tLQg= name: eap-peap-client.pem eapPwd: EAP_PEAP_PASSWORD hiddenSsid: false name: Profile-eap-peap-1 ssid: your-network wsec: ccmp - authType: wpa-psk autoWifi: false bssType: infra channel: 0 defaultProfile: false hiddenSsid: false name: Profile-guest-wifi psk: WIFI_PASSWORD ssid: your-network wsec: ccmp settings: band: 2.4GHz roaming: true timeout: 5 post-terminals-scheduleActions-uninstall-cert: summary: Schedule uninstalling an Android certificate description: Example request to schedule uninstalling an Android certificate value: terminalIds: - S1E-000150183300032 - S1E-000150183300033 - S1F2-000150183300034 storeId: '' scheduledAt: 2021-12-12T20:21:22-0100 actionDetails: type: UninstallAndroidCertificate certificateId: ANDC422LZ223223K5F78NVN9SL4VPH patch-terminals-terminalId-terminalSettings-add-eap-tls-wifi-profile: summary: Add EAP-TLS Wi-Fi profile description: Example request to add an EAP-TLS Wi-Fi profile for a terminal value: wifiProfiles: profiles: - authType: wpa-eap autoWifi: false bssType: infra channel: 0 defaultProfile: true eap: tls eapCaCert: data: LS0tLS05M2JqRVFNQ...EUtLS0tLQo= name: eap-tls-ca.pem eapClientCert: data: LS0tLS1CRUdJTiBDR...EUtLS0tLQo= name: eap-tls-client.pem eapClientKey: data: AAAB3NzaC1...Rtah3KLFwPU= name: rsa-private.key eapClientPwd: '' eapIdentity: admin hiddenSsid: false name: Profile-eap-tls-1 ssid: your-network wsec: ccmp settings: band: 2.4GHz roaming: true timeout: 5 post-terminals-scheduleActions-verification-error-422: summary: Response code - 422 Unprocessable Entity description: Example response for failed verification of terminal IDs value: type: https://docs.adyen.com/errors/unprocessable-entity errorCode: '02_005' title: Terminal ID verification failed. status: 422 detail: Terminal IDs are empty post-terminals-scheduleActions-install-app: summary: Schedule installing an Android app description: Example request to schedule installing an Android app value: terminalIds: - S1E-000150183300032 - S1E-000150183300033 - S1F2-000150183300034 storeId: '' scheduledAt: 2021-12-12T20:21:22-0100 actionDetails: type: InstallAndroidApp appId: ANDA422LZ223223K5F694GCCF732K8 post-terminals-scheduleActions-verification-error: summary: Invalid terminal ID in the request description: Example request to see what validation errors look like value: terminalIds: - S1E-000150183300032 - S1E-000150183300033 - S1F2-000150183300034 storeId: '' scheduledAt: 2021-12-11T20:21:22-0100 actionDetails: type: InstallAndroidApp appId: ANDA422LZ223223K5F694GCCF621J7 get-terminals-terminalId-terminalSettings-success-200: summary: Response code - 200 OK description: Example response when getting the settings of a payment terminal value: cardholderReceipt: headerForAuthorizedReceipt: header1,header2,filler gratuities: - currency: EUR usePredefinedTipEntries: true predefinedTipEntries: - '100' - 1% - 5% allowCustomAmount: true nexo: displayUrls: localUrls: - password: BASIC_AUTH_PASSWORD url: https://your-display-notifications-endpoint.com username: BASIC_AUTH_USERNAME encryptionKey: identifier: KEY_IDENTIFIER passphrase: KEY_PASSPHRASE version: 1 eventUrls: eventPublicUrls: - password: BASIC_AUTH_PASSWORD url: https://your-event-notifications-endpoint.com username: BASIC_AUTH_USERNAME notification: showButton: true opi: enablePayAtTable: true payAtTableStoreNumber: '1' payAtTableURL: https:/your-pay-at-table-endpoint.com offlineProcessing: chipFloorLimit: 0 receiptOptions: qrCodeData: http://www.example.com/order/${pspreference}/${merchantreference} receiptPrinting: shopperApproved: true shopperRefused: true shopperCancelled: true shopperRefundApproved: true shopperRefundRefused: true shopperVoid: true signature: askSignatureOnScreen: true skipSignature: false deviceName: Amsterdam-236203386 wifiProfiles: profiles: - authType: wpa-psk autoWifi: false bssType: infra channel: 0 defaultProfile: true hiddenSsid: false name: Guest Wi-Fi psk: 4R8R2R3V456X ssid: G470P37660D4G wsec: ccmp settings: band: All roaming: true timeouts: fromActiveToSleep: 30 hardware: displayMaximumBackLight: 75 restartHour: 5 passcodes: adminMenuPin: '1234' txMenuPin: '1234' refundPin: '123456' screenLockPin: '1111' connectivity: simcardStatus: INVENTORY securitySchemes: ApiKeyAuth: in: header name: X-API-Key type: apiKey BasicAuth: scheme: basic type: http x-groups: - Account holders - Accounts - Verification