openapi: 3.1.0 info: version: '6' x-publicVersion: true title: Adyen Account acceptDispute Stores 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: Stores paths: /closeStores: post: tags: - Stores summary: Adyen Close Stores description: Closes stores associated with an account holder. x-addedInVersion: '5' operationId: post-closeStores x-groupName: Account holders x-sortIndex: 9 x-methodName: closeStores security: - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/CloseStoresRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GenericResponse' examples: post-closeStores200Example: summary: Default post-closeStores 200 response x-microcks-default: true value: invalidFields: - example_value pspReference: REF-001 resultCode: CODE123 description: OK - the request has succeeded. '400': content: application/json: examples: generic: $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-closeStores401Example: summary: Default post-closeStores 401 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unauthorized - authentication required. '403': content: application/json: examples: generic: $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-closeStores422Example: summary: Default post-closeStores 422 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-closeStores500Example: summary: Default post-closeStores 500 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /stores: get: tags: - Stores summary: Adyen Get a List of Stores description: 'Returns a list of stores. The list is grouped into pages as defined by the query parameters. 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—Stores read * Management API—Stores read and write' operationId: get-stores x-sortIndex: 4 x-methodName: listStores security: - BasicAuth: [] - ApiKeyAuth: [] parameters: - 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 10 items on a page. name: pageSize in: query required: false schema: format: int32 type: integer - description: The reference of the store. name: reference in: query required: false schema: type: string - description: The unique identifier of the merchant account. name: merchantId in: query required: false schema: type: string responses: '200': content: application/json: examples: success: $ref: '#/components/examples/get-stores-success-200' schema: $ref: '#/components/schemas/ListStoresResponse' description: OK - the request has succeeded. '400': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: get-stores400Example: summary: Default get-stores 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-stores401Example: summary: Default get-stores 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-stores403Example: summary: Default get-stores 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-stores422Example: summary: Default get-stores 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-stores500Example: summary: Default get-stores 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 post: tags: - Stores summary: Adyen Create a Store description: 'Creates a store for the merchant account specified in the request. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write' operationId: post-stores x-sortIndex: 5 x-methodName: createStore security: - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: application/json: examples: post-stores: $ref: '#/components/examples/post-stores-post-stores' schema: $ref: '#/components/schemas/StoreCreationWithMerchantCodeRequest' responses: '200': content: application/json: examples: post-stores: $ref: '#/components/examples/post-stores-post-stores-200' schema: $ref: '#/components/schemas/Store' description: OK - the request has succeeded. '400': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: post-stores400Example: summary: Default post-stores 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-stores401Example: summary: Default post-stores 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-stores403Example: summary: Default post-stores 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-stores422Example: summary: Default post-stores 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-stores500Example: summary: Default post-stores 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 /stores/{storeId}: get: tags: - Stores summary: Adyen Get a Store description: 'Returns the details of the store 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—Stores read * Management API—Stores read and write' operationId: get-stores-storeId x-sortIndex: 6 x-methodName: getStoreById security: - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: The unique identifier of the store. name: storeId in: path required: true schema: type: string responses: '200': content: application/json: examples: success: $ref: '#/components/examples/get-stores-storeId-success-200' schema: $ref: '#/components/schemas/Store' description: OK - the request has succeeded. '400': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: get-stores-storeId400Example: summary: Default get-stores-storeId 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-stores-storeId401Example: summary: Default get-stores-storeId 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-stores-storeId403Example: summary: Default get-stores-storeId 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-stores-storeId422Example: summary: Default get-stores-storeId 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-stores-storeId500Example: summary: Default get-stores-storeId 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: - Stores summary: Adyen Update a Store description: 'Updates the store identified in the path. You can only update some store parameters. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write' operationId: patch-stores-storeId x-sortIndex: 7 x-methodName: updateStoreById security: - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: application/json: examples: patch-stores: $ref: '#/components/examples/patch-stores-storeId-patch-stores' patch-stores-splitConfiguration: $ref: '#/components/examples/patch-stores-storeId-patch-stores-splitConfiguration' schema: $ref: '#/components/schemas/UpdateStoreRequest' parameters: - description: The unique identifier of the store. name: storeId in: path required: true schema: type: string responses: '200': content: application/json: examples: patch-stores: $ref: '#/components/examples/patch-stores-storeId-patch-stores-200' schema: $ref: '#/components/schemas/Store' description: OK - the request has succeeded. '400': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: patch-stores-storeId400Example: summary: Default patch-stores-storeId 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-stores-storeId401Example: summary: Default patch-stores-storeId 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-stores-storeId403Example: summary: Default patch-stores-storeId 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-stores-storeId422Example: summary: Default patch-stores-storeId 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-stores-storeId500Example: summary: Default patch-stores-storeId 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 /stores/{storeId}/terminalLogos: get: tags: - Stores summary: Adyen Get the Terminal Logo description: "Returns the logo that is configured for a specific payment terminal model at the store identified in the path. \nThe logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. \nThis logo applies to all terminals of that model under the store unless a different logo is configured for an individual terminal.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write" operationId: get-stores-storeId-terminalLogos x-sortIndex: 2 x-methodName: getTerminalLogoByStoreId security: - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: The unique identifier of the store. name: storeId in: path required: true schema: type: string - description: 'The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.' name: model in: query required: true schema: type: string responses: '200': content: application/json: examples: success: $ref: '#/components/examples/get-stores-storeId-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-stores-storeId-terminalLogos400Example: summary: Default get-stores-storeId-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-stores-storeId-terminalLogos401Example: summary: Default get-stores-storeId-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-stores-storeId-terminalLogos403Example: summary: Default get-stores-storeId-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-stores-storeId-terminalLogos422Example: summary: Default get-stores-storeId-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-stores-storeId-terminalLogos500Example: summary: Default get-stores-storeId-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: - Stores summary: Adyen Update the Terminal Logo description: "Updates the logo that is configured for a specific payment terminal model at the store identified in the path. You can update the logo for only one terminal model at a time.\nThis logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. \n\n* To change the logo, specify the image file as a Base64-encoded string.\n* To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value.\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 settings read and write" operationId: patch-stores-storeId-terminalLogos x-sortIndex: 4 x-methodName: updateTerminalLogoByStoreId security: - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: application/json: examples: remove-logo: $ref: '#/components/examples/patch-stores-storeId-terminalLogos-remove-logo' upload-logo: $ref: '#/components/examples/patch-stores-storeId-terminalLogos-upload-logo' schema: $ref: '#/components/schemas/Logo' parameters: - description: The unique identifier of the store. name: storeId in: path required: true schema: type: string - description: 'The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.' name: model in: query required: true schema: type: string responses: '200': content: application/json: examples: remove-logo: $ref: '#/components/examples/patch-stores-storeId-terminalLogos-remove-logo-200' upload-logo: $ref: '#/components/examples/patch-stores-storeId-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-stores-storeId-terminalLogos400Example: summary: Default patch-stores-storeId-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-stores-storeId-terminalLogos401Example: summary: Default patch-stores-storeId-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-stores-storeId-terminalLogos403Example: summary: Default patch-stores-storeId-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-stores-storeId-terminalLogos422Example: summary: Default patch-stores-storeId-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-stores-storeId-terminalLogos500Example: summary: Default patch-stores-storeId-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 /stores/{storeId}/terminalSettings: get: tags: - Stores summary: Adyen Get Terminal Settings description: 'Returns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless different values are configured for an individual terminal. 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-stores-storeId-terminalSettings x-sortIndex: 1 x-methodName: getTerminalSettingsByStoreId security: - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: The unique identifier of the store. name: storeId in: path required: true schema: type: string responses: '200': content: application/json: examples: success: $ref: '#/components/examples/get-stores-storeId-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-stores-storeId-terminalSettings400Example: summary: Default get-stores-storeId-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-stores-storeId-terminalSettings401Example: summary: Default get-stores-storeId-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-stores-storeId-terminalSettings403Example: summary: Default get-stores-storeId-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-stores-storeId-terminalSettings422Example: summary: Default get-stores-storeId-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-stores-storeId-terminalSettings500Example: summary: Default get-stores-storeId-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: - Stores summary: Adyen Update Terminal Settings description: 'Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal. * 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-stores-storeId-terminalSettings x-sortIndex: 3 x-methodName: updateTerminalSettingsByStoreId security: - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: application/json: examples: add-eap-peap-and-psk-wifi-profiles: $ref: '#/components/examples/patch-stores-storeId-terminalSettings-add-eap-peap-and-psk-wifi-profiles' add-eap-tls-wifi-profile: $ref: '#/components/examples/patch-stores-storeId-terminalSettings-add-eap-tls-wifi-profile' schema: $ref: '#/components/schemas/TerminalSettings' parameters: - description: The unique identifier of the store. name: storeId in: path required: true schema: type: string responses: '200': content: application/json: examples: add-eap-peap-and-psk-wifi-profiles: $ref: '#/components/examples/patch-stores-storeId-terminalSettings-add-eap-peap-and-psk-wifi-profiles-200' add-eap-tls-wifi-profile: $ref: '#/components/examples/patch-stores-storeId-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-stores-storeId-terminalSettings400Example: summary: Default patch-stores-storeId-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-stores-storeId-terminalSettings401Example: summary: Default patch-stores-storeId-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-stores-storeId-terminalSettings403Example: summary: Default patch-stores-storeId-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-stores-storeId-terminalSettings422Example: summary: Default patch-stores-storeId-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-stores-storeId-terminalSettings500Example: summary: Default patch-stores-storeId-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: 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 ListStoresResponse: properties: _links: description: Pagination references. $ref: '#/components/schemas/PaginationLinks' data: description: List of stores items: $ref: '#/components/schemas/Store' 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 LinksElement: properties: href: type: string type: object UpdatableAddress: properties: city: description: The name of the city. type: string line1: description: The street address. type: string line2: description: Second address line. type: string line3: description: Third address line. type: string postalCode: description: The postal code. type: string stateOrProvince: description: "The state or province code as defined in [ISO 3166-2](https://www.iso.org/standard/72483.html). For example, **ON** for Ontario, Canada.\n\nRequired for the following countries:\n - Australia\n- Brazil\n- Canada\n- India\n- Mexico\n- New Zealand\n- United States" type: string type: object GenericResponse: properties: invalidFields: x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: $ref: '#/components/schemas/ErrorFieldType' type: array pspReference: description: The reference of a request. Can be used to uniquely identify the request. type: string resultCode: description: The result code. 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 StoreLocation: properties: city: description: The name of the city. type: string country: description: The two-letter country code in [ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. type: string line1: description: The street address. type: string line2: description: Second address line. type: string line3: description: Third address line. type: string postalCode: description: The postal code. type: string stateOrProvince: description: "The state or province code as defined in [ISO 3166-2](https://www.iso.org/standard/72483.html). For example, **ON** for Ontario, Canada.\n\nRequired for the following countries:\n - Australia\n- Brazil\n- Canada\n- India\n- Mexico\n- New Zealand\n- United States" type: string required: - country 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 ErrorFieldType: properties: errorCode: description: The validation error code. format: int32 type: integer errorDescription: description: A description of the validation error. type: string fieldType: description: The type of error field. $ref: '#/components/schemas/FieldType' 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 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 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 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 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 UpdateStoreRequest: properties: address: description: The address of the store. It is not possible to update the country of the store. $ref: '#/components/schemas/UpdatableAddress' businessLineIds: description: The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__resParam_id) that the store is associated with. items: type: string type: array description: description: The description of the store. type: string externalReferenceId: description: 'The unique identifier of the store, used by certain payment methods and tax authorities. Accepts up to 14 digits. Required for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated by dots, slashes, hyphens, or without separators. Optional for Zip in Australia and SIRET in France, required except for nonprofit organizations and incorporated associations. ' type: string phoneNumber: description: 'The phone number of the store, including ''+'' and country code in the [E.164](https://en.wikipedia.org/wiki/E.164) format. If passed in a different format, we convert and validate the phone number against E.164. ' type: string splitConfiguration: description: Rules for Adyen for Platforms merchants to split the transaction amount and fees. $ref: '#/components/schemas/StoreSplitConfiguration' status: description: "The status of the store. Possible values are:\n\n- **active**: This value is assigned automatically when a store is created. \n- **inactive**: The maximum [transaction limits and number of Store-and-Forward transactions](https://docs.adyen.com/point-of-sale/determine-account-structure/configure-features#payment-features) for the store are set to 0. This blocks new transactions, but captures are still possible.\n- **closed**: The terminals of the store are reassigned to the merchant inventory, so they can't process payments.\n\nYou can change the status from **active** to **inactive**, and from **inactive** to **active** or **closed**. \nOnce **closed**, a store can't be reopened." enum: - active - closed - inactive 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 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 ServiceError: properties: errorCode: description: The error code mapped to the error message. type: string errorType: description: The category of the error. type: string message: description: A short explanation of the issue. type: string pspReference: description: The PSP reference of the payment. type: string status: description: The HTTP response status. format: int32 type: integer type: object StoreCreationWithMerchantCodeRequest: properties: address: description: The address of the store. $ref: '#/components/schemas/StoreLocation' businessLineIds: description: 'The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/legalentity/latest/post/businessLines#responses-200-id) that the store is associated with. If not specified, the business line of the merchant account is used. Required when there are multiple business lines under the merchant account.' items: type: string type: array description: description: Your description of the store. type: string externalReferenceId: description: 'The unique identifier of the store, used by certain payment methods and tax authorities. Accepts up to 14 digits. Required for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated by dots, slashes, hyphens, or without separators. Optional for Zip in Australia and SIRET in France, required except for nonprofit organizations and incorporated associations. ' type: string merchantId: description: The unique identifier of the merchant account that the store belongs to. type: string phoneNumber: description: 'The phone number of the store, including ''+'' and country code in the [E.164](https://en.wikipedia.org/wiki/E.164) format. If passed in a different format, we convert and validate the phone number against E.164. ' type: string reference: description: "Your reference to recognize the store by. Also known as the store code.\n Allowed characters: lowercase and uppercase letters without diacritics, numbers 0 through 9, hyphen (-), and underscore (_).\n\nIf you do not provide a reference in your POST request, it is populated with the Adyen-generated [id](https://docs.adyen.com/api-explorer/Management/latest/post/stores#responses-200-id)." type: string shopperStatement: description: 'The store name to be shown on the shopper''s bank or credit card statement and on the shopper receipt. Maximum length: 22 characters; can''t be all numbers.' type: string splitConfiguration: description: Rules for Adyen for Platforms merchants to split the transaction amount and fees. $ref: '#/components/schemas/StoreSplitConfiguration' required: - description - shopperStatement - phoneNumber - address - merchantId 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 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 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 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 Store: properties: _links: description: Reference to resources connected with the store. $ref: '#/components/schemas/Links' address: description: The address of the store. $ref: '#/components/schemas/StoreLocation' businessLineIds: description: "The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businesslines__resParam_id) that the store is associated with.\n If not specified, the business line of the merchant account is used. Required when there are multiple business lines under the merchant account." items: type: string type: array description: description: The description of the store. type: string externalReferenceId: description: 'The unique identifier of the store, used by certain payment methods and tax authorities. Accepts up to 14 digits. Required for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated by dots, slashes, hyphens, or without separators. Optional for Zip in Australia and SIRET in France, required except for nonprofit organizations and incorporated associations. ' type: string id: description: The unique identifier of the store. This value is generated by Adyen. type: string merchantId: description: The unique identifier of the merchant account that the store belongs to. type: string phoneNumber: description: 'The phone number of the store, including ''+'' and country code in the [E.164](https://en.wikipedia.org/wiki/E.164) format. If passed in a different format, we convert and validate the phone number against E.164. ' type: string reference: description: "A reference to recognize the store by. Also known as the store code.\n Allowed characters: lowercase and uppercase letters without diacritics, numbers 0 through 9, hyphen (-), and underscore (_)" type: string shopperStatement: description: The store name shown on the shopper's bank or credit card statement and on the shopper receipt. type: string splitConfiguration: description: Rules for Adyen for Platforms merchants to split the transaction amount and fees. $ref: '#/components/schemas/StoreSplitConfiguration' status: description: "The status of the store. Possible values are:\n\n- **active**. This value is assigned automatically when a store is created. \n- **inactive**. The terminals under the store are blocked from accepting new transactions, but capturing outstanding transactions is still possible.\n- **closed**. This status is irreversible. The terminals under the store are reassigned to the merchant inventory." enum: - active - closed - inactive type: string 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 FieldType: properties: field: description: The full name of the property. type: string fieldName: description: The type of the field. enum: - accountCode - accountHolderCode - accountHolderDetails - accountNumber - accountStateType - accountStatus - accountType - address - balanceAccount - balanceAccountActive - balanceAccountCode - balanceAccountId - bankAccount - bankAccountCode - bankAccountName - bankAccountUUID - bankBicSwift - bankCity - bankCode - bankName - bankStatement - branchCode - businessContact - cardToken - checkCode - city - companyRegistration - constitutionalDocument - controller - country - countryCode - currency - currencyCode - dateOfBirth - description - destinationAccountCode - document - documentContent - documentExpirationDate - documentIssuerCountry - documentIssuerState - documentName - documentNumber - documentType - doingBusinessAs - drivingLicence - drivingLicenceBack - drivingLicenceFront - drivingLicense - email - firstName - formType - fullPhoneNumber - gender - hopWebserviceUser - houseNumberOrName - iban - idCard - idCardBack - idCardFront - idNumber - identityDocument - individualDetails - infix - jobTitle - lastName - lastReviewDate - legalArrangement - legalArrangementCode - legalArrangementEntity - legalArrangementEntityCode - legalArrangementLegalForm - legalArrangementMember - legalArrangementMembers - legalArrangementName - legalArrangementReference - legalArrangementRegistrationNumber - legalArrangementTaxNumber - legalArrangementType - legalBusinessName - legalEntity - legalEntityType - logo - merchantAccount - merchantCategoryCode - merchantHouseNumber - merchantReference - microDeposit - name - nationality - originalReference - ownerCity - ownerCountryCode - ownerDateOfBirth - ownerHouseNumberOrName - ownerName - ownerPostalCode - ownerState - ownerStreet - passport - passportNumber - payoutMethod - payoutMethodCode - payoutSchedule - pciSelfAssessment - personalData - phoneCountryCode - phoneNumber - postalCode - primaryCurrency - reason - registrationNumber - returnUrl - schedule - shareholder - shareholderCode - shareholderCodeAndSignatoryCode - shareholderCodeOrSignatoryCode - shareholderType - shareholderTypes - shopperInteraction - signatory - signatoryCode - socialSecurityNumber - sourceAccountCode - splitAccount - splitConfigurationUUID - splitCurrency - splitValue - splits - stateOrProvince - status - stockExchange - stockNumber - stockTicker - store - storeDetail - storeName - storeReference - street - taxId - tier - tierNumber - transferCode - ultimateParentCompany - ultimateParentCompanyAddressDetails - ultimateParentCompanyAddressDetailsCountry - ultimateParentCompanyBusinessDetails - ultimateParentCompanyBusinessDetailsLegalBusinessName - ultimateParentCompanyBusinessDetailsRegistrationNumber - ultimateParentCompanyCode - ultimateParentCompanyStockExchange - ultimateParentCompanyStockNumber - ultimateParentCompanyStockNumberOrStockTicker - ultimateParentCompanyStockTicker - unknown - value - verificationType - virtualAccount - visaNumber - webAddress - year type: string shareholderCode: description: The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder. type: string 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 CloseStoresRequest: properties: accountHolderCode: description: The code of the account holder. type: string stores: description: List of stores to be closed. items: type: string type: array required: - accountHolderCode - stores 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 Links: properties: self: description: Link to the resource itself. $ref: '#/components/schemas/LinksElement' required: - self type: object StoreSplitConfiguration: properties: balanceAccountId: description: The [unique identifier of the balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id) to which the split amount must be booked, depending on the defined [split logic](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/splitConfigurations#request-rules-splitLogic). type: string splitConfigurationId: description: The unique identifier of the [split configuration profile](https://docs.adyen.com/marketplaces-and-platforms/automatic-split-configuration/create-split-configuration/). type: string 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 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 examples: post-stores-post-stores-200: summary: Response code - 200 OK description: Example response after creating a store value: id: YOUR_STORE_ID address: country: US line1: 200 Main Street line2: Building 5A line3: Suite 3 city: Springfield stateOrProvince: NY postalCode: '20250' description: City centre store merchantId: YOUR_MERCHANT_ACCOUNT_ID shopperStatement: Springfield Shop phoneNumber: '+1813702551707653' reference: Spring_store_2 status: active _links: self: href: https://management-test.adyen.com/v1/stores/YOUR_STORE_ID generic-403: summary: Response code 401. Forbidden. value: status: 403 errorCode: '10_003' message: Failed to authorize user errorType: security generic-400: summary: Response code 400. Bad Request. value: status: 400 errorCode: '702' message: 'Unexpected input: I' errorType: validation patch-stores-storeId-patch-stores-200: summary: Response code - 200 OK description: Example response after updating a store value: id: YOUR_STORE_ID address: country: US line1: 1776 West Pinewood Avenue line2: Heartland Building line3: '' city: Springfield stateOrProvince: NY postalCode: '20251' description: City centre store merchantId: YOUR_MERCHANT_ACCOUNT_ID shopperStatement: Springfield Shop phoneNumber: '+1813702551707653' reference: Spring_store_2 status: active _links: self: href: https://management-test.adyen.com/v1/stores/YOUR_STORE_ID get-stores-storeId-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 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 patch-stores-storeId-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 patch-stores-storeId-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-stores-storeId-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 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 patch-stores-storeId-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 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 get-stores-storeId-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 patch-stores-storeId-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 get-stores-success-200: summary: Response code - 200 OK description: Example response when getting a list of stores value: _links: first: href: https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_ID/stores?pageNumber=1&pageSize=1 last: href: https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_ID/stores?pageNumber=2&pageSize=1 next: href: https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_ID/stores?pageNumber=2&pageSize=1 self: href: https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_ID/stores?pageNumber=1&pageSize=1 itemsTotal: 2 pagesTotal: 1 data: - id: ST322LJ223223K5F4SQNR9XL5 address: city: Springfield country: US line1: 200 Main Street line2: Building 5A line3: Suite 3 postalCode: '20250' stateOrProvince: NY description: City centre store merchantId: YOUR_MERCHANT_ACCOUNT_ID phoneNumber: '+1813702551707653' reference: Springfield Shop status: active _links: self: href: https://management-test.adyen.com/v1/stores/ST322LJ223223K5F4SQNR9XL5 - id: ST322LJ223223K5F4SQNR9XL6 address: city: North Madison country: US line1: 1492 Townline Road line2: Rowland Business Park postalCode: '20577' stateOrProvince: NY description: West location merchantId: YOUR_MERCHANT_ACCOUNT_ID phoneNumber: '+1211992213193020' reference: Second Madison store status: active _links: self: href: https://management-test.adyen.com/v1/stores/ST322LJ223223K5F4SQNR9XL6 get-stores-storeId-success-200: summary: Response code - 200 OK description: Example response when getting the details of a store value: id: ST322LJ223223K5F4SQNR9XL5 address: city: Springfield country: US line1: 200 Main Street line2: Building 5A line3: Suite 3 postalCode: '20250' stateOrProvince: NY description: City centre store merchantId: YOUR_MERCHANT_ACCOUNT_ID phoneNumber: '+1813702551707653' reference: Springfield Shop status: active _links: self: href: https://management-test.adyen.com/v1/stores/ST322LJ223223K5F4SQNR9XL5 patch-stores-storeId-patch-stores-splitConfiguration: summary: Add split configuration to store description: Example request to add a split configuration to the store value: splitConfiguration: balanceAccountId: BA3227C223222H5HQ2XX77VVH splitConfigurationId: SCNF4224P22322585HPCX384JV6JGX patch-stores-storeId-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 patch-stores-storeId-patch-stores: summary: Update store address. description: Example request to update the address of a store value: address: line1: 1776 West Pinewood Avenue line2: Heartland Building line3: '' postalCode: '20251' patch-stores-storeId-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-stores-storeId-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-stores-post-stores: summary: Create a store description: Example request to create a store value: merchantId: YOUR_MERCHANT_ACCOUNT_ID description: City centre store shopperStatement: Springfield Shop phoneNumber: '+1813702551707653' reference: Spring_store_2 address: country: US line1: 200 Main Street line2: Building 5A line3: Suite 3 city: Springfield stateOrProvince: NY postalCode: '20250' securitySchemes: ApiKeyAuth: in: header name: X-API-Key type: apiKey BasicAuth: scheme: basic type: http x-groups: - Account holders - Accounts - Verification