{"note":"OpenAPI conversion -- returning structured metadata","name":"adyen-com-managementservice","description":"Management API","version":"1","base_url":"https://management-test.adyen.com/v1","endpoints":130,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Management API\n@base https://management-test.adyen.com/v1\n@version 1\n@auth ApiKey X-API-Key in header | Bearer basic\n@endpoints 130\n@hint download_for_search\n@toc companies(43), me(6), merchants(67), stores(8), terminals(6)\n\n@group companies\n@endpoint GET /companies\n@desc Get a list of company accounts\n@optional {pageNumber: int(int32) # The number of the page to fetch., pageSize: int(int32) # The number of items to have on a page, maximum 100. The default is 10 items on a page.}\n@returns(200) {_links: map{first: map{href: str}, last: map{href: str}, next: map{href: str}, prev: map{href: str}, self: map{href: str}}, data: [map], itemsTotal: int(int32), pagesTotal: int(int32)} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /companies/{companyId}\n@desc Get a company account\n@required {companyId: str # The unique identifier of the company account.}\n@returns(200) {_links: map{apiCredentials: map{href: str}, self: map{href: str}, users: map{href: str}, webhooks: map{href: str}}, dataCenters: [map], description: str, id: str, name: str, reference: str, status: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /companies/{companyId}/androidApps\n@desc Get a list of Android apps\n@required {companyId: str # The unique identifier of the company account.}\n@optional {pageNumber: int(int32) # The number of the page to fetch., pageSize: int(int32) # The number of items to have on a page, maximum 100. The default is 20 items on a page., packageName: str # The package name that uniquely identifies the Android app., versionCode: int(int32) # The version number of the app.}\n@returns(200) {data: [map]} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /companies/{companyId}/androidApps/{id}\n@desc Get Android app\n@required {companyId: str # The unique identifier of the company account., id: str # The unique identifier of the app.}\n@returns(200) {description: str, errorCode: str, id: str, label: str, packageName: str, status: str, versionCode: int(int32), versionName: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /companies/{companyId}/androidCertificates\n@desc Get a list of Android certificates\n@required {companyId: str # The unique identifier of the company account.}\n@optional {pageNumber: int(int32) # The number of the page to fetch., pageSize: int(int32) # The number of items to have on a page, maximum 100. The default is 20 items on a page., certificateName: str # The name of the certificate.}\n@returns(200) {data: [map]} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /companies/{companyId}/apiCredentials\n@desc Get a list of API credentials\n@required {companyId: str # The unique identifier of the company account.}\n@optional {pageNumber: int(int32) # The number of the page to fetch., pageSize: int(int32) # The number of items to have on a page, maximum 100. The default is 10 items on a page.}\n@returns(200) {_links: map{first: map{href: str}, last: map{href: str}, next: map{href: str}, prev: map{href: str}, self: map{href: str}}, data: [map], itemsTotal: int(int32), pagesTotal: int(int32)} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /companies/{companyId}/apiCredentials\n@desc Create an API credential.\n@required {companyId: str # The unique identifier of the company account.}\n@optional {allowedOrigins: [str] # List of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the new API credential., associatedMerchantAccounts: [str] # List of merchant accounts that the API credential has access to., description: str # Description of the API credential., roles: [str] # List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential. Only roles assigned to 'ws@Company.' can be assigned to other API credentials.}\n@returns(200) {_links: map{allowedOrigins: map{href: str}, company: map{href: str}, generateApiKey: map{href: str}, generateClientKey: map{href: str}, merchant: map{href: str}, self: map{href: str}}, active: bool, allowedIpAddresses: [str], allowedOrigins: [map], apiKey: str, associatedMerchantAccounts: [str], clientKey: str, description: str, id: str, password: str, roles: [str], username: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"roles\":[\"Checkout webservice role\"],\"allowedOrigins\":[\"https://www.mystore.com\"],\"associatedMerchantAccounts\":[\"YOUR_MERCHANT_ACCOUNT_AU\",\"YOUR_MERCHANT_ACCOUNT_EU\",\"YOUR_MERCHANT_ACCOUNT_US\"]}\n\n@endpoint GET /companies/{companyId}/apiCredentials/{apiCredentialId}\n@desc Get an API credential\n@required {companyId: str # The unique identifier of the company account., apiCredentialId: str # Unique identifier of the API credential.}\n@returns(200) {_links: map{allowedOrigins: map{href: str}, company: map{href: str}, generateApiKey: map{href: str}, generateClientKey: map{href: str}, merchant: map{href: str}, self: map{href: str}}, active: bool, allowedIpAddresses: [str], allowedOrigins: [map], associatedMerchantAccounts: [str], clientKey: str, description: str, id: str, roles: [str], username: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint PATCH /companies/{companyId}/apiCredentials/{apiCredentialId}\n@desc Update an API credential.\n@required {companyId: str # The unique identifier of the company account., apiCredentialId: str # Unique identifier of the API credential.}\n@optional {active: bool # Indicates if the API credential is enabled., allowedOrigins: [str] # The new list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential., associatedMerchantAccounts: [str] # List of merchant accounts that the API credential has access to., description: str # Description of the API credential., roles: [str] # List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential. Only roles assigned to 'ws@Company.' can be assigned to other API credentials.}\n@returns(200) {_links: map{allowedOrigins: map{href: str}, company: map{href: str}, generateApiKey: map{href: str}, generateClientKey: map{href: str}, merchant: map{href: str}, self: map{href: str}}, active: bool, allowedIpAddresses: [str], allowedOrigins: [map], associatedMerchantAccounts: [str], clientKey: str, description: str, id: str, roles: [str], username: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"active\":true}\n\n@endpoint GET /companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins\n@desc Get a list of allowed origins\n@required {companyId: str # The unique identifier of the company account., apiCredentialId: str # Unique identifier of the API credential.}\n@returns(200) {data: [map]} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins\n@desc Create an allowed origin\n@required {companyId: str # The unique identifier of the company account., apiCredentialId: str # Unique identifier of the API credential., domain: str # Domain of the allowed origin.}\n@optional {_links: map{self!: map}, id: str # Unique identifier of the allowed origin.}\n@returns(200) {_links: map{self: map{href: str}}, domain: str, id: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"domain\":\"https://www.eu.mystore.com\"}\n\n@endpoint DELETE /companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}\n@desc Delete an allowed origin\n@required {companyId: str # The unique identifier of the company account., apiCredentialId: str # Unique identifier of the API credential., originId: str # Unique identifier of the allowed origin.}\n@returns(204) No Content - look at the actual response code for the status of the request.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}\n@desc Get an allowed origin\n@required {companyId: str # The unique identifier of the company account., apiCredentialId: str # Unique identifier of the API credential., originId: str # Unique identifier of the allowed origin.}\n@returns(200) {_links: map{self: map{href: str}}, domain: str, id: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /companies/{companyId}/apiCredentials/{apiCredentialId}/generateApiKey\n@desc Generate new API key\n@required {companyId: str # The unique identifier of the company account., apiCredentialId: str # Unique identifier of the API credential.}\n@returns(200) {apiKey: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /companies/{companyId}/apiCredentials/{apiCredentialId}/generateClientKey\n@desc Generate new client key\n@required {companyId: str # The unique identifier of the company account., apiCredentialId: str # Unique identifier of the API credential.}\n@returns(200) {clientKey: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /companies/{companyId}/billingEntities\n@desc Get a list of billing entities\n@required {companyId: str # The unique identifier of the company account.}\n@optional {name: str # The name of the billing entity.}\n@returns(200) {data: [map]} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /companies/{companyId}/merchants\n@desc Get a list of merchant accounts\n@required {companyId: str # The unique identifier of the company account.}\n@optional {pageNumber: int(int32) # The number of the page to fetch., pageSize: int(int32) # The number of items to have on a page, maximum 100. The default is 10 items on a page.}\n@returns(200) {_links: map{first: map{href: str}, last: map{href: str}, next: map{href: str}, prev: map{href: str}, self: map{href: str}}, data: [map], itemsTotal: int(int32), pagesTotal: int(int32)} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /companies/{companyId}/shippingLocations\n@desc Get a list of shipping locations\n@required {companyId: str # The unique identifier of the company account.}\n@optional {name: str # The name of the shipping location., offset: int(int32) # The number of locations to skip., limit: int(int32) # The number of locations to return.}\n@returns(200) {data: [map]} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /companies/{companyId}/shippingLocations\n@desc Create a shipping location\n@required {companyId: str # The unique identifier of the company account.}\n@optional {address: map{city: str, companyName: str, country: str, postalCode: str, stateOrProvince: str, streetAddress: str, streetAddress2: str}, contact: map{email: str, firstName: str, infix: str, lastName: str, phoneNumber: str}, id: str # The unique identifier of the shipping location, for use as `shippingLocationId` when creating an order., name: str # The unique name of the shipping location.}\n@returns(200) {address: map{city: str, companyName: str, country: str, postalCode: str, stateOrProvince: str, streetAddress: str, streetAddress2: str}, contact: map{email: str, firstName: str, infix: str, lastName: str, phoneNumber: str}, id: str, name: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"name\":\"YOUR_COMPANY Rokin depot\",\"address\":{\"companyName\":\"YOUR_COMPANY\",\"streetAddress\":\"Rokin 21\",\"postalCode\":\"1012 KS\",\"city\":\"Amsterdam\",\"stateOrProvince\":\"\",\"country\":\"NL\"},\"contact\":{\"firstName\":\"Paul\",\"lastName\":\"Green\",\"phoneNumber\":\"+31 020 1234567\",\"email\":\"Paul.Green@company.com\"}}\n\n@endpoint GET /companies/{companyId}/terminalActions\n@desc Get a list of terminal actions\n@required {companyId: str # The unique identifier of the company account.}\n@optional {pageNumber: int(int32) # The number of the page to fetch., pageSize: int(int32) # The number of items to have on a page, maximum 100. The default is 20 items on a page., status: str # Returns terminal actions with the specified status.  Allowed values: **pending**, **successful**, **failed**, **cancelled**, **tryLater**., type: str # Returns terminal actions of the specified type.  Allowed values: **InstallAndroidApp**, **UninstallAndroidApp**, **InstallAndroidCertificate**, **UninstallAndroidCertificate**.}\n@returns(200) {data: [map]} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /companies/{companyId}/terminalActions/{actionId}\n@desc Get terminal action\n@required {companyId: str # The unique identifier of the company account., actionId: str # The unique identifier of the terminal action.}\n@returns(200) {actionType: str, config: str, confirmedAt: str(date-time), id: str, result: str, scheduledAt: str(date-time), status: str, terminalId: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /companies/{companyId}/terminalLogos\n@desc Get the terminal logo\n@required {companyId: str # The unique identifier of the company account., model: str # 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.}\n@returns(200) {data: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint PATCH /companies/{companyId}/terminalLogos\n@desc Update the terminal logo\n@required {companyId: str # The unique identifier of the company account., model: str # 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.}\n@optional {data: str # The image file, converted to a Base64-encoded string, of the logo to be shown on the terminal.}\n@returns(200) {data: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"data\":\"\"}\n\n@endpoint GET /companies/{companyId}/terminalModels\n@desc Get a list of terminal models\n@required {companyId: str # The unique identifier of the company account.}\n@returns(200) {data: [map]} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /companies/{companyId}/terminalOrders\n@desc Get a list of orders\n@required {companyId: str # The unique identifier of the company account.}\n@optional {customerOrderReference: str # Your purchase order number., status: str # The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered., offset: int(int32) # The number of orders to skip., limit: int(int32) # The number of orders to return.}\n@returns(200) {data: [map]} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /companies/{companyId}/terminalOrders\n@desc Create an order\n@required {companyId: str # The unique identifier of the company account.}\n@optional {billingEntityId: str # The identification of the billing entity to use for the order.    > When ordering products in Brazil, you do not need to include the `billingEntityId` in the request., customerOrderReference: str # The merchant-defined purchase order reference., items: [map{id: str, installments: int(int64), name: str, quantity: int(int32)}] # The products included in the order., orderType: str # Type of order, shippingLocationId: str # The identification of the shipping location to use for the order., taxId: str # The tax number of the billing entity.}\n@returns(200) {billingEntity: map{address: map{city: str, companyName: str, country: str, postalCode: str, stateOrProvince: str, streetAddress: str, streetAddress2: str}, email: str, id: str, name: str, taxId: str}, customerOrderReference: str, id: str, items: [map], orderDate: str, shippingLocation: map{address: map{city: str, companyName: str, country: str, postalCode: str, stateOrProvince: str, streetAddress: str, streetAddress2: str}, contact: map{email: str, firstName: str, infix: str, lastName: str, phoneNumber: str}, id: str, name: str}, status: str, trackingUrl: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"customerOrderReference\":\"YOUR_REFERENCE\",\"shippingLocationId\":\"S2-6A6C2E3432747D4F2F2C3455485E3836457D\",\"billingEntityId\":\"Company.YOUR_COMPANY\",\"items\":[{\"id\":\"TBOX-V400m-684-EU\",\"name\":\"V400m Package\",\"quantity\":1},{\"id\":\"PART-175746-EU\",\"name\":\"Adyen Test Card\",\"quantity\":1}]}\n\n@endpoint GET /companies/{companyId}/terminalOrders/{orderId}\n@desc Get an order\n@required {companyId: str # The unique identifier of the company account., orderId: str # The unique identifier of the order.}\n@returns(200) {billingEntity: map{address: map{city: str, companyName: str, country: str, postalCode: str, stateOrProvince: str, streetAddress: str, streetAddress2: str}, email: str, id: str, name: str, taxId: str}, customerOrderReference: str, id: str, items: [map], orderDate: str, shippingLocation: map{address: map{city: str, companyName: str, country: str, postalCode: str, stateOrProvince: str, streetAddress: str, streetAddress2: str}, contact: map{email: str, firstName: str, infix: str, lastName: str, phoneNumber: str}, id: str, name: str}, status: str, trackingUrl: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint PATCH /companies/{companyId}/terminalOrders/{orderId}\n@desc Update an order\n@required {companyId: str # The unique identifier of the company account., orderId: str # The unique identifier of the order.}\n@optional {billingEntityId: str # The identification of the billing entity to use for the order.    > When ordering products in Brazil, you do not need to include the `billingEntityId` in the request., customerOrderReference: str # The merchant-defined purchase order reference., items: [map{id: str, installments: int(int64), name: str, quantity: int(int32)}] # The products included in the order., orderType: str # Type of order, shippingLocationId: str # The identification of the shipping location to use for the order., taxId: str # The tax number of the billing entity.}\n@returns(200) {billingEntity: map{address: map{city: str, companyName: str, country: str, postalCode: str, stateOrProvince: str, streetAddress: str, streetAddress2: str}, email: str, id: str, name: str, taxId: str}, customerOrderReference: str, id: str, items: [map], orderDate: str, shippingLocation: map{address: map{city: str, companyName: str, country: str, postalCode: str, stateOrProvince: str, streetAddress: str, streetAddress2: str}, contact: map{email: str, firstName: str, infix: str, lastName: str, phoneNumber: str}, id: str, name: str}, status: str, trackingUrl: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"items\":[{\"id\":\"TBOX-V400m-684-EU\",\"name\":\"V400m Package\",\"quantity\":1},{\"id\":\"PART-175746-EU\",\"name\":\"Adyen Test Card\",\"quantity\":1},{\"id\":\"PART-620222-EU\",\"name\":\"Receipt Roll\",\"quantity\":5}]}\n\n@endpoint POST /companies/{companyId}/terminalOrders/{orderId}/cancel\n@desc Cancel an order\n@required {companyId: str # The unique identifier of the company account., orderId: str # The unique identifier of the order.}\n@returns(200) {billingEntity: map{address: map{city: str, companyName: str, country: str, postalCode: str, stateOrProvince: str, streetAddress: str, streetAddress2: str}, email: str, id: str, name: str, taxId: str}, customerOrderReference: str, id: str, items: [map], orderDate: str, shippingLocation: map{address: map{city: str, companyName: str, country: str, postalCode: str, stateOrProvince: str, streetAddress: str, streetAddress2: str}, contact: map{email: str, firstName: str, infix: str, lastName: str, phoneNumber: str}, id: str, name: str}, status: str, trackingUrl: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /companies/{companyId}/terminalProducts\n@desc Get a list of terminal products\n@required {companyId: str # The unique identifier of the company account., country: str # The country to return products for, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US**}\n@optional {terminalModelId: str # The terminal model to return products for. Use the ID returned in the [GET `/terminalModels`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/companies/{companyId}/terminalModels) response. For example, **Verifone.M400**, offset: int(int32) # The number of products to skip., limit: int(int32) # The number of products to return.}\n@returns(200) {data: [map]} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /companies/{companyId}/terminalSettings\n@desc Get terminal settings\n@required {companyId: str # The unique identifier of the company account.}\n@returns(200) {cardholderReceipt: map{headerForAuthorizedReceipt: str}, connectivity: map{simcardStatus: str, terminalIPAddressURL: map{eventLocalUrls: [map], eventPublicUrls: [map]}}, gratuities: [map]?, hardware: map{displayMaximumBackLight: int(int32), resetTotalsHour: int(int32), restartHour: int(int32)}, homeScreen: map{hideNavigationBar: bool, showPaymentsMenu: bool, showSettingsMenu: bool}, kioskMode: map{allowedAppsInKioskMode: [str], kioskAppOnStartup: str}, localization: map{language: str, secondaryLanguage: str, timezone: str}, moto: map{enableMoto: bool, maxAmount: int(int32)}, nexo: map{displayUrls: map{localUrls: [map], publicUrls: [map]}, encryptionKey: map{identifier: str, passphrase: str, version: int(int32)}, eventUrls: map{eventLocalUrls: [map], eventPublicUrls: [map]}, nexoEventUrls: [str], notification: map{category: str, details: str, enabled: bool, showButton: bool, title: str}}, offlineProcessing: map{chipFloorLimit: int(int32), offlineSwipeLimits: [map]}, opi: map{enablePayAtTable: bool, payAtTableStoreNumber: str, payAtTableURL: str}, passcodes: map{adminMenuPin: str, refundPin: str, screenLockPin: str, txMenuPin: str}, payAtTable: map{authenticationMethod: str, enablePayAtTable: bool, paymentInstrument: str?}, payment: map{contactlessCurrency: str, hideMinorUnitsInCurrencies: [str]}, receiptOptions: map{logo: str, promptBeforePrinting: bool, qrCodeData: str}, receiptPrinting: map{merchantApproved: bool, merchantCancelled: bool, merchantCaptureApproved: bool, merchantCaptureRefused: bool, merchantRefundApproved: bool, merchantRefundRefused: bool, merchantRefused: bool, merchantVoid: bool, shopperApproved: bool, shopperCancelled: bool, shopperCaptureApproved: bool, shopperCaptureRefused: bool, shopperRefundApproved: bool, shopperRefundRefused: bool, shopperRefused: bool, shopperVoid: bool}, refunds: map{referenced: map{enableStandaloneRefunds: bool}, unreferenced: map{enableUnreferencedRefunds: bool}}, signature: map{askSignatureOnScreen: bool, deviceName: str, deviceSlogan: str, skipSignature: bool}, standalone: map{currencyCode: str, enableGratuities: bool, enableStandalone: bool}, storeAndForward: map{maxAmount: [map], maxPayments: int(int32), supportedCardTypes: map{credit: bool, debit: bool, deferredDebit: bool, prepaid: bool, unknown: bool}}, surcharge: map{askConfirmation: bool, configurations: [map], excludeGratuityFromSurcharge: bool}, tapToPay: map{merchantDisplayName: str}, terminalInstructions: map{adyenAppRestart: bool}, timeouts: map{fromActiveToSleep: int(int32)}, wifiProfiles: map{profiles: [map], settings: map{band: str, roaming: bool, timeout: int(int32)}}} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint PATCH /companies/{companyId}/terminalSettings\n@desc Update terminal settings\n@required {companyId: str # The unique identifier of the company account.}\n@optional {cardholderReceipt: map{headerForAuthorizedReceipt: str}, connectivity: map{simcardStatus: str, terminalIPAddressURL: map}, gratuities: [map{allowCustomAmount: bool, currency: str, predefinedTipEntries: [str], usePredefinedTipEntries: bool}] # 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., hardware: map{displayMaximumBackLight: int(int32), resetTotalsHour: int(int32), restartHour: int(int32)}, homeScreen: map{hideNavigationBar: bool, showPaymentsMenu: bool, showSettingsMenu: bool}, kioskMode: map{allowedAppsInKioskMode: [str], kioskAppOnStartup: str}, localization: map{language: str, secondaryLanguage: str, timezone: str}, moto: map{enableMoto: bool, maxAmount: int(int32)}, nexo: map{displayUrls: map, encryptionKey: map, eventUrls: map, nexoEventUrls: [str], notification: map}, offlineProcessing: map{chipFloorLimit: int(int32), offlineSwipeLimits: [map]}, opi: map{enablePayAtTable: bool, payAtTableStoreNumber: str, payAtTableURL: str}, passcodes: map{adminMenuPin: str, refundPin: str, screenLockPin: str, txMenuPin: str}, payAtTable: map{authenticationMethod: str, enablePayAtTable: bool, paymentInstrument: str}, payment: map{contactlessCurrency: str, hideMinorUnitsInCurrencies: [str]}, receiptOptions: map{logo: str, promptBeforePrinting: bool, qrCodeData: str}, receiptPrinting: map{merchantApproved: bool, merchantCancelled: bool, merchantCaptureApproved: bool, merchantCaptureRefused: bool, merchantRefundApproved: bool, merchantRefundRefused: bool, merchantRefused: bool, merchantVoid: bool, shopperApproved: bool, shopperCancelled: bool, shopperCaptureApproved: bool, shopperCaptureRefused: bool, shopperRefundApproved: bool, shopperRefundRefused: bool, shopperRefused: bool, shopperVoid: bool}, refunds: map{referenced: map, unreferenced: map}, signature: map{askSignatureOnScreen: bool, deviceName: str, deviceSlogan: str, skipSignature: bool}, standalone: map{currencyCode: str, enableGratuities: bool, enableStandalone: bool}, storeAndForward: map{maxAmount: [map], maxPayments: int(int32), supportedCardTypes: map}, surcharge: map{askConfirmation: bool, configurations: [map], excludeGratuityFromSurcharge: bool}, tapToPay: map{merchantDisplayName: str}, terminalInstructions: map{adyenAppRestart: bool}, timeouts: map{fromActiveToSleep: int(int32)}, wifiProfiles: map{profiles: [map], settings: map}}\n@returns(200) {cardholderReceipt: map{headerForAuthorizedReceipt: str}, connectivity: map{simcardStatus: str, terminalIPAddressURL: map{eventLocalUrls: [map], eventPublicUrls: [map]}}, gratuities: [map]?, hardware: map{displayMaximumBackLight: int(int32), resetTotalsHour: int(int32), restartHour: int(int32)}, homeScreen: map{hideNavigationBar: bool, showPaymentsMenu: bool, showSettingsMenu: bool}, kioskMode: map{allowedAppsInKioskMode: [str], kioskAppOnStartup: str}, localization: map{language: str, secondaryLanguage: str, timezone: str}, moto: map{enableMoto: bool, maxAmount: int(int32)}, nexo: map{displayUrls: map{localUrls: [map], publicUrls: [map]}, encryptionKey: map{identifier: str, passphrase: str, version: int(int32)}, eventUrls: map{eventLocalUrls: [map], eventPublicUrls: [map]}, nexoEventUrls: [str], notification: map{category: str, details: str, enabled: bool, showButton: bool, title: str}}, offlineProcessing: map{chipFloorLimit: int(int32), offlineSwipeLimits: [map]}, opi: map{enablePayAtTable: bool, payAtTableStoreNumber: str, payAtTableURL: str}, passcodes: map{adminMenuPin: str, refundPin: str, screenLockPin: str, txMenuPin: str}, payAtTable: map{authenticationMethod: str, enablePayAtTable: bool, paymentInstrument: str?}, payment: map{contactlessCurrency: str, hideMinorUnitsInCurrencies: [str]}, receiptOptions: map{logo: str, promptBeforePrinting: bool, qrCodeData: str}, receiptPrinting: map{merchantApproved: bool, merchantCancelled: bool, merchantCaptureApproved: bool, merchantCaptureRefused: bool, merchantRefundApproved: bool, merchantRefundRefused: bool, merchantRefused: bool, merchantVoid: bool, shopperApproved: bool, shopperCancelled: bool, shopperCaptureApproved: bool, shopperCaptureRefused: bool, shopperRefundApproved: bool, shopperRefundRefused: bool, shopperRefused: bool, shopperVoid: bool}, refunds: map{referenced: map{enableStandaloneRefunds: bool}, unreferenced: map{enableUnreferencedRefunds: bool}}, signature: map{askSignatureOnScreen: bool, deviceName: str, deviceSlogan: str, skipSignature: bool}, standalone: map{currencyCode: str, enableGratuities: bool, enableStandalone: bool}, storeAndForward: map{maxAmount: [map], maxPayments: int(int32), supportedCardTypes: map{credit: bool, debit: bool, deferredDebit: bool, prepaid: bool, unknown: bool}}, surcharge: map{askConfirmation: bool, configurations: [map], excludeGratuityFromSurcharge: bool}, tapToPay: map{merchantDisplayName: str}, terminalInstructions: map{adyenAppRestart: bool}, timeouts: map{fromActiveToSleep: int(int32)}, wifiProfiles: map{profiles: [map], settings: map{band: str, roaming: bool, timeout: int(int32)}}} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"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}}}\n\n@endpoint GET /companies/{companyId}/users\n@desc Get a list of users\n@required {companyId: str # The unique identifier of the company account.}\n@optional {pageNumber: int(int32) # The number of the page to return., pageSize: int(int32) # The number of items to have on a page. Maximum value is **100**. The default is **10** items on a page., username: str # The partial or complete username to select all users that match.}\n@returns(200) {_links: map{first: map{href: str}, last: map{href: str}, next: map{href: str}, prev: map{href: str}, self: map{href: str}}, data: [map], itemsTotal: int(int32), pagesTotal: int(int32)} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /companies/{companyId}/users\n@desc Create a new user\n@required {companyId: str # The unique identifier of the company account., email: str # The email address of the user., name: map{firstName!: str, lastName!: str}, username: str # The user's email address that will be their username. Must be the same as the one in the `email` field.}\n@optional {accountGroups: [str] # The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user., associatedMerchantAccounts: [str] # The list of [merchant accounts](https://docs.adyen.com/account/account-structure#merchant-accounts) associated with this user., loginMethod: str # The requested login method for the user. To use SSO, you must already have SSO configured with Adyen before creating the user.  Possible values: **Username & account**, **Email**, or **SSO**, roles: [str] # The list of [roles](https://docs.adyen.com/account/user-roles) for this user., timeZoneCode: str # The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.}\n@returns(200) {_links: map{self: map{href: str}}, accountGroups: [str], active: bool, apps: [str], associatedMerchantAccounts: [str], email: str, id: str, name: map{firstName: str, lastName: str}, roles: [str], timeZoneCode: str, username: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"name\":{\"firstName\":\"John\",\"lastName\":\"Smith\"},\"username\":\"johnsmith\",\"email\":\"john.smith@example.com\",\"loginMethod\":\"Email\",\"timeZoneCode\":\"Europe/Amsterdam\",\"roles\":[\"Merchant standard role\",\"Merchant admin\"],\"associatedMerchantAccounts\":[\"YOUR_MERCHANT_ACCOUNT\"]}\n\n@endpoint GET /companies/{companyId}/users/{userId}\n@desc Get user details\n@required {companyId: str # The unique identifier of the company account., userId: str # The unique identifier of the user.}\n@returns(200) {_links: map{self: map{href: str}}, accountGroups: [str], active: bool, apps: [str], associatedMerchantAccounts: [str], email: str, id: str, name: map{firstName: str, lastName: str}, roles: [str], timeZoneCode: str, username: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint PATCH /companies/{companyId}/users/{userId}\n@desc Update user details\n@required {companyId: str # The unique identifier of the company account., userId: str # The unique identifier of the user.}\n@optional {accountGroups: [str] # The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user., active: bool # Indicates whether this user is active., associatedMerchantAccounts: [str] # The list of [merchant accounts](https://docs.adyen.com/account/account-structure#merchant-accounts) to associate the user with., email: str # The email address of the user., loginMethod: str # The requested login method for the user. To use SSO, you must already have SSO configured with Adyen before creating the user.  Possible values: **Username & account**, **Email**, or **SSO**, name: map{firstName: str, lastName: str}, roles: [str] # The list of [roles](https://docs.adyen.com/account/user-roles) for this user., timeZoneCode: str # The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.}\n@returns(200) {_links: map{self: map{href: str}}, accountGroups: [str], active: bool, apps: [str], associatedMerchantAccounts: [str], email: str, id: str, name: map{firstName: str, lastName: str}, roles: [str], timeZoneCode: str, username: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /companies/{companyId}/webhooks\n@desc List all webhooks\n@required {companyId: str # Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account).}\n@optional {pageNumber: int(int32) # The number of the page to fetch., pageSize: int(int32) # The number of items to have on a page, maximum 100. The default is 10 items on a page.}\n@returns(200) {_links: map{first: map{href: str}, last: map{href: str}, next: map{href: str}, prev: map{href: str}, self: map{href: str}}, accountReference: str, data: [map], itemsTotal: int(int32), pagesTotal: int(int32)} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /companies/{companyId}/webhooks\n@desc Set up a webhook\n@required {companyId: str # Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account)., active: bool # Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account., communicationFormat: str(http/json/soap) # Format or protocol for receiving webhooks. Possible values: * **soap** * **http** * **json**, filterMerchantAccountType: str(allAccounts/excludeAccounts/includeAccounts) # Shows how merchant accounts are filtered when configuring the webhook.   Possible values: *  **allAccounts** : Includes all merchant accounts, and does not require specifying `filterMerchantAccounts`. *  **includeAccounts** : The webhook is configured for the merchant accounts listed in `filterMerchantAccounts`. *  **excludeAccounts** : The webhook is not configured for the merchant accounts listed in `filterMerchantAccounts`., filterMerchantAccounts: [str] # A list of merchant account names that are included or excluded from receiving the webhook. Inclusion or exclusion is based on the value defined for `filterMerchantAccountType`.  Required if `filterMerchantAccountType` is either: * **includeAccounts** * **excludeAccounts**  Not needed for `filterMerchantAccountType`: **allAccounts**., type: str # The type of webhook that is being created. Possible values are:  - **standard** - **account-settings-notification** - **banktransfer-notification** - **boletobancario-notification** - **directdebit-notification** - **ach-notification-of-change-notification** - **direct-debit-notice-of-change-notification** - **pending-notification** - **ideal-notification** - **ideal-pending-notification** - **report-notification** - **rreq-notification** - **terminal-settings** - **terminal-boarding**  Find out more about [standard webhooks](https://docs.adyen.com/development-resources/webhooks/webhook-types/#event-codes) and [other types of webhooks](https://docs.adyen.com/development-resources/webhooks/webhook-types/#other-webhooks)., url: str # Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.}\n@optional {acceptsExpiredCertificate: bool # Indicates if expired SSL certificates are accepted. Default value: **false**., acceptsSelfSignedCertificate: bool # Indicates if self-signed SSL certificates are accepted. Default value: **false**., acceptsUntrustedRootCertificate: bool # Indicates if untrusted SSL certificates are accepted. Default value: **false**., additionalSettings: map{includeEventCodes: [str], properties: map}, description: str # Your description for this webhook configuration., networkType: str(local/public) # Network type for Terminal API notification webhooks. Possible values: * **public** * **local**  Default Value: **public**., password: str # Password to access the webhook URL., populateSoapActionHeader: bool # Indicates if the SOAP action header needs to be populated. Default value: **false**.  Only applies if `communicationFormat`: **soap**., sslVersion: str(HTTP/TLSv1.2/TLSv1.3) # SSL version to access the public webhook URL specified in the `url` field. Possible values: * **TLSv1.3** * **TLSv1.2** * **HTTP** - Only allowed on Test environment.  If not specified, the webhook will use `sslVersion`: **TLSv1.2**., username: str # Username to access the webhook URL.}\n@returns(200) {_links: map{company: map{href: str}, generateHmac: map{href: str}, merchant: map{href: str}, self: map{href: str}, testWebhook: map{href: str}}, acceptsExpiredCertificate: bool, acceptsSelfSignedCertificate: bool, acceptsUntrustedRootCertificate: bool, accountReference: str, active: bool, additionalSettings: map{excludeEventCodes: [str], includeEventCodes: [str], properties: map}, certificateAlias: str, communicationFormat: str, description: str, filterMerchantAccountType: str, filterMerchantAccounts: [str], hasError: bool, hasPassword: bool, hmacKeyCheckValue: str, id: str, networkType: str, populateSoapActionHeader: bool, sslVersion: str, type: str, url: str, username: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"type\":\"standard\",\"url\":\"YOUR_WEBHOOK_URL\",\"username\":\"YOUR_USER\",\"password\":\"YOUR_PASSWORD\",\"active\":true,\"sslVersion\":\"TLSv1.2\",\"communicationFormat\":\"soap\",\"acceptsExpiredCertificate\":false,\"acceptsSelfSignedCertificate\":true,\"acceptsUntrustedRootCertificate\":true,\"populateSoapActionHeader\":false,\"filterMerchantAccountType\":\"includeAccounts\",\"filterMerchantAccounts\":[\"YOUR_MERCHANT_ACCOUNT\"]}\n\n@endpoint DELETE /companies/{companyId}/webhooks/{webhookId}\n@desc Remove a webhook\n@required {companyId: str # The unique identifier of the company account., webhookId: str # Unique identifier of the webhook configuration.}\n@returns(204) No Content - look at the actual response code for the status of the request.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /companies/{companyId}/webhooks/{webhookId}\n@desc Get a webhook\n@required {companyId: str # Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account)., webhookId: str # Unique identifier of the webhook configuration.}\n@returns(200) {_links: map{company: map{href: str}, generateHmac: map{href: str}, merchant: map{href: str}, self: map{href: str}, testWebhook: map{href: str}}, acceptsExpiredCertificate: bool, acceptsSelfSignedCertificate: bool, acceptsUntrustedRootCertificate: bool, accountReference: str, active: bool, additionalSettings: map{excludeEventCodes: [str], includeEventCodes: [str], properties: map}, certificateAlias: str, communicationFormat: str, description: str, filterMerchantAccountType: str, filterMerchantAccounts: [str], hasError: bool, hasPassword: bool, hmacKeyCheckValue: str, id: str, networkType: str, populateSoapActionHeader: bool, sslVersion: str, type: str, url: str, username: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint PATCH /companies/{companyId}/webhooks/{webhookId}\n@desc Update a webhook\n@required {companyId: str # The unique identifier of the company account., webhookId: str # Unique identifier of the webhook configuration.}\n@optional {acceptsExpiredCertificate: bool # Indicates if expired SSL certificates are accepted. Default value: **false**., acceptsSelfSignedCertificate: bool # Indicates if self-signed SSL certificates are accepted. Default value: **false**., acceptsUntrustedRootCertificate: bool # Indicates if untrusted SSL certificates are accepted. Default value: **false**., active: bool # Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account., additionalSettings: map{includeEventCodes: [str], properties: map}, communicationFormat: str(http/json/soap) # Format or protocol for receiving webhooks. Possible values: * **soap** * **http** * **json**, description: str # Your description for this webhook configuration., filterMerchantAccountType: str(allAccounts/excludeAccounts/includeAccounts) # Shows how merchant accounts are filtered when configuring the webhook. Possible values: * **includeAccounts**: The webhook is configured for the merchant accounts listed in `filterMerchantAccounts`. * **excludeAccounts**: The webhook is not configured for the merchant accounts listed in `filterMerchantAccounts`. * **allAccounts**: Includes all merchant accounts, and does not require specifying `filterMerchantAccounts`., filterMerchantAccounts: [str] # A list of merchant account names that are included or excluded from receiving the webhook. Inclusion or exclusion is based on the value defined for `filterMerchantAccountType`.  Required if `filterMerchantAccountType` is either: * **includeAccounts** * **excludeAccounts**  Not needed for `filterMerchantAccountType`: **allAccounts**., networkType: str(local/public) # Network type for Terminal API notification webhooks. Possible values: * **public** * **local**  Default Value: **public**., password: str # Password to access the webhook URL., populateSoapActionHeader: bool # Indicates if the SOAP action header needs to be populated. Default value: **false**.  Only applies if `communicationFormat`: **soap**., sslVersion: str(HTTP/TLSv1.2/TLSv1.3) # SSL version to access the public webhook URL specified in the `url` field. Possible values: * **TLSv1.3** * **TLSv1.2** * **HTTP** - Only allowed on Test environment.  If not specified, the webhook will use `sslVersion`: **TLSv1.2**., url: str # Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**., username: str # Username to access the webhook URL.}\n@returns(200) {_links: map{company: map{href: str}, generateHmac: map{href: str}, merchant: map{href: str}, self: map{href: str}, testWebhook: map{href: str}}, acceptsExpiredCertificate: bool, acceptsSelfSignedCertificate: bool, acceptsUntrustedRootCertificate: bool, accountReference: str, active: bool, additionalSettings: map{excludeEventCodes: [str], includeEventCodes: [str], properties: map}, certificateAlias: str, communicationFormat: str, description: str, filterMerchantAccountType: str, filterMerchantAccounts: [str], hasError: bool, hasPassword: bool, hmacKeyCheckValue: str, id: str, networkType: str, populateSoapActionHeader: bool, sslVersion: str, type: str, url: str, username: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"active\":true}\n\n@endpoint POST /companies/{companyId}/webhooks/{webhookId}/generateHmac\n@desc Generate an HMAC key\n@required {companyId: str # The unique identifier of the company account., webhookId: str # Unique identifier of the webhook configuration.}\n@returns(200) {hmacKey: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /companies/{companyId}/webhooks/{webhookId}/test\n@desc Test a webhook\n@required {companyId: str # The unique identifier of the company account., webhookId: str # Unique identifier of the webhook configuration.}\n@optional {merchantIds: [str] # List of `merchantId` values for which test webhooks will be sent. The list can have a maximum of 20 `merchantId` values.  If not specified, we send sample notifications to all the merchant accounts that the webhook is configured for. If this is more than 20 merchant accounts, use this list to specify a subset of the merchant accounts for which to send test notifications., notification: map{amount: map, eventCode: str, eventDate: str(date-time), merchantReference: str, paymentMethod: str, reason: str, success: bool}, types: [str] # List of event codes for which to send test notifications. Only the webhook types below are supported.   Possible values if webhook `type`: **standard**:  * **AUTHORISATION** * **CHARGEBACK_REVERSED** * **ORDER_CLOSED** * **ORDER_OPENED** * **PAIDOUT_REVERSED** * **PAYOUT_THIRDPARTY** * **REFUNDED_REVERSED** * **REFUND_WITH_DATA** * **REPORT_AVAILABLE** * **CUSTOM** - set your custom notification fields in the [`notification`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/webhooks/{webhookId}/test__reqParam_notification) object.  Possible values if webhook `type`: **banktransfer-notification**:  * **PENDING**  Possible values if webhook `type`: **report-notification**:  * **REPORT_AVAILABLE**  Possible values if webhook `type`: **ideal-notification**:  * **AUTHORISATION**  Possible values if webhook `type`: **pending-notification**:  * **PENDING**}\n@returns(200) {data: [map]} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"merchantIds\":[\"YOUR_MERCHANT_ACCOUNT\"],\"types\":[\"AUTHORISATION\"]}\n\n@endgroup\n\n@group me\n@endpoint GET /me\n@desc Get API credential details\n@returns(200) {_links: map{allowedOrigins: map{href: str}, company: map{href: str}, generateApiKey: map{href: str}, generateClientKey: map{href: str}, merchant: map{href: str}, self: map{href: str}}, active: bool, allowedIpAddresses: [str], allowedOrigins: [map], clientKey: str, companyName: str, description: str, id: str, roles: [str], username: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /me/allowedOrigins\n@desc Get allowed origins\n@returns(200) {data: [map]} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /me/allowedOrigins\n@desc Add allowed origin\n@required {domain: str # Domain of the allowed origin.}\n@optional {_links: map{self!: map}, id: str # Unique identifier of the allowed origin.}\n@returns(200) {_links: map{self: map{href: str}}, domain: str, id: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint DELETE /me/allowedOrigins/{originId}\n@desc Remove allowed origin\n@required {originId: str # Unique identifier of the allowed origin.}\n@returns(204) No Content - look at the actual response code for the status of the request.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /me/allowedOrigins/{originId}\n@desc Get allowed origin details\n@required {originId: str # Unique identifier of the allowed origin.}\n@returns(200) {_links: map{self: map{href: str}}, domain: str, id: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /me/generateClientKey\n@desc Generate a client key\n@returns(200) {clientKey: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endgroup\n\n@group merchants\n@endpoint GET /merchants\n@desc Get a list of merchant accounts\n@optional {pageNumber: int(int32) # The number of the page to fetch., pageSize: int(int32) # The number of items to have on a page, maximum 100. The default is 10 items on a page.}\n@returns(200) {_links: map{first: map{href: str}, last: map{href: str}, next: map{href: str}, prev: map{href: str}, self: map{href: str}}, data: [map], itemsTotal: int(int32), pagesTotal: int(int32)} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /merchants\n@desc Create a merchant account\n@required {companyId: str # The unique identifier of the company account.}\n@optional {businessLineId: str # The unique identifier of the [business line](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines). Required for an Adyen for Platforms Manage integration., description: str # Your description for the merchant account, maximum 300 characters., legalEntityId: str # The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities). Required for an Adyen for Platforms Manage integration., pricingPlan: str # Sets the pricing plan for the merchant account. Required for an Adyen for Platforms Manage integration. Your Adyen contact will provide the values that you can use., reference: str # Your reference for the merchant account. To make this reference the unique identifier of the merchant account, your Adyen contact can set up a template on your company account. The template can have 6 to 255 characters with upper- and lower-case letters, underscores, and numbers. When your company account has a template, then the `reference` is required and must be unique within the company account., salesChannels: [str] # List of sales channels that the merchant will process payments with}\n@returns(200) {businessLineId: str, companyId: str, description: str, id: str, legalEntityId: str, pricingPlan: str, reference: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"companyId\":\"YOUR_COMPANY_ACCOUNT\",\"legalEntityId\":\"YOUR_LEGAL_ENTITY_ID\",\"businessLineId\":\"YOUR_BUSINESS_LINE_ID\",\"description\":\"YOUR_DESCRIPTION\",\"reference\":\"YOUR_OWN_REFERENCE\"}\n\n@endpoint GET /merchants/{merchantId}\n@desc Get a merchant account\n@required {merchantId: str # The unique identifier of the merchant account.}\n@returns(200) {_links: map{apiCredentials: map{href: str}, self: map{href: str}, users: map{href: str}, webhooks: map{href: str}}, captureDelay: str, companyId: str, dataCenters: [map], defaultShopperInteraction: str, description: str, id: str, merchantCity: str, name: str, pricingPlan: str, primarySettlementCurrency: str, reference: str, shopWebAddress: str, status: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /merchants/{merchantId}/activate\n@desc Request to activate a merchant account\n@required {merchantId: str # The unique identifier of the merchant account.}\n@returns(200) {companyId: str, merchantId: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /merchants/{merchantId}/apiCredentials\n@desc Get a list of API credentials\n@required {merchantId: str # The unique identifier of the merchant account.}\n@optional {pageNumber: int(int32) # The number of the page to fetch., pageSize: int(int32) # The number of items to have on a page, maximum 100. The default is 10 items on a page.}\n@returns(200) {_links: map{first: map{href: str}, last: map{href: str}, next: map{href: str}, prev: map{href: str}, self: map{href: str}}, data: [map], itemsTotal: int(int32), pagesTotal: int(int32)} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /merchants/{merchantId}/apiCredentials\n@desc Create an API credential\n@required {merchantId: str # The unique identifier of the merchant account.}\n@optional {allowedOrigins: [str] # The list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the new API credential., description: str # Description of the API credential., roles: [str] # List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential. Only roles assigned to 'ws@Company.' can be assigned to other API credentials.}\n@returns(200) {_links: map{allowedOrigins: map{href: str}, company: map{href: str}, generateApiKey: map{href: str}, generateClientKey: map{href: str}, merchant: map{href: str}, self: map{href: str}}, active: bool, allowedIpAddresses: [str], allowedOrigins: [map], apiKey: str, clientKey: str, description: str, id: str, password: str, roles: [str], username: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"roles\":[\"Checkout webservice role\"],\"allowedOrigins\":[\"https://www.mystore.com\"]}\n\n@endpoint GET /merchants/{merchantId}/apiCredentials/{apiCredentialId}\n@desc Get an API credential\n@required {merchantId: str # The unique identifier of the merchant account., apiCredentialId: str # Unique identifier of the API credential.}\n@returns(200) {_links: map{allowedOrigins: map{href: str}, company: map{href: str}, generateApiKey: map{href: str}, generateClientKey: map{href: str}, merchant: map{href: str}, self: map{href: str}}, active: bool, allowedIpAddresses: [str], allowedOrigins: [map], clientKey: str, description: str, id: str, roles: [str], username: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint PATCH /merchants/{merchantId}/apiCredentials/{apiCredentialId}\n@desc Update an API credential\n@required {merchantId: str # The unique identifier of the merchant account., apiCredentialId: str # Unique identifier of the API credential.}\n@optional {active: bool # Indicates if the API credential is enabled., allowedOrigins: [str] # The new list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential., description: str # Description of the API credential., roles: [str] # List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential. Only roles assigned to 'ws@Company.' can be assigned to other API credentials.}\n@returns(200) {_links: map{allowedOrigins: map{href: str}, company: map{href: str}, generateApiKey: map{href: str}, generateClientKey: map{href: str}, merchant: map{href: str}, self: map{href: str}}, active: bool, allowedIpAddresses: [str], allowedOrigins: [map], clientKey: str, description: str, id: str, roles: [str], username: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"active\":true}\n\n@endpoint GET /merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins\n@desc Get a list of allowed origins\n@required {merchantId: str # The unique identifier of the merchant account., apiCredentialId: str # Unique identifier of the API credential.}\n@returns(200) {data: [map]} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins\n@desc Create an allowed origin\n@required {merchantId: str # The unique identifier of the merchant account., apiCredentialId: str # Unique identifier of the API credential., domain: str # Domain of the allowed origin.}\n@optional {_links: map{self!: map}, id: str # Unique identifier of the allowed origin.}\n@returns(200) {_links: map{self: map{href: str}}, domain: str, id: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"domain\":\"https://www.eu.mystore.com\"}\n\n@endpoint DELETE /merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}\n@desc Delete an allowed origin\n@required {merchantId: str # The unique identifier of the merchant account., apiCredentialId: str # Unique identifier of the API credential., originId: str # Unique identifier of the allowed origin.}\n@returns(204) No Content - look at the actual response code for the status of the request.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}\n@desc Get an allowed origin\n@required {merchantId: str # The unique identifier of the merchant account., apiCredentialId: str # Unique identifier of the API credential., originId: str # Unique identifier of the allowed origin.}\n@returns(200) {_links: map{self: map{href: str}}, domain: str, id: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateApiKey\n@desc Generate new API key\n@required {merchantId: str # The unique identifier of the merchant account., apiCredentialId: str # Unique identifier of the API credential.}\n@returns(200) {apiKey: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateClientKey\n@desc Generate new client key\n@required {merchantId: str # The unique identifier of the merchant account., apiCredentialId: str # Unique identifier of the API credential.}\n@returns(200) {clientKey: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /merchants/{merchantId}/billingEntities\n@desc Get a list of billing entities\n@required {merchantId: str # The unique identifier of the merchant account.}\n@optional {name: str # The name of the billing entity.}\n@returns(200) {data: [map]} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /merchants/{merchantId}/paymentMethodSettings\n@desc Get all payment methods\n@required {merchantId: str # The unique identifier of the merchant account.}\n@optional {storeId: str # The unique identifier of the store for which to return the payment methods., businessLineId: str # The unique identifier of the Business Line for which to return the payment methods., pageSize: int(int32) # The number of items to have on a page, maximum 100. The default is 10 items on a page., pageNumber: int(int32) # The number of the page to fetch.}\n@returns(200) {_links: map{first: map{href: str}, last: map{href: str}, next: map{href: str}, prev: map{href: str}, self: map{href: str}}, data: [any], itemsTotal: int(int32), pagesTotal: int(int32), typesWithErrors: [str]} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 429, 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /merchants/{merchantId}/paymentMethodSettings\n@desc Request a payment method\n@required {merchantId: str # The unique identifier of the merchant account., type: str(abrapetite/abrapetite_credit/abrapetite_debit/abrapetite_prepaid/accel/ach/affirm/afterpaytouch/alelo/alipay/alipay_hk/alipay_plus/alipay_wap/amex/applepay/avancard/avancard_credit/avancard_debit/banese_card/banese_card_credit/banese_card_debit/banese_card_prepaid/bcmc/blik/blik_pos/br_schemes/cartebancaire/clearpay/clicktopay/cooper/cooper_credit/cooper_debit/cooper_food_debit/cooper_meal_debit/cooper_prepaid/cooper_private_credit/cooper_retail_credit/credtodos/credtodos_private_credit/credtodos_private_debit/cup/diners/directdebit_GB/discover/ebanking_FI/eft_directdebit_CA/eftpos_australia/elo/elocredit/elodebit/girocard/givex/googlepay/green_card/green_card_credit/green_card_debit/green_card_food_prepaid/green_card_meal_prepaid/green_card_prepaid/hiper/hipercard/ideal/interac_card/jcb/klarna/klarna_account/klarna_b2b/klarna_paynow/le_card/le_card_credit/le_card_debit/maestro/maestro_usa/maxifrota/maxifrota_prepaid/mbway/mc/mcdebit/mealVoucher_FR/megaleve/megaleve_credit/megaleve_debit/mobilepay/multibanco/nutricash/nutricash_prepaid/nyce/onlineBanking_PL/paybybank/paybybank_plaid/payme/payme_pos/paynow/paynow_pos/paypal/payto/personal_card/personal_card_credit/personal_card_debit/pulse/romcard/romcard_credit/romcard_debit/senff/senff_credit/sepadirectdebit/sodexo/star/svs/swish/ticket/todo_giftcard/trustly/twint/twint_pos/up_brazil/up_brazil_credit/up_brazil_debit/up_brazil_prepaid/vale_refeicao/vale_refeicao_prepaid/valuelink/vegas_card/vegas_card_credit/vegas_card_debit/vero_card/vero_card_credit/vero_card_debit/vero_card_prepaid/vipps/visa/visadebit/vpay/wechatpay/wechatpay_pos) # Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api).}\n@optional {accel: map{processingType!: str, transactionDescription: map}, affirm: map{pricePlan: str, supportEmail!: str}, afterpayTouch: map{supportEmail: str, supportUrl!: str}, alipayPlus: map{settlementCurrencyCode: str}, amex: map{midNumber: str, reuseMidNumber: bool, serviceLevel!: str}, applePay: map{domains!: [str]}, bcmc: map{enableBcmcMobile: bool}, businessLineId: str # The unique identifier of the business line. Required if you are a [platform model](https://docs.adyen.com/platforms)., cartesBancaires: map{siret!: str, transactionDescription: map}, clearpay: map{supportUrl!: str}, countries: [str] # The list of countries where a payment method is available. By default, all countries supported by the payment method., cup: map{transactionDescription: map}, currencies: [str] # The list of currencies that a payment method supports. By default, all currencies supported by the payment method., customRoutingFlags: [str] # The list of custom routing flags to route payment to the intended acquirer., diners: map{midNumber: str, reuseMidNumber!: bool, serviceLevel: str, transactionDescription: map}, discover: map{transactionDescription: map}, eft_directdebit_CA: map{transactionDescription: map}, eftpos_australia: map{transactionDescription: map}, girocard: map{transactionDescription: map}, givex: map{currencyCode!: str, password!: str, paymentFlow!: str, username!: str}, googlePay: map{merchantId!: str, reuseMerchantId: bool}, ideal: map{transactionDescription: map}, interac_card: map{transactionDescription: map}, jcb: map{midNumber: str, reuseMidNumber: bool, serviceLevel: str, transactionDescription: map}, klarna: map{autoCapture: bool, disputeEmail!: str, region!: str, supportEmail!: str}, maestro: map{transactionDescription: map}, maestro_usa: map{transactionDescription: map}, mc: map{transactionDescription: map}, mealVoucher_FR: map{conecsId!: str, siret!: str, subTypes!: [str]}, nyce: map{processingType!: str, transactionDescription: map}, paybybank_plaid: map{logo: str, transactionDescription: map}, payme: map{displayName!: str, logo!: str, supportEmail!: str}, paypal: map{directCapture: bool, payerId!: str, subject!: str}, payto: map{merchantName!: str, payToPurpose!: str}, pulse: map{processingType!: str, transactionDescription: map}, reference: str # Your reference for the payment method. Supported characters a-z, A-Z, 0-9., sepadirectdebit: map{creditorId: str, transactionDescription: map}, shopperInteraction: str(eCommerce/pos/moto/contAuth) # The sales channel. Required if the merchant account does not have a sales channel. When you provide this field, it overrides the default sales channel set on the merchant account.  Possible values: **eCommerce**, **pos**, **contAuth**, and **moto**., sodexo: map{merchantContactPhone!: str}, sofort: map{currencyCode!: str, logo!: str}, star: map{processingType!: str, transactionDescription: map}, storeId: str # The ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/post/stores__resParam_id), if any., svs: map{authorisationMid!: str, currencyCode!: str}, swish: map{swishNumber!: str}, ticket: map{requestorId: str}, twint: map{logo!: str}, valuelink: map{authorisationMid!: str, pinSupport!: str, submitterId: str, terminalId: str}, vipps: map{logo!: str, subscriptionCancelUrl: str}, visa: map{transactionDescription: map}, wechatpay: map{contactPersonName!: str, email!: str}, wechatpay_pos: map{contactPersonName!: str, email!: str}}\n@returns(200) {accel: map{processingType: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, affirm: map{pricePlan: str, supportEmail: str}, afterpayTouch: map{supportEmail: str, supportUrl: str}, alipayPlus: map{settlementCurrencyCode: str}, allowed: bool, amex: map{midNumber: str, reuseMidNumber: bool, serviceLevel: str}, applePay: map{domains: [str]}, bcmc: map{enableBcmcMobile: bool}, businessLineId: str, cartesBancaires: map{siret: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, clearpay: map{supportUrl: str}, countries: [str], cup: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, currencies: [str], customRoutingFlags: [str], diners: map{midNumber: str, reuseMidNumber: bool, serviceLevel: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, discover: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, eft_directdebit_CA: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, eftpos_australia: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, enabled: bool, girocard: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, givex: map{currencyCode: str, password: str, paymentFlow: str, username: str}, googlePay: map{merchantId: str, reuseMerchantId: bool}, id: str, ideal: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, interac_card: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, jcb: map{midNumber: str, reuseMidNumber: bool, serviceLevel: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, klarna: map{autoCapture: bool, disputeEmail: str, region: str, supportEmail: str}, maestro: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, maestro_usa: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, mc: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, mealVoucher_FR: map{conecsId: str, siret: str, subTypes: [str]}, nyce: map{processingType: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, paybybank_plaid: map{logo: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, payme: map{displayName: str, logo: str, supportEmail: str}, paypal: map{directCapture: bool, payerId: str, subject: str}, payto: map{merchantName: str, payToPurpose: str}, pulse: map{processingType: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, reference: str, sepadirectdebit: map{creditorId: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, shopperInteraction: str, sodexo: map{merchantContactPhone: str}, sofort: map{currencyCode: str, logo: str}, star: map{processingType: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, storeId: str, svs: map{authorisationMid: str, currencyCode: str}, swish: map{swishNumber: str}, ticket: map{requestorId: str}, twint: map{logo: str}, type: str, valuelink: map{authorisationMid: str, pinSupport: str, submitterId: str, terminalId: str}, verificationStatus: str, vipps: map{logo: str, subscriptionCancelUrl: str}, visa: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, wechatpay: map{contactPersonName: str, email: str}, wechatpay_pos: map{contactPersonName: str, email: str}} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 429, 500: Internal Server Error - the server could not process the request.}\n@example_request {\"type\":\"visa\",\"currencies\":[\"USD\"],\"countries\":[\"US\"]}\n\n@endpoint GET /merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}\n@desc Get payment method details\n@required {merchantId: str # The unique identifier of the merchant account., paymentMethodId: str # The unique identifier of the payment method.}\n@returns(200) {accel: map{processingType: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, affirm: map{pricePlan: str, supportEmail: str}, afterpayTouch: map{supportEmail: str, supportUrl: str}, alipayPlus: map{settlementCurrencyCode: str}, allowed: bool, amex: map{midNumber: str, reuseMidNumber: bool, serviceLevel: str}, applePay: map{domains: [str]}, bcmc: map{enableBcmcMobile: bool}, businessLineId: str, cartesBancaires: map{siret: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, clearpay: map{supportUrl: str}, countries: [str], cup: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, currencies: [str], customRoutingFlags: [str], diners: map{midNumber: str, reuseMidNumber: bool, serviceLevel: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, discover: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, eft_directdebit_CA: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, eftpos_australia: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, enabled: bool, girocard: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, givex: map{currencyCode: str, password: str, paymentFlow: str, username: str}, googlePay: map{merchantId: str, reuseMerchantId: bool}, id: str, ideal: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, interac_card: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, jcb: map{midNumber: str, reuseMidNumber: bool, serviceLevel: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, klarna: map{autoCapture: bool, disputeEmail: str, region: str, supportEmail: str}, maestro: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, maestro_usa: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, mc: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, mealVoucher_FR: map{conecsId: str, siret: str, subTypes: [str]}, nyce: map{processingType: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, paybybank_plaid: map{logo: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, payme: map{displayName: str, logo: str, supportEmail: str}, paypal: map{directCapture: bool, payerId: str, subject: str}, payto: map{merchantName: str, payToPurpose: str}, pulse: map{processingType: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, reference: str, sepadirectdebit: map{creditorId: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, shopperInteraction: str, sodexo: map{merchantContactPhone: str}, sofort: map{currencyCode: str, logo: str}, star: map{processingType: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, storeId: str, svs: map{authorisationMid: str, currencyCode: str}, swish: map{swishNumber: str}, ticket: map{requestorId: str}, twint: map{logo: str}, type: str, valuelink: map{authorisationMid: str, pinSupport: str, submitterId: str, terminalId: str}, verificationStatus: str, vipps: map{logo: str, subscriptionCancelUrl: str}, visa: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, wechatpay: map{contactPersonName: str, email: str}, wechatpay_pos: map{contactPersonName: str, email: str}} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 429, 500: Internal Server Error - the server could not process the request.}\n\n@endpoint PATCH /merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}\n@desc Update a payment method\n@required {merchantId: str # The unique identifier of the merchant account., paymentMethodId: str # The unique identifier of the payment method.}\n@optional {accel: map{processingType!: str, transactionDescription: map}, bcmc: map{enableBcmcMobile: bool}, cartesBancaires: map{siret!: str, transactionDescription: map}, countries: [str] # The list of countries where a payment method is available. By default, all countries supported by the payment method., cup: map{transactionDescription: map}, currencies: [str] # The list of currencies that a payment method supports. By default, all currencies supported by the payment method., customRoutingFlags: [str] # Custom routing flags for acquirer routing., diners: map{transactionDescription: map}, discover: map{transactionDescription: map}, eft_directdebit_CA: map{transactionDescription: map}, eftpos_australia: map{transactionDescription: map}, enabled: bool # Indicates whether the payment method is enabled (**true**) or disabled (**false**)., girocard: map{transactionDescription: map}, ideal: map{transactionDescription: map}, interac_card: map{transactionDescription: map}, jcb: map{transactionDescription: map}, maestro: map{transactionDescription: map}, maestro_usa: map{transactionDescription: map}, mc: map{transactionDescription: map}, nyce: map{processingType!: str, transactionDescription: map}, paybybank_plaid: map{logo: str, transactionDescription: map}, pulse: map{processingType!: str, transactionDescription: map}, sepadirectdebit: map{creditorId: str, transactionDescription: map}, star: map{processingType!: str, transactionDescription: map}, storeIds: [str] # The list of stores for this payment method, visa: map{transactionDescription: map}}\n@returns(200) {accel: map{processingType: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, affirm: map{pricePlan: str, supportEmail: str}, afterpayTouch: map{supportEmail: str, supportUrl: str}, alipayPlus: map{settlementCurrencyCode: str}, allowed: bool, amex: map{midNumber: str, reuseMidNumber: bool, serviceLevel: str}, applePay: map{domains: [str]}, bcmc: map{enableBcmcMobile: bool}, businessLineId: str, cartesBancaires: map{siret: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, clearpay: map{supportUrl: str}, countries: [str], cup: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, currencies: [str], customRoutingFlags: [str], diners: map{midNumber: str, reuseMidNumber: bool, serviceLevel: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, discover: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, eft_directdebit_CA: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, eftpos_australia: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, enabled: bool, girocard: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, givex: map{currencyCode: str, password: str, paymentFlow: str, username: str}, googlePay: map{merchantId: str, reuseMerchantId: bool}, id: str, ideal: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, interac_card: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, jcb: map{midNumber: str, reuseMidNumber: bool, serviceLevel: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, klarna: map{autoCapture: bool, disputeEmail: str, region: str, supportEmail: str}, maestro: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, maestro_usa: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, mc: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, mealVoucher_FR: map{conecsId: str, siret: str, subTypes: [str]}, nyce: map{processingType: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, paybybank_plaid: map{logo: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, payme: map{displayName: str, logo: str, supportEmail: str}, paypal: map{directCapture: bool, payerId: str, subject: str}, payto: map{merchantName: str, payToPurpose: str}, pulse: map{processingType: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, reference: str, sepadirectdebit: map{creditorId: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, shopperInteraction: str, sodexo: map{merchantContactPhone: str}, sofort: map{currencyCode: str, logo: str}, star: map{processingType: str, transactionDescription: map{doingBusinessAsName: str, type: str}}, storeId: str, svs: map{authorisationMid: str, currencyCode: str}, swish: map{swishNumber: str}, ticket: map{requestorId: str}, twint: map{logo: str}, type: str, valuelink: map{authorisationMid: str, pinSupport: str, submitterId: str, terminalId: str}, verificationStatus: str, vipps: map{logo: str, subscriptionCancelUrl: str}, visa: map{transactionDescription: map{doingBusinessAsName: str, type: str}}, wechatpay: map{contactPersonName: str, email: str}, wechatpay_pos: map{contactPersonName: str, email: str}} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 429, 500: Internal Server Error - the server could not process the request.}\n@example_request {\"currencies\":[\"EUR\"],\"countries\":[\"NL\"]}\n\n@endpoint POST /merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}/addApplePayDomains\n@desc Add an Apple Pay domain\n@required {merchantId: str # The unique identifier of the merchant account., paymentMethodId: str # The unique identifier of the payment method., domains: [str] # The list of merchant domains. Maximum: 99 domains per request.  For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/web-drop-in?tab=adyen-certificate-live_1#going-live).}\n@returns(204) No Content - look at the actual response code for the status of the request.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 429, 500: Internal Server Error - the server could not process the request.}\n@example_request {\"domains\":[\"https://example.com\"]}\n\n@endpoint GET /merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}/getApplePayDomains\n@desc Get Apple Pay domains\n@required {merchantId: str # The unique identifier of the merchant account., paymentMethodId: str # The unique identifier of the payment method.}\n@returns(200) {domains: [str]} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /merchants/{merchantId}/payoutSettings\n@desc Get a list of payout settings\n@required {merchantId: str # The unique identifier of the merchant account.}\n@returns(200) {data: [map]} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /merchants/{merchantId}/payoutSettings\n@desc Add a payout setting\n@required {merchantId: str # The unique identifier of the merchant account., transferInstrumentId: str # The unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the bank account.}\n@optional {enabled: bool # Indicates if payouts to this bank account are enabled. Default: **true**.  To receive payouts into this bank account, both `enabled` and `allowed` must be **true**., enabledFromDate: str # The date when Adyen starts paying out to this bank account.  Format: [ISO 8601](https://www.w3.org/TR/NOTE-datetime), for example, **2019-11-23T12:25:28Z** or **2020-05-27T20:25:28+08:00**.  If not specified, the `enabled` field indicates if payouts are enabled for this bank account.  If a date is specified and:  * `enabled`: **true**, payouts are enabled starting the specified date. * `enabled`: **false**, payouts are disabled until the specified date. On the specified date, `enabled` changes to **true** and this field is reset to **null**.}\n@returns(200) {allowed: bool, enabled: bool, enabledFromDate: str, id: str, priority: str, transferInstrumentId: str, verificationStatus: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint DELETE /merchants/{merchantId}/payoutSettings/{payoutSettingsId}\n@desc Delete a payout setting\n@required {merchantId: str # The unique identifier of the merchant account., payoutSettingsId: str # The unique identifier of the payout setting.}\n@returns(204) No Content - look at the actual response code for the status of the request.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /merchants/{merchantId}/payoutSettings/{payoutSettingsId}\n@desc Get a payout setting\n@required {merchantId: str # The unique identifier of the merchant account., payoutSettingsId: str # The unique identifier of the payout setting.}\n@returns(200) {allowed: bool, enabled: bool, enabledFromDate: str, id: str, priority: str, transferInstrumentId: str, verificationStatus: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint PATCH /merchants/{merchantId}/payoutSettings/{payoutSettingsId}\n@desc Update a payout setting\n@required {merchantId: str # The unique identifier of the merchant account., payoutSettingsId: str # The unique identifier of the payout setting.}\n@optional {enabled: bool # Indicates if payouts to this bank account are enabled. Default: **true**.  To receive payouts into this bank account, both `enabled` and `allowed` must be **true**.}\n@returns(200) {allowed: bool, enabled: bool, enabledFromDate: str, id: str, priority: str, transferInstrumentId: str, verificationStatus: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /merchants/{merchantId}/shippingLocations\n@desc Get a list of shipping locations\n@required {merchantId: str # The unique identifier of the merchant account.}\n@optional {name: str # The name of the shipping location., offset: int(int32) # The number of locations to skip., limit: int(int32) # The number of locations to return.}\n@returns(200) {data: [map]} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /merchants/{merchantId}/shippingLocations\n@desc Create a shipping location\n@required {merchantId: str # The unique identifier of the merchant account.}\n@optional {address: map{city: str, companyName: str, country: str, postalCode: str, stateOrProvince: str, streetAddress: str, streetAddress2: str}, contact: map{email: str, firstName: str, infix: str, lastName: str, phoneNumber: str}, id: str # The unique identifier of the shipping location, for use as `shippingLocationId` when creating an order., name: str # The unique name of the shipping location.}\n@returns(200) {address: map{city: str, companyName: str, country: str, postalCode: str, stateOrProvince: str, streetAddress: str, streetAddress2: str}, contact: map{email: str, firstName: str, infix: str, lastName: str, phoneNumber: str}, id: str, name: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"name\":\"YOUR_MERCHANT_ACCOUNT Barcelona depot\",\"address\":{\"companyName\":\"YOUR_COMPANY\",\"streetAddress\":\"El quinto pino 42\",\"postalCode\":\"08012\",\"city\":\"Barcelona\",\"stateOrProvince\":\"\",\"country\":\"ES\"},\"contact\":{\"firstName\":\"Rita\",\"lastName\":\"Perengano\",\"phoneNumber\":\"+34 93 1234567\",\"email\":\"Rita.Perengano@company.com\"}}\n\n@endpoint GET /merchants/{merchantId}/splitConfigurations\n@desc Get a list of split configuration profiles\n@required {merchantId: str # The unique identifier of the merchant account.}\n@returns(200) {data: [map]} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /merchants/{merchantId}/splitConfigurations\n@desc Create a split configuration profile\n@required {merchantId: str # The unique identifier of the merchant account., description: str # Your description for the split configuration., rules: [map{cardRegion: str, currency!: str, fundingSource!: str, paymentMethod!: str, ruleId: str, shopperInteraction!: str, splitLogic!: map}] # Array of rules that define the split configuration behavior.}\n@optional {splitConfigurationId: str # Unique identifier of the split configuration.}\n@returns(200) {description: str, rules: [map], splitConfigurationId: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"description\":\"Your description for the split configuration\",\"rules\":[{\"paymentMethod\":\"ANY\",\"shopperInteraction\":\"ANY\",\"fundingSource\":\"ANY\",\"currency\":\"ANY\",\"splitLogic\":{\"paymentFee\":\"deductFromLiableAccount\",\"chargeback\":\"deductFromLiableAccount\",\"tip\":\"addToOneBalanceAccount\",\"remainder\":\"addToOneBalanceAccount\",\"commission\":{\"fixedAmount\":10,\"variablePercentage\":100},\"additionalCommission\":{\"fixedAmount\":10,\"variablePercentage\":50,\"balanceAccountId\":\"BA3227C223222H5HQ2XX77VVH\"}}}]}\n\n@endpoint DELETE /merchants/{merchantId}/splitConfigurations/{splitConfigurationId}\n@desc Delete a split configuration profile\n@required {merchantId: str # The unique identifier of the merchant account., splitConfigurationId: str # The unique identifier of the split configuration.}\n@returns(200) {description: str, rules: [map], splitConfigurationId: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /merchants/{merchantId}/splitConfigurations/{splitConfigurationId}\n@desc Get a split configuration profile\n@required {merchantId: str # The unique identifier of the merchant account., splitConfigurationId: str # The unique identifier of the split configuration.}\n@returns(200) {description: str, rules: [map], splitConfigurationId: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint PATCH /merchants/{merchantId}/splitConfigurations/{splitConfigurationId}\n@desc Update the description of the split configuration profile\n@required {merchantId: str # The unique identifier of the merchant account., splitConfigurationId: str # The unique identifier of the split configuration., description: str # Your description for the split configuration.}\n@returns(200) {description: str, rules: [map], splitConfigurationId: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"description\":\"Updated description for the split configuration\"}\n\n@endpoint POST /merchants/{merchantId}/splitConfigurations/{splitConfigurationId}\n@desc Create a rule\n@required {merchantId: str # The unique identifier of the merchant account., splitConfigurationId: str # The unique identifier of the split configuration., currency: str # The currency condition that defines whether the split logic applies. Its value must be a three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217)., fundingSource: str(charged/credit/debit/deferred_debit/prepaid/ANY) # The funding source of the payment method.  Possible values: * **credit** * **debit** * **prepaid** * **deferred_debit** * **charged** * **ANY**, paymentMethod: str # The payment method condition that defines whether the split logic applies.  Possible values: * [Payment method variant](https://docs.adyen.com/development-resources/paymentmethodvariant): Apply the split logic for a specific payment method. * **ANY**: Apply the split logic for all available payment methods., shopperInteraction: str(Ecommerce/ContAuth/Moto/POS/ANY) # The sales channel condition that defines whether the split logic applies.  Possible values: * **Ecommerce**: Online transactions where the cardholder is present. * **ContAuth**: Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). * **Moto**: Mail-order and telephone-order transactions where the customer is in contact with the merchant via email or telephone. * **POS**: Point-of-sale transactions where the customer is physically present to make a payment using a secure payment terminal. * **ANY**: All sales channels., splitLogic: map{acquiringFees: str, additionalCommission: map, adyenCommission: str, adyenFees: str, adyenMarkup: str, chargeback: str, chargebackCostAllocation: str, commission!: map, interchange: str, paymentFee: str, refund: str, refundCostAllocation: str, remainder: str, schemeFee: str, splitLogicId: str, surcharge: str, tip: str}}\n@optional {cardRegion: str(international/intraRegional/interRegional/domestic/ANY) # The card region condition that determines whether the [split logic](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic) applies to the transaction.  > This condition is in pilot phase, and not yet available for all platforms.  Possible values: * **domestic**: The card issuer and the store where the transaction is processed are registered in the same country. * **international**: The card issuer and the store where the transaction is processed are registered in different countries or regions. Includes all **interRegional** and **intraRegional** transactions. * **interRegional**: The card issuer and the store where the transaction is processed are registered in different regions. * **intraRegional**: The card issuer and the store where the transaction is processed are registered in different countries, but in the same region. * **ANY**: Applies to all transactions, regardless of the processing and issuing country/region., ruleId: str # The unique identifier of the split configuration rule.}\n@returns(200) {description: str, rules: [map], splitConfigurationId: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"paymentMethod\":\"visa\",\"shopperInteraction\":\"POS\",\"fundingSource\":\"ANY\",\"currency\":\"USD\",\"splitLogic\":{\"paymentFee\":\"deductFromLiableAccount\",\"chargeback\":\"deductFromLiableAccount\",\"tip\":\"addToOneBalanceAccount\",\"remainder\":\"addToLiableAccount\",\"commission\":{\"fixedAmount\":10,\"variablePercentage\":100},\"additionalCommission\":{\"fixedAmount\":10,\"variablePercentage\":50,\"balanceAccountId\":\"BA3227C223222H5HQ2XX77VVH\"}}}\n\n@endpoint DELETE /merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}\n@desc Delete a rule\n@required {merchantId: str # The unique identifier of the merchant account., splitConfigurationId: str # The unique identifier of the split configuration., ruleId: str}\n@returns(200) {description: str, rules: [map], splitConfigurationId: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint PATCH /merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}\n@desc Update the split conditions\n@required {merchantId: str # The unique identifier of the merchant account., splitConfigurationId: str # The identifier of the split configuration., ruleId: str # The unique identifier of the split configuration rule., currency: str # The currency condition that defines whether the split logic applies. Its value must be a three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217)., fundingSource: str # The funding source of the payment method.  Possible values: * **credit** * **debit** * **prepaid** * **deferred_debit** * **charged** * **ANY**, paymentMethod: str # The payment method condition that defines whether the split logic applies.  Possible values: * [Payment method variant](https://docs.adyen.com/development-resources/paymentmethodvariant): Apply the split logic for a specific payment method. * **ANY**: Apply the split logic for all available payment methods., shopperInteraction: str # The sales channel condition that defines whether the split logic applies.  Possible values: * **Ecommerce**: Online transactions where the cardholder is present. * **ContAuth**: Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). * **Moto**: Mail-order and telephone-order transactions where the customer is in contact with the merchant via email or telephone. * **POS**: Point-of-sale transactions where the customer is physically present to make a payment using a secure payment terminal. * **ANY**: All sales channels.}\n@returns(200) {description: str, rules: [map], splitConfigurationId: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"currency\":\"EUR\",\"fundingSource\":\"ANY\",\"paymentMethod\":\"visa\",\"shopperInteraction\":\"ANY\"}\n\n@endpoint PATCH /merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}/splitLogic/{splitLogicId}\n@desc Update the split logic\n@required {merchantId: str # The unique identifier of the merchant account., splitConfigurationId: str # The unique identifier of the split configuration., ruleId: str # The unique identifier of the split configuration rule., splitLogicId: str # The unique identifier of the split configuration split., commission: map{fixedAmount: int(int64), variablePercentage: int(int64)}}\n@optional {acquiringFees: str(deductFromLiableAccount/deductFromOneBalanceAccount) # Deducts the acquiring fees (the aggregated amount of interchange and scheme fee) from the specified balance account.  Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**., additionalCommission: map{balanceAccountId: str, fixedAmount: int(int64), variablePercentage: int(int64)}, adyenCommission: str(deductFromLiableAccount/deductFromOneBalanceAccount) # Deducts the transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/guides/payments-training-guide/get-the-best-from-your-card-processing) from the specified balance account.  Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**., adyenFees: str(deductFromLiableAccount/deductFromOneBalanceAccount) # Deducts the fees due to Adyen (markup or commission) from the specified balance account.  Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**., adyenMarkup: str(deductFromLiableAccount/deductFromOneBalanceAccount) # Deducts the transaction fee due to Adyen under [Interchange ++ pricing](https://www.adyen.com/what-is-interchange) from the specified balance account.  Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**., chargeback: str(deductFromLiableAccount/deductFromOneBalanceAccount/deductAccordingToSplitRatio) # Specifies how and from which balance account(s) to deduct the chargeback amount.  Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**., chargebackCostAllocation: str(deductFromLiableAccount/deductFromOneBalanceAccount) # Deducts the chargeback costs from the specified balance account.  Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, interchange: str(deductFromLiableAccount/deductFromOneBalanceAccount) # Deducts the interchange fee from specified balance account.  Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**., paymentFee: str(deductFromLiableAccount/deductFromOneBalanceAccount) # Deducts all transaction fees incurred by the payment from the specified balance account. The transaction fees include the acquiring fees (interchange and scheme fee), and the fees due to Adyen (markup or commission). You can book any and all these fees to different balance account by specifying other transaction fee parameters in your split configuration profile:  - [`adyenCommission`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenCommission): The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained#interchange-vs-blended). - [`adyenMarkup`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenMarkup): The transaction fee due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained#interchange-vs-blended). - [`schemeFee`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-schemeFee): The fee paid to the card scheme for using their network. - [`interchange`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-interchange): The fee paid to the issuer for each payment transaction made with the card network. - [`adyenFees`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenFees): The aggregated amount of Adyen's commission and markup. - [`acquiringFees`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-acquiringFees): The aggregated amount of the interchange and scheme fees.  If you don't include at least one transaction fee type in the `splitLogic` object, Adyen updates the payment request with the `paymentFee` parameter, booking all transaction fees to your platform's liable balance account.  Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**., refund: str(deductFromLiableAccount/deductFromOneBalanceAccount/deductAccordingToSplitRatio) # Specifies how and from which balance account(s) to deduct the refund amount.  Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**, refundCostAllocation: str(deductFromLiableAccount/deductFromOneBalanceAccount) # Deducts the refund costs from the specified balance account.  Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, remainder: str(addToLiableAccount/addToOneBalanceAccount) # Books the amount left over after currency conversion to the specified balance account.  Possible values: **addToLiableAccount**, **addToOneBalanceAccount**., schemeFee: str(deductFromLiableAccount/deductFromOneBalanceAccount) # Deducts the scheme fee from the specified balance account.  Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**., splitLogicId: str # Unique identifier of the collection of split instructions that are applied when the rule conditions are met., surcharge: str(addToLiableAccount/addToOneBalanceAccount) # Books the surcharge amount to the specified balance account.  Possible values: **addToLiableAccount**, **addToOneBalanceAccount**, tip: str(addToLiableAccount/addToOneBalanceAccount) # Books the tips (gratuity) to the specified balance account.  Possible values: **addToLiableAccount**, **addToOneBalanceAccount**.}\n@returns(200) {description: str, rules: [map], splitConfigurationId: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"additionalCommission\":{\"fixedAmount\":100,\"variablePercentage\":0,\"balanceAccountId\":\"BA3227C223222H5HQ2XX77VVH\"},\"chargeback\":\"deductFromLiableAccount\",\"commission\":{\"fixedAmount\":100,\"variablePercentage\":100},\"paymentFee\":\"deductFromLiableAccount\",\"remainder\":\"addToLiableAccount\",\"tip\":\"addToLiableAccount\"}\n\n@endpoint GET /merchants/{merchantId}/stores\n@desc Get a list of stores\n@required {merchantId: str # The unique identifier of the merchant account.}\n@optional {pageNumber: int(int32) # The number of the page to fetch., pageSize: int(int32) # The number of items to have on a page, maximum 100. The default is 10 items on a page., reference: str # The reference of the store.}\n@returns(200) {_links: map{first: map{href: str}, last: map{href: str}, next: map{href: str}, prev: map{href: str}, self: map{href: str}}, data: [map], itemsTotal: int(int32), pagesTotal: int(int32)} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /merchants/{merchantId}/stores\n@desc Create a store\n@required {merchantId: str # The unique identifier of the merchant account., address: map{city: str, country!: str, line1: str, line2: str, line3: str, postalCode: str, stateOrProvince: str}, description: str # Your description of the store., phoneNumber: str # The phone number of the store, including '+' and country code., shopperStatement: str # 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.}\n@optional {businessLineIds: [str] # 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., externalReferenceId: str, localizedInformation: map{localShopperStatement!: [map]}, reference: str # Your reference to recognize the store by. Also known as the store code.  Allowed characters: lowercase and uppercase letters without diacritics, numbers 0 through 9, hyphen (-), and underscore (_).  If 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)., splitConfiguration: map{balanceAccountId: str, splitConfigurationId: str}}\n@returns(200) {_links: map{self: map{href: str}}, address: map{city: str, country: str, line1: str, line2: str, line3: str, postalCode: str, stateOrProvince: str}, businessLineIds: [str], description: str, externalReferenceId: str, id: str, localizedInformation: map{localShopperStatement: [map]}, merchantId: str, phoneNumber: str, reference: str, shopperStatement: str, splitConfiguration: map{balanceAccountId: str, splitConfigurationId: str}, status: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"description\":\"City centre store\",\"shopperStatement\":\"Springfield Shop\",\"phoneNumber\":\"13123456789\",\"reference\":\"Spring_store_2\",\"address\":{\"country\":\"US\",\"line1\":\"200 Main Street\",\"line2\":\"Building 5A\",\"line3\":\"Suite 3\",\"city\":\"Springfield\",\"stateOrProvince\":\"NY\",\"postalCode\":\"20250\"}}\n\n@endpoint GET /merchants/{merchantId}/stores/{reference}/terminalLogos\n@desc Get the terminal logo\n@required {merchantId: str # The unique identifier of the merchant account., reference: str # The reference that identifies the store., model: str # 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.}\n@returns(200) {data: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint PATCH /merchants/{merchantId}/stores/{reference}/terminalLogos\n@desc Update the terminal logo\n@required {merchantId: str # The unique identifier of the merchant account., reference: str # The reference that identifies the store., model: str # 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}\n@optional {data: str # The image file, converted to a Base64-encoded string, of the logo to be shown on the terminal.}\n@returns(200) {data: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"data\":\"\"}\n\n@endpoint GET /merchants/{merchantId}/stores/{reference}/terminalSettings\n@desc Get terminal settings\n@required {merchantId: str # The unique identifier of the merchant account., reference: str # The reference that identifies the store.}\n@returns(200) {cardholderReceipt: map{headerForAuthorizedReceipt: str}, connectivity: map{simcardStatus: str, terminalIPAddressURL: map{eventLocalUrls: [map], eventPublicUrls: [map]}}, gratuities: [map]?, hardware: map{displayMaximumBackLight: int(int32), resetTotalsHour: int(int32), restartHour: int(int32)}, homeScreen: map{hideNavigationBar: bool, showPaymentsMenu: bool, showSettingsMenu: bool}, kioskMode: map{allowedAppsInKioskMode: [str], kioskAppOnStartup: str}, localization: map{language: str, secondaryLanguage: str, timezone: str}, moto: map{enableMoto: bool, maxAmount: int(int32)}, nexo: map{displayUrls: map{localUrls: [map], publicUrls: [map]}, encryptionKey: map{identifier: str, passphrase: str, version: int(int32)}, eventUrls: map{eventLocalUrls: [map], eventPublicUrls: [map]}, nexoEventUrls: [str], notification: map{category: str, details: str, enabled: bool, showButton: bool, title: str}}, offlineProcessing: map{chipFloorLimit: int(int32), offlineSwipeLimits: [map]}, opi: map{enablePayAtTable: bool, payAtTableStoreNumber: str, payAtTableURL: str}, passcodes: map{adminMenuPin: str, refundPin: str, screenLockPin: str, txMenuPin: str}, payAtTable: map{authenticationMethod: str, enablePayAtTable: bool, paymentInstrument: str?}, payment: map{contactlessCurrency: str, hideMinorUnitsInCurrencies: [str]}, receiptOptions: map{logo: str, promptBeforePrinting: bool, qrCodeData: str}, receiptPrinting: map{merchantApproved: bool, merchantCancelled: bool, merchantCaptureApproved: bool, merchantCaptureRefused: bool, merchantRefundApproved: bool, merchantRefundRefused: bool, merchantRefused: bool, merchantVoid: bool, shopperApproved: bool, shopperCancelled: bool, shopperCaptureApproved: bool, shopperCaptureRefused: bool, shopperRefundApproved: bool, shopperRefundRefused: bool, shopperRefused: bool, shopperVoid: bool}, refunds: map{referenced: map{enableStandaloneRefunds: bool}, unreferenced: map{enableUnreferencedRefunds: bool}}, signature: map{askSignatureOnScreen: bool, deviceName: str, deviceSlogan: str, skipSignature: bool}, standalone: map{currencyCode: str, enableGratuities: bool, enableStandalone: bool}, storeAndForward: map{maxAmount: [map], maxPayments: int(int32), supportedCardTypes: map{credit: bool, debit: bool, deferredDebit: bool, prepaid: bool, unknown: bool}}, surcharge: map{askConfirmation: bool, configurations: [map], excludeGratuityFromSurcharge: bool}, tapToPay: map{merchantDisplayName: str}, terminalInstructions: map{adyenAppRestart: bool}, timeouts: map{fromActiveToSleep: int(int32)}, wifiProfiles: map{profiles: [map], settings: map{band: str, roaming: bool, timeout: int(int32)}}} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint PATCH /merchants/{merchantId}/stores/{reference}/terminalSettings\n@desc Update terminal settings\n@required {merchantId: str # The unique identifier of the merchant account., reference: str # The reference that identifies the store.}\n@optional {cardholderReceipt: map{headerForAuthorizedReceipt: str}, connectivity: map{simcardStatus: str, terminalIPAddressURL: map}, gratuities: [map{allowCustomAmount: bool, currency: str, predefinedTipEntries: [str], usePredefinedTipEntries: bool}] # 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., hardware: map{displayMaximumBackLight: int(int32), resetTotalsHour: int(int32), restartHour: int(int32)}, homeScreen: map{hideNavigationBar: bool, showPaymentsMenu: bool, showSettingsMenu: bool}, kioskMode: map{allowedAppsInKioskMode: [str], kioskAppOnStartup: str}, localization: map{language: str, secondaryLanguage: str, timezone: str}, moto: map{enableMoto: bool, maxAmount: int(int32)}, nexo: map{displayUrls: map, encryptionKey: map, eventUrls: map, nexoEventUrls: [str], notification: map}, offlineProcessing: map{chipFloorLimit: int(int32), offlineSwipeLimits: [map]}, opi: map{enablePayAtTable: bool, payAtTableStoreNumber: str, payAtTableURL: str}, passcodes: map{adminMenuPin: str, refundPin: str, screenLockPin: str, txMenuPin: str}, payAtTable: map{authenticationMethod: str, enablePayAtTable: bool, paymentInstrument: str}, payment: map{contactlessCurrency: str, hideMinorUnitsInCurrencies: [str]}, receiptOptions: map{logo: str, promptBeforePrinting: bool, qrCodeData: str}, receiptPrinting: map{merchantApproved: bool, merchantCancelled: bool, merchantCaptureApproved: bool, merchantCaptureRefused: bool, merchantRefundApproved: bool, merchantRefundRefused: bool, merchantRefused: bool, merchantVoid: bool, shopperApproved: bool, shopperCancelled: bool, shopperCaptureApproved: bool, shopperCaptureRefused: bool, shopperRefundApproved: bool, shopperRefundRefused: bool, shopperRefused: bool, shopperVoid: bool}, refunds: map{referenced: map, unreferenced: map}, signature: map{askSignatureOnScreen: bool, deviceName: str, deviceSlogan: str, skipSignature: bool}, standalone: map{currencyCode: str, enableGratuities: bool, enableStandalone: bool}, storeAndForward: map{maxAmount: [map], maxPayments: int(int32), supportedCardTypes: map}, surcharge: map{askConfirmation: bool, configurations: [map], excludeGratuityFromSurcharge: bool}, tapToPay: map{merchantDisplayName: str}, terminalInstructions: map{adyenAppRestart: bool}, timeouts: map{fromActiveToSleep: int(int32)}, wifiProfiles: map{profiles: [map], settings: map}}\n@returns(200) {cardholderReceipt: map{headerForAuthorizedReceipt: str}, connectivity: map{simcardStatus: str, terminalIPAddressURL: map{eventLocalUrls: [map], eventPublicUrls: [map]}}, gratuities: [map]?, hardware: map{displayMaximumBackLight: int(int32), resetTotalsHour: int(int32), restartHour: int(int32)}, homeScreen: map{hideNavigationBar: bool, showPaymentsMenu: bool, showSettingsMenu: bool}, kioskMode: map{allowedAppsInKioskMode: [str], kioskAppOnStartup: str}, localization: map{language: str, secondaryLanguage: str, timezone: str}, moto: map{enableMoto: bool, maxAmount: int(int32)}, nexo: map{displayUrls: map{localUrls: [map], publicUrls: [map]}, encryptionKey: map{identifier: str, passphrase: str, version: int(int32)}, eventUrls: map{eventLocalUrls: [map], eventPublicUrls: [map]}, nexoEventUrls: [str], notification: map{category: str, details: str, enabled: bool, showButton: bool, title: str}}, offlineProcessing: map{chipFloorLimit: int(int32), offlineSwipeLimits: [map]}, opi: map{enablePayAtTable: bool, payAtTableStoreNumber: str, payAtTableURL: str}, passcodes: map{adminMenuPin: str, refundPin: str, screenLockPin: str, txMenuPin: str}, payAtTable: map{authenticationMethod: str, enablePayAtTable: bool, paymentInstrument: str?}, payment: map{contactlessCurrency: str, hideMinorUnitsInCurrencies: [str]}, receiptOptions: map{logo: str, promptBeforePrinting: bool, qrCodeData: str}, receiptPrinting: map{merchantApproved: bool, merchantCancelled: bool, merchantCaptureApproved: bool, merchantCaptureRefused: bool, merchantRefundApproved: bool, merchantRefundRefused: bool, merchantRefused: bool, merchantVoid: bool, shopperApproved: bool, shopperCancelled: bool, shopperCaptureApproved: bool, shopperCaptureRefused: bool, shopperRefundApproved: bool, shopperRefundRefused: bool, shopperRefused: bool, shopperVoid: bool}, refunds: map{referenced: map{enableStandaloneRefunds: bool}, unreferenced: map{enableUnreferencedRefunds: bool}}, signature: map{askSignatureOnScreen: bool, deviceName: str, deviceSlogan: str, skipSignature: bool}, standalone: map{currencyCode: str, enableGratuities: bool, enableStandalone: bool}, storeAndForward: map{maxAmount: [map], maxPayments: int(int32), supportedCardTypes: map{credit: bool, debit: bool, deferredDebit: bool, prepaid: bool, unknown: bool}}, surcharge: map{askConfirmation: bool, configurations: [map], excludeGratuityFromSurcharge: bool}, tapToPay: map{merchantDisplayName: str}, terminalInstructions: map{adyenAppRestart: bool}, timeouts: map{fromActiveToSleep: int(int32)}, wifiProfiles: map{profiles: [map], settings: map{band: str, roaming: bool, timeout: int(int32)}}} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"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\",\"name\":\"Profile-eap-peap-1\",\"ssid\":\"your-network\",\"wsec\":\"ccmp\"},{\"authType\":\"wpa-psk\",\"autoWifi\":false,\"bssType\":\"infra\",\"channel\":0,\"defaultProfile\":false,\"name\":\"Profile-guest-wifi\",\"psk\":\"WIFI_PASSWORD\",\"ssid\":\"your-network\",\"wsec\":\"ccmp\"}],\"settings\":{\"band\":\"2.4GHz\",\"roaming\":true,\"timeout\":5}}}\n\n@endpoint GET /merchants/{merchantId}/stores/{storeId}\n@desc Get a store\n@required {merchantId: str # The unique identifier of the merchant account., storeId: str # The unique identifier of the store.}\n@returns(200) {_links: map{self: map{href: str}}, address: map{city: str, country: str, line1: str, line2: str, line3: str, postalCode: str, stateOrProvince: str}, businessLineIds: [str], description: str, externalReferenceId: str, id: str, localizedInformation: map{localShopperStatement: [map]}, merchantId: str, phoneNumber: str, reference: str, shopperStatement: str, splitConfiguration: map{balanceAccountId: str, splitConfigurationId: str}, status: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint PATCH /merchants/{merchantId}/stores/{storeId}\n@desc Update a store\n@required {merchantId: str # The unique identifier of the merchant account., storeId: str # The unique identifier of the store.}\n@optional {address: map{city: str, line1: str, line2: str, line3: str, postalCode: str, stateOrProvince: str}, businessLineIds: [str] # 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., description: str # The description of the store., externalReferenceId: str, phoneNumber: str # The phone number of the store, including '+' and country code., splitConfiguration: map{balanceAccountId: str, splitConfigurationId: str}, status: str(active/closed/inactive) # The status of the store. Possible values are:  - **active**: This value is assigned automatically when a store is created.  - **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. - **closed**: The terminals of the store are reassigned to the merchant inventory, so they can't process payments.  You can change the status from **active** to **inactive**, and from **inactive** to **active** or **closed**.  Once **closed**, a store can't be reopened.}\n@returns(200) {_links: map{self: map{href: str}}, address: map{city: str, country: str, line1: str, line2: str, line3: str, postalCode: str, stateOrProvince: str}, businessLineIds: [str], description: str, externalReferenceId: str, id: str, localizedInformation: map{localShopperStatement: [map]}, merchantId: str, phoneNumber: str, reference: str, shopperStatement: str, splitConfiguration: map{balanceAccountId: str, splitConfigurationId: str}, status: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"address\":{\"line1\":\"1776 West Pinewood Avenue\",\"line2\":\"Heartland Building\",\"line3\":\"\",\"postalCode\":\"20251\"}}\n\n@endpoint GET /merchants/{merchantId}/terminalLogos\n@desc Get the terminal logo\n@required {merchantId: str # The unique identifier of the merchant account., model: str # 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.}\n@returns(200) {data: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint PATCH /merchants/{merchantId}/terminalLogos\n@desc Update the terminal logo\n@required {merchantId: str # The unique identifier of the merchant account., model: str # The terminal model. Allowed 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.}\n@optional {data: str # The image file, converted to a Base64-encoded string, of the logo to be shown on the terminal.}\n@returns(200) {data: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"data\":\"\"}\n\n@endpoint GET /merchants/{merchantId}/terminalModels\n@desc Get a list of terminal models\n@required {merchantId: str # The unique identifier of the merchant account.}\n@returns(200) {data: [map]} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /merchants/{merchantId}/terminalOrders\n@desc Get a list of orders\n@required {merchantId: str}\n@optional {customerOrderReference: str # Your purchase order number., status: str # The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered., offset: int(int32) # The number of orders to skip., limit: int(int32) # The number of orders to return.}\n@returns(200) {data: [map]} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /merchants/{merchantId}/terminalOrders\n@desc Create an order\n@required {merchantId: str # The unique identifier of the merchant account.}\n@optional {billingEntityId: str # The identification of the billing entity to use for the order.    > When ordering products in Brazil, you do not need to include the `billingEntityId` in the request., customerOrderReference: str # The merchant-defined purchase order reference., items: [map{id: str, installments: int(int64), name: str, quantity: int(int32)}] # The products included in the order., orderType: str # Type of order, shippingLocationId: str # The identification of the shipping location to use for the order., taxId: str # The tax number of the billing entity.}\n@returns(200) {billingEntity: map{address: map{city: str, companyName: str, country: str, postalCode: str, stateOrProvince: str, streetAddress: str, streetAddress2: str}, email: str, id: str, name: str, taxId: str}, customerOrderReference: str, id: str, items: [map], orderDate: str, shippingLocation: map{address: map{city: str, companyName: str, country: str, postalCode: str, stateOrProvince: str, streetAddress: str, streetAddress2: str}, contact: map{email: str, firstName: str, infix: str, lastName: str, phoneNumber: str}, id: str, name: str}, status: str, trackingUrl: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"customerOrderReference\":\"YOUR_REFERENCE\",\"shippingLocationId\":\"S2-6A6C2E3432747D4F2F2C3455485E3836457D\",\"billingEntityId\":\"MerchantAccount.YOUR_MERCHANT_ACCOUNT\",\"items\":[{\"id\":\"PART-287001-EU\",\"name\":\"Bluetooth Charging Base - V400m\",\"quantity\":2},{\"id\":\"PART-620222-EU\",\"name\":\"Receipt Roll\",\"quantity\":20}]}\n\n@endpoint GET /merchants/{merchantId}/terminalOrders/{orderId}\n@desc Get an order\n@required {merchantId: str # The unique identifier of the merchant account., orderId: str # The unique identifier of the order.}\n@returns(200) {billingEntity: map{address: map{city: str, companyName: str, country: str, postalCode: str, stateOrProvince: str, streetAddress: str, streetAddress2: str}, email: str, id: str, name: str, taxId: str}, customerOrderReference: str, id: str, items: [map], orderDate: str, shippingLocation: map{address: map{city: str, companyName: str, country: str, postalCode: str, stateOrProvince: str, streetAddress: str, streetAddress2: str}, contact: map{email: str, firstName: str, infix: str, lastName: str, phoneNumber: str}, id: str, name: str}, status: str, trackingUrl: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint PATCH /merchants/{merchantId}/terminalOrders/{orderId}\n@desc Update an order\n@required {merchantId: str # The unique identifier of the merchant account., orderId: str # The unique identifier of the order.}\n@optional {billingEntityId: str # The identification of the billing entity to use for the order.    > When ordering products in Brazil, you do not need to include the `billingEntityId` in the request., customerOrderReference: str # The merchant-defined purchase order reference., items: [map{id: str, installments: int(int64), name: str, quantity: int(int32)}] # The products included in the order., orderType: str # Type of order, shippingLocationId: str # The identification of the shipping location to use for the order., taxId: str # The tax number of the billing entity.}\n@returns(200) {billingEntity: map{address: map{city: str, companyName: str, country: str, postalCode: str, stateOrProvince: str, streetAddress: str, streetAddress2: str}, email: str, id: str, name: str, taxId: str}, customerOrderReference: str, id: str, items: [map], orderDate: str, shippingLocation: map{address: map{city: str, companyName: str, country: str, postalCode: str, stateOrProvince: str, streetAddress: str, streetAddress2: str}, contact: map{email: str, firstName: str, infix: str, lastName: str, phoneNumber: str}, id: str, name: str}, status: str, trackingUrl: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"items\":[{\"id\":\"TBOX-V400m-684-EU\",\"name\":\"V400m Package\",\"quantity\":1},{\"id\":\"PART-287001-EU\",\"name\":\"Bluetooth Charging Base - V400m\",\"quantity\":2},{\"id\":\"PART-620222-EU\",\"name\":\"Receipt Roll\",\"quantity\":20}]}\n\n@endpoint POST /merchants/{merchantId}/terminalOrders/{orderId}/cancel\n@desc Cancel an order\n@required {merchantId: str # The unique identifier of the merchant account., orderId: str # The unique identifier of the order.}\n@returns(200) {billingEntity: map{address: map{city: str, companyName: str, country: str, postalCode: str, stateOrProvince: str, streetAddress: str, streetAddress2: str}, email: str, id: str, name: str, taxId: str}, customerOrderReference: str, id: str, items: [map], orderDate: str, shippingLocation: map{address: map{city: str, companyName: str, country: str, postalCode: str, stateOrProvince: str, streetAddress: str, streetAddress2: str}, contact: map{email: str, firstName: str, infix: str, lastName: str, phoneNumber: str}, id: str, name: str}, status: str, trackingUrl: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /merchants/{merchantId}/terminalProducts\n@desc Get a list of terminal products\n@required {merchantId: str # The unique identifier of the merchant account., country: str # The country to return products for, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US**}\n@optional {terminalModelId: str # The terminal model to return products for. Use the ID returned in the [GET `/terminalModels`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/merchants/{merchantId}/terminalModels) response. For example, **Verifone.M400**, offset: int(int32) # The number of products to skip., limit: int(int32) # The number of products to return.}\n@returns(200) {data: [map]} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /merchants/{merchantId}/terminalSettings\n@desc Get terminal settings\n@required {merchantId: str # The unique identifier of the merchant account.}\n@returns(200) {cardholderReceipt: map{headerForAuthorizedReceipt: str}, connectivity: map{simcardStatus: str, terminalIPAddressURL: map{eventLocalUrls: [map], eventPublicUrls: [map]}}, gratuities: [map]?, hardware: map{displayMaximumBackLight: int(int32), resetTotalsHour: int(int32), restartHour: int(int32)}, homeScreen: map{hideNavigationBar: bool, showPaymentsMenu: bool, showSettingsMenu: bool}, kioskMode: map{allowedAppsInKioskMode: [str], kioskAppOnStartup: str}, localization: map{language: str, secondaryLanguage: str, timezone: str}, moto: map{enableMoto: bool, maxAmount: int(int32)}, nexo: map{displayUrls: map{localUrls: [map], publicUrls: [map]}, encryptionKey: map{identifier: str, passphrase: str, version: int(int32)}, eventUrls: map{eventLocalUrls: [map], eventPublicUrls: [map]}, nexoEventUrls: [str], notification: map{category: str, details: str, enabled: bool, showButton: bool, title: str}}, offlineProcessing: map{chipFloorLimit: int(int32), offlineSwipeLimits: [map]}, opi: map{enablePayAtTable: bool, payAtTableStoreNumber: str, payAtTableURL: str}, passcodes: map{adminMenuPin: str, refundPin: str, screenLockPin: str, txMenuPin: str}, payAtTable: map{authenticationMethod: str, enablePayAtTable: bool, paymentInstrument: str?}, payment: map{contactlessCurrency: str, hideMinorUnitsInCurrencies: [str]}, receiptOptions: map{logo: str, promptBeforePrinting: bool, qrCodeData: str}, receiptPrinting: map{merchantApproved: bool, merchantCancelled: bool, merchantCaptureApproved: bool, merchantCaptureRefused: bool, merchantRefundApproved: bool, merchantRefundRefused: bool, merchantRefused: bool, merchantVoid: bool, shopperApproved: bool, shopperCancelled: bool, shopperCaptureApproved: bool, shopperCaptureRefused: bool, shopperRefundApproved: bool, shopperRefundRefused: bool, shopperRefused: bool, shopperVoid: bool}, refunds: map{referenced: map{enableStandaloneRefunds: bool}, unreferenced: map{enableUnreferencedRefunds: bool}}, signature: map{askSignatureOnScreen: bool, deviceName: str, deviceSlogan: str, skipSignature: bool}, standalone: map{currencyCode: str, enableGratuities: bool, enableStandalone: bool}, storeAndForward: map{maxAmount: [map], maxPayments: int(int32), supportedCardTypes: map{credit: bool, debit: bool, deferredDebit: bool, prepaid: bool, unknown: bool}}, surcharge: map{askConfirmation: bool, configurations: [map], excludeGratuityFromSurcharge: bool}, tapToPay: map{merchantDisplayName: str}, terminalInstructions: map{adyenAppRestart: bool}, timeouts: map{fromActiveToSleep: int(int32)}, wifiProfiles: map{profiles: [map], settings: map{band: str, roaming: bool, timeout: int(int32)}}} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint PATCH /merchants/{merchantId}/terminalSettings\n@desc Update terminal settings\n@required {merchantId: str # The unique identifier of the merchant account.}\n@optional {cardholderReceipt: map{headerForAuthorizedReceipt: str}, connectivity: map{simcardStatus: str, terminalIPAddressURL: map}, gratuities: [map{allowCustomAmount: bool, currency: str, predefinedTipEntries: [str], usePredefinedTipEntries: bool}] # 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., hardware: map{displayMaximumBackLight: int(int32), resetTotalsHour: int(int32), restartHour: int(int32)}, homeScreen: map{hideNavigationBar: bool, showPaymentsMenu: bool, showSettingsMenu: bool}, kioskMode: map{allowedAppsInKioskMode: [str], kioskAppOnStartup: str}, localization: map{language: str, secondaryLanguage: str, timezone: str}, moto: map{enableMoto: bool, maxAmount: int(int32)}, nexo: map{displayUrls: map, encryptionKey: map, eventUrls: map, nexoEventUrls: [str], notification: map}, offlineProcessing: map{chipFloorLimit: int(int32), offlineSwipeLimits: [map]}, opi: map{enablePayAtTable: bool, payAtTableStoreNumber: str, payAtTableURL: str}, passcodes: map{adminMenuPin: str, refundPin: str, screenLockPin: str, txMenuPin: str}, payAtTable: map{authenticationMethod: str, enablePayAtTable: bool, paymentInstrument: str}, payment: map{contactlessCurrency: str, hideMinorUnitsInCurrencies: [str]}, receiptOptions: map{logo: str, promptBeforePrinting: bool, qrCodeData: str}, receiptPrinting: map{merchantApproved: bool, merchantCancelled: bool, merchantCaptureApproved: bool, merchantCaptureRefused: bool, merchantRefundApproved: bool, merchantRefundRefused: bool, merchantRefused: bool, merchantVoid: bool, shopperApproved: bool, shopperCancelled: bool, shopperCaptureApproved: bool, shopperCaptureRefused: bool, shopperRefundApproved: bool, shopperRefundRefused: bool, shopperRefused: bool, shopperVoid: bool}, refunds: map{referenced: map, unreferenced: map}, signature: map{askSignatureOnScreen: bool, deviceName: str, deviceSlogan: str, skipSignature: bool}, standalone: map{currencyCode: str, enableGratuities: bool, enableStandalone: bool}, storeAndForward: map{maxAmount: [map], maxPayments: int(int32), supportedCardTypes: map}, surcharge: map{askConfirmation: bool, configurations: [map], excludeGratuityFromSurcharge: bool}, tapToPay: map{merchantDisplayName: str}, terminalInstructions: map{adyenAppRestart: bool}, timeouts: map{fromActiveToSleep: int(int32)}, wifiProfiles: map{profiles: [map], settings: map}}\n@returns(200) {cardholderReceipt: map{headerForAuthorizedReceipt: str}, connectivity: map{simcardStatus: str, terminalIPAddressURL: map{eventLocalUrls: [map], eventPublicUrls: [map]}}, gratuities: [map]?, hardware: map{displayMaximumBackLight: int(int32), resetTotalsHour: int(int32), restartHour: int(int32)}, homeScreen: map{hideNavigationBar: bool, showPaymentsMenu: bool, showSettingsMenu: bool}, kioskMode: map{allowedAppsInKioskMode: [str], kioskAppOnStartup: str}, localization: map{language: str, secondaryLanguage: str, timezone: str}, moto: map{enableMoto: bool, maxAmount: int(int32)}, nexo: map{displayUrls: map{localUrls: [map], publicUrls: [map]}, encryptionKey: map{identifier: str, passphrase: str, version: int(int32)}, eventUrls: map{eventLocalUrls: [map], eventPublicUrls: [map]}, nexoEventUrls: [str], notification: map{category: str, details: str, enabled: bool, showButton: bool, title: str}}, offlineProcessing: map{chipFloorLimit: int(int32), offlineSwipeLimits: [map]}, opi: map{enablePayAtTable: bool, payAtTableStoreNumber: str, payAtTableURL: str}, passcodes: map{adminMenuPin: str, refundPin: str, screenLockPin: str, txMenuPin: str}, payAtTable: map{authenticationMethod: str, enablePayAtTable: bool, paymentInstrument: str?}, payment: map{contactlessCurrency: str, hideMinorUnitsInCurrencies: [str]}, receiptOptions: map{logo: str, promptBeforePrinting: bool, qrCodeData: str}, receiptPrinting: map{merchantApproved: bool, merchantCancelled: bool, merchantCaptureApproved: bool, merchantCaptureRefused: bool, merchantRefundApproved: bool, merchantRefundRefused: bool, merchantRefused: bool, merchantVoid: bool, shopperApproved: bool, shopperCancelled: bool, shopperCaptureApproved: bool, shopperCaptureRefused: bool, shopperRefundApproved: bool, shopperRefundRefused: bool, shopperRefused: bool, shopperVoid: bool}, refunds: map{referenced: map{enableStandaloneRefunds: bool}, unreferenced: map{enableUnreferencedRefunds: bool}}, signature: map{askSignatureOnScreen: bool, deviceName: str, deviceSlogan: str, skipSignature: bool}, standalone: map{currencyCode: str, enableGratuities: bool, enableStandalone: bool}, storeAndForward: map{maxAmount: [map], maxPayments: int(int32), supportedCardTypes: map{credit: bool, debit: bool, deferredDebit: bool, prepaid: bool, unknown: bool}}, surcharge: map{askConfirmation: bool, configurations: [map], excludeGratuityFromSurcharge: bool}, tapToPay: map{merchantDisplayName: str}, terminalInstructions: map{adyenAppRestart: bool}, timeouts: map{fromActiveToSleep: int(int32)}, wifiProfiles: map{profiles: [map], settings: map{band: str, roaming: bool, timeout: int(int32)}}} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"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}}}\n\n@endpoint GET /merchants/{merchantId}/users\n@desc Get a list of users\n@required {merchantId: str # Unique identifier of the merchant.}\n@optional {pageNumber: int(int32) # The number of the page to fetch., pageSize: int(int32) # The number of items to have on a page. Maximum value is **100**. The default is **10** items on a page., username: str # The partial or complete username to select all users that match.}\n@returns(200) {_links: map{first: map{href: str}, last: map{href: str}, next: map{href: str}, prev: map{href: str}, self: map{href: str}}, data: [map], itemsTotal: int(int32), pagesTotal: int(int32)} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /merchants/{merchantId}/users\n@desc Create a new user\n@required {merchantId: str # Unique identifier of the merchant., email: str # The email address of the user., name: map{firstName!: str, lastName!: str}, username: str # The user's email address that will be their username. Must be the same as the one in the `email` field.}\n@optional {accountGroups: [str] # The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user., loginMethod: str # The requested login method for the user. To use SSO, you must already have SSO configured with Adyen before creating the user.  Possible values: **Username & account**, **Email**, or **SSO**, roles: [str] # The list of [roles](https://docs.adyen.com/account/user-roles) for this user., timeZoneCode: str # The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.}\n@returns(200) {_links: map{self: map{href: str}}, accountGroups: [str], active: bool, apps: [str], email: str, id: str, name: map{firstName: str, lastName: str}, roles: [str], timeZoneCode: str, username: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"name\":{\"firstName\":\"John\",\"lastName\":\"Smith\"},\"username\":\"johnsmith\",\"email\":\"john.smith@example.com\",\"loginMethod\":\"Email\",\"timeZoneCode\":\"Europe/Amsterdam\",\"roles\":[\"Merchant standard role\"]}\n\n@endpoint GET /merchants/{merchantId}/users/{userId}\n@desc Get user details\n@required {merchantId: str # Unique identifier of the merchant., userId: str # Unique identifier of the user.}\n@returns(200) {_links: map{self: map{href: str}}, accountGroups: [str], active: bool, apps: [str], email: str, id: str, name: map{firstName: str, lastName: str}, roles: [str], timeZoneCode: str, username: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint PATCH /merchants/{merchantId}/users/{userId}\n@desc Update a user\n@required {merchantId: str # Unique identifier of the merchant., userId: str # Unique identifier of the user.}\n@optional {accountGroups: [str] # The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user., active: bool # Sets the status of the user to active (**true**) or inactive (**false**)., email: str # The email address of the user., loginMethod: str # The requested login method for the user. To use SSO, you must already have SSO configured with Adyen before creating the user.  Possible values: **Username & account**, **Email**, or **SSO**, name: map{firstName: str, lastName: str}, roles: [str] # The list of [roles](https://docs.adyen.com/account/user-roles) for this user., timeZoneCode: str # The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.}\n@returns(200) {_links: map{self: map{href: str}}, accountGroups: [str], active: bool, apps: [str], email: str, id: str, name: map{firstName: str, lastName: str}, roles: [str], timeZoneCode: str, username: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /merchants/{merchantId}/webhooks\n@desc List all webhooks\n@required {merchantId: str # The unique identifier of the merchant account.}\n@optional {pageNumber: int(int32) # The number of the page to fetch., pageSize: int(int32) # The number of items to have on a page, maximum 100. The default is 10 items on a page.}\n@returns(200) {_links: map{first: map{href: str}, last: map{href: str}, next: map{href: str}, prev: map{href: str}, self: map{href: str}}, accountReference: str, data: [map], itemsTotal: int(int32), pagesTotal: int(int32)} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /merchants/{merchantId}/webhooks\n@desc Set up a webhook\n@required {merchantId: str # The unique identifier of the merchant account., active: bool # Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account., communicationFormat: str(http/json/soap) # Format or protocol for receiving webhooks. Possible values: * **soap** * **http** * **json**, type: str # The type of webhook that is being created. Possible values are:  - **standard** - **account-settings-notification** - **banktransfer-notification** - **boletobancario-notification** - **directdebit-notification** - **ach-notification-of-change-notification** - **direct-debit-notice-of-change-notification** - **pending-notification** - **ideal-notification** - **ideal-pending-notification** - **report-notification** - **rreq-notification** - **terminal-settings** - **terminal-boarding**  Find out more about [standard webhooks](https://docs.adyen.com/development-resources/webhooks/webhook-types/#event-codes) and [other types of webhooks](https://docs.adyen.com/development-resources/webhooks/webhook-types/#other-webhooks)., url: str # Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.}\n@optional {acceptsExpiredCertificate: bool # Indicates if expired SSL certificates are accepted. Default value: **false**., acceptsSelfSignedCertificate: bool # Indicates if self-signed SSL certificates are accepted. Default value: **false**., acceptsUntrustedRootCertificate: bool # Indicates if untrusted SSL certificates are accepted. Default value: **false**., additionalSettings: map{includeEventCodes: [str], properties: map}, description: str # Your description for this webhook configuration., networkType: str(local/public) # Network type for Terminal API notification webhooks. Possible values: * **public** * **local**  Default Value: **public**., password: str # Password to access the webhook URL., populateSoapActionHeader: bool # Indicates if the SOAP action header needs to be populated. Default value: **false**.  Only applies if `communicationFormat`: **soap**., sslVersion: str(HTTP/TLSv1.2/TLSv1.3) # SSL version to access the public webhook URL specified in the `url` field. Possible values: * **TLSv1.3** * **TLSv1.2** * **HTTP** - Only allowed on Test environment.  If not specified, the webhook will use `sslVersion`: **TLSv1.2**., username: str # Username to access the webhook URL.}\n@returns(200) {_links: map{company: map{href: str}, generateHmac: map{href: str}, merchant: map{href: str}, self: map{href: str}, testWebhook: map{href: str}}, acceptsExpiredCertificate: bool, acceptsSelfSignedCertificate: bool, acceptsUntrustedRootCertificate: bool, accountReference: str, active: bool, additionalSettings: map{excludeEventCodes: [str], includeEventCodes: [str], properties: map}, certificateAlias: str, communicationFormat: str, description: str, filterMerchantAccountType: str, filterMerchantAccounts: [str], hasError: bool, hasPassword: bool, hmacKeyCheckValue: str, id: str, networkType: str, populateSoapActionHeader: bool, sslVersion: str, type: str, url: str, username: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"type\":\"standard\",\"url\":\"YOUR_WEBHOOK_URL\",\"username\":\"YOUR_USER\",\"password\":\"YOUR_PASSWORD\",\"active\":true,\"sslVersion\":\"TLSv1.2\",\"communicationFormat\":\"json\",\"acceptsExpiredCertificate\":false,\"acceptsSelfSignedCertificate\":true,\"acceptsUntrustedRootCertificate\":true,\"populateSoapActionHeader\":false}\n\n@endpoint DELETE /merchants/{merchantId}/webhooks/{webhookId}\n@desc Remove a webhook\n@required {merchantId: str # The unique identifier of the merchant account., webhookId: str # Unique identifier of the webhook configuration.}\n@returns(204) No Content - look at the actual response code for the status of the request.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint GET /merchants/{merchantId}/webhooks/{webhookId}\n@desc Get a webhook\n@required {merchantId: str # The unique identifier of the merchant account., webhookId: str # Unique identifier of the webhook configuration.}\n@returns(200) {_links: map{company: map{href: str}, generateHmac: map{href: str}, merchant: map{href: str}, self: map{href: str}, testWebhook: map{href: str}}, acceptsExpiredCertificate: bool, acceptsSelfSignedCertificate: bool, acceptsUntrustedRootCertificate: bool, accountReference: str, active: bool, additionalSettings: map{excludeEventCodes: [str], includeEventCodes: [str], properties: map}, certificateAlias: str, communicationFormat: str, description: str, filterMerchantAccountType: str, filterMerchantAccounts: [str], hasError: bool, hasPassword: bool, hmacKeyCheckValue: str, id: str, networkType: str, populateSoapActionHeader: bool, sslVersion: str, type: str, url: str, username: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint PATCH /merchants/{merchantId}/webhooks/{webhookId}\n@desc Update a webhook\n@required {merchantId: str # The unique identifier of the merchant account., webhookId: str # Unique identifier of the webhook configuration.}\n@optional {acceptsExpiredCertificate: bool # Indicates if expired SSL certificates are accepted. Default value: **false**., acceptsSelfSignedCertificate: bool # Indicates if self-signed SSL certificates are accepted. Default value: **false**., acceptsUntrustedRootCertificate: bool # Indicates if untrusted SSL certificates are accepted. Default value: **false**., active: bool # Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account., additionalSettings: map{includeEventCodes: [str], properties: map}, communicationFormat: str(http/json/soap) # Format or protocol for receiving webhooks. Possible values: * **soap** * **http** * **json**, description: str # Your description for this webhook configuration., networkType: str(local/public) # Network type for Terminal API notification webhooks. Possible values: * **public** * **local**  Default Value: **public**., password: str # Password to access the webhook URL., populateSoapActionHeader: bool # Indicates if the SOAP action header needs to be populated. Default value: **false**.  Only applies if `communicationFormat`: **soap**., sslVersion: str(HTTP/TLSv1.2/TLSv1.3) # SSL version to access the public webhook URL specified in the `url` field. Possible values: * **TLSv1.3** * **TLSv1.2** * **HTTP** - Only allowed on Test environment.  If not specified, the webhook will use `sslVersion`: **TLSv1.2**., url: str # Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**., username: str # Username to access the webhook URL.}\n@returns(200) {_links: map{company: map{href: str}, generateHmac: map{href: str}, merchant: map{href: str}, self: map{href: str}, testWebhook: map{href: str}}, acceptsExpiredCertificate: bool, acceptsSelfSignedCertificate: bool, acceptsUntrustedRootCertificate: bool, accountReference: str, active: bool, additionalSettings: map{excludeEventCodes: [str], includeEventCodes: [str], properties: map}, certificateAlias: str, communicationFormat: str, description: str, filterMerchantAccountType: str, filterMerchantAccounts: [str], hasError: bool, hasPassword: bool, hmacKeyCheckValue: str, id: str, networkType: str, populateSoapActionHeader: bool, sslVersion: str, type: str, url: str, username: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"active\":true}\n\n@endpoint POST /merchants/{merchantId}/webhooks/{webhookId}/generateHmac\n@desc Generate an HMAC key\n@required {merchantId: str # The unique identifier of the merchant account., webhookId: str}\n@returns(200) {hmacKey: str} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /merchants/{merchantId}/webhooks/{webhookId}/test\n@desc Test a webhook\n@required {merchantId: str # The unique identifier of the merchant account., webhookId: str # Unique identifier of the webhook configuration.}\n@optional {notification: map{amount: map, eventCode: str, eventDate: str(date-time), merchantReference: str, paymentMethod: str, reason: str, success: bool}, types: [str] # List of event codes for which to send test notifications. Only the webhook types below are supported.   Possible values if webhook `type`: **standard**:  * **AUTHORISATION** * **CHARGEBACK_REVERSED** * **ORDER_CLOSED** * **ORDER_OPENED** * **PAIDOUT_REVERSED** * **PAYOUT_THIRDPARTY** * **REFUNDED_REVERSED** * **REFUND_WITH_DATA** * **REPORT_AVAILABLE** * **CUSTOM** - set your custom notification fields in the [`notification`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/webhooks/{webhookId}/test__reqParam_notification) object.  Possible values if webhook `type`: **banktransfer-notification**:  * **PENDING**  Possible values if webhook `type`: **report-notification**:  * **REPORT_AVAILABLE**  Possible values if webhook `type`: **ideal-notification**:  * **AUTHORISATION**  Possible values if webhook `type`: **pending-notification**:  * **PENDING**}\n@returns(200) {data: [map]} # OK - the request has succeeded.\n@returns(204) No Content - the request has been successfully processed, but there is no additional content.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"types\":[\"AUTHORISATION\"]}\n\n@endgroup\n\n@group stores\n@endpoint GET /stores\n@desc Get a list of stores\n@optional {pageNumber: int(int32) # The number of the page to fetch., pageSize: int(int32) # The number of items to have on a page, maximum 100. The default is 10 items on a page., reference: str # The reference of the store., merchantId: str # The unique identifier of the merchant account.}\n@returns(200) {_links: map{first: map{href: str}, last: map{href: str}, next: map{href: str}, prev: map{href: str}, self: map{href: str}}, data: [map], itemsTotal: int(int32), pagesTotal: int(int32)} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /stores\n@desc Create a store\n@required {address: map{city: str, country!: str, line1: str, line2: str, line3: str, postalCode: str, stateOrProvince: str}, description: str # Your description of the store., merchantId: str # The unique identifier of the merchant account that the store belongs to., phoneNumber: str # The phone number of the store, including '+' and country code., shopperStatement: str # 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.}\n@optional {businessLineIds: [str] # 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., externalReferenceId: str, localizedInformation: map{localShopperStatement!: [map]}, reference: str # Your reference to recognize the store by. Also known as the store code.  Allowed characters: lowercase and uppercase letters without diacritics, numbers 0 through 9, hyphen (-), and underscore (_).  If 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)., splitConfiguration: map{balanceAccountId: str, splitConfigurationId: str}}\n@returns(200) {_links: map{self: map{href: str}}, address: map{city: str, country: str, line1: str, line2: str, line3: str, postalCode: str, stateOrProvince: str}, businessLineIds: [str], description: str, externalReferenceId: str, id: str, localizedInformation: map{localShopperStatement: [map]}, merchantId: str, phoneNumber: str, reference: str, shopperStatement: str, splitConfiguration: map{balanceAccountId: str, splitConfigurationId: str}, status: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"merchantId\":\"YOUR_MERCHANT_ACCOUNT_ID\",\"description\":\"City centre store\",\"shopperStatement\":\"Springfield Shop\",\"phoneNumber\":\"+13123456789\",\"reference\":\"Spring_store_2\",\"address\":{\"country\":\"US\",\"line1\":\"200 Main Street\",\"line2\":\"Building 5A\",\"line3\":\"Suite 3\",\"city\":\"Springfield\",\"stateOrProvince\":\"NY\",\"postalCode\":\"20250\"}}\n\n@endpoint GET /stores/{storeId}\n@desc Get a store\n@required {storeId: str # The unique identifier of the store.}\n@returns(200) {_links: map{self: map{href: str}}, address: map{city: str, country: str, line1: str, line2: str, line3: str, postalCode: str, stateOrProvince: str}, businessLineIds: [str], description: str, externalReferenceId: str, id: str, localizedInformation: map{localShopperStatement: [map]}, merchantId: str, phoneNumber: str, reference: str, shopperStatement: str, splitConfiguration: map{balanceAccountId: str, splitConfigurationId: str}, status: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint PATCH /stores/{storeId}\n@desc Update a store\n@required {storeId: str # The unique identifier of the store.}\n@optional {address: map{city: str, line1: str, line2: str, line3: str, postalCode: str, stateOrProvince: str}, businessLineIds: [str] # 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., description: str # The description of the store., externalReferenceId: str, phoneNumber: str # The phone number of the store, including '+' and country code., splitConfiguration: map{balanceAccountId: str, splitConfigurationId: str}, status: str(active/closed/inactive) # The status of the store. Possible values are:  - **active**: This value is assigned automatically when a store is created.  - **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. - **closed**: The terminals of the store are reassigned to the merchant inventory, so they can't process payments.  You can change the status from **active** to **inactive**, and from **inactive** to **active** or **closed**.  Once **closed**, a store can't be reopened.}\n@returns(200) {_links: map{self: map{href: str}}, address: map{city: str, country: str, line1: str, line2: str, line3: str, postalCode: str, stateOrProvince: str}, businessLineIds: [str], description: str, externalReferenceId: str, id: str, localizedInformation: map{localShopperStatement: [map]}, merchantId: str, phoneNumber: str, reference: str, shopperStatement: str, splitConfiguration: map{balanceAccountId: str, splitConfigurationId: str}, status: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"address\":{\"line1\":\"1776 West Pinewood Avenue\",\"line2\":\"Heartland Building\",\"line3\":\"\",\"postalCode\":\"20251\"}}\n\n@endpoint GET /stores/{storeId}/terminalLogos\n@desc Get the terminal logo\n@required {storeId: str # The unique identifier of the store., model: str # 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.}\n@returns(200) {data: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint PATCH /stores/{storeId}/terminalLogos\n@desc Update the terminal logo\n@required {storeId: str # The unique identifier of the store., model: str # 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.}\n@optional {data: str # The image file, converted to a Base64-encoded string, of the logo to be shown on the terminal.}\n@returns(200) {data: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"data\":\"\"}\n\n@endpoint GET /stores/{storeId}/terminalSettings\n@desc Get terminal settings\n@required {storeId: str # The unique identifier of the store.}\n@returns(200) {cardholderReceipt: map{headerForAuthorizedReceipt: str}, connectivity: map{simcardStatus: str, terminalIPAddressURL: map{eventLocalUrls: [map], eventPublicUrls: [map]}}, gratuities: [map]?, hardware: map{displayMaximumBackLight: int(int32), resetTotalsHour: int(int32), restartHour: int(int32)}, homeScreen: map{hideNavigationBar: bool, showPaymentsMenu: bool, showSettingsMenu: bool}, kioskMode: map{allowedAppsInKioskMode: [str], kioskAppOnStartup: str}, localization: map{language: str, secondaryLanguage: str, timezone: str}, moto: map{enableMoto: bool, maxAmount: int(int32)}, nexo: map{displayUrls: map{localUrls: [map], publicUrls: [map]}, encryptionKey: map{identifier: str, passphrase: str, version: int(int32)}, eventUrls: map{eventLocalUrls: [map], eventPublicUrls: [map]}, nexoEventUrls: [str], notification: map{category: str, details: str, enabled: bool, showButton: bool, title: str}}, offlineProcessing: map{chipFloorLimit: int(int32), offlineSwipeLimits: [map]}, opi: map{enablePayAtTable: bool, payAtTableStoreNumber: str, payAtTableURL: str}, passcodes: map{adminMenuPin: str, refundPin: str, screenLockPin: str, txMenuPin: str}, payAtTable: map{authenticationMethod: str, enablePayAtTable: bool, paymentInstrument: str?}, payment: map{contactlessCurrency: str, hideMinorUnitsInCurrencies: [str]}, receiptOptions: map{logo: str, promptBeforePrinting: bool, qrCodeData: str}, receiptPrinting: map{merchantApproved: bool, merchantCancelled: bool, merchantCaptureApproved: bool, merchantCaptureRefused: bool, merchantRefundApproved: bool, merchantRefundRefused: bool, merchantRefused: bool, merchantVoid: bool, shopperApproved: bool, shopperCancelled: bool, shopperCaptureApproved: bool, shopperCaptureRefused: bool, shopperRefundApproved: bool, shopperRefundRefused: bool, shopperRefused: bool, shopperVoid: bool}, refunds: map{referenced: map{enableStandaloneRefunds: bool}, unreferenced: map{enableUnreferencedRefunds: bool}}, signature: map{askSignatureOnScreen: bool, deviceName: str, deviceSlogan: str, skipSignature: bool}, standalone: map{currencyCode: str, enableGratuities: bool, enableStandalone: bool}, storeAndForward: map{maxAmount: [map], maxPayments: int(int32), supportedCardTypes: map{credit: bool, debit: bool, deferredDebit: bool, prepaid: bool, unknown: bool}}, surcharge: map{askConfirmation: bool, configurations: [map], excludeGratuityFromSurcharge: bool}, tapToPay: map{merchantDisplayName: str}, terminalInstructions: map{adyenAppRestart: bool}, timeouts: map{fromActiveToSleep: int(int32)}, wifiProfiles: map{profiles: [map], settings: map{band: str, roaming: bool, timeout: int(int32)}}} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint PATCH /stores/{storeId}/terminalSettings\n@desc Update terminal settings\n@required {storeId: str # The unique identifier of the store.}\n@optional {cardholderReceipt: map{headerForAuthorizedReceipt: str}, connectivity: map{simcardStatus: str, terminalIPAddressURL: map}, gratuities: [map{allowCustomAmount: bool, currency: str, predefinedTipEntries: [str], usePredefinedTipEntries: bool}] # 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., hardware: map{displayMaximumBackLight: int(int32), resetTotalsHour: int(int32), restartHour: int(int32)}, homeScreen: map{hideNavigationBar: bool, showPaymentsMenu: bool, showSettingsMenu: bool}, kioskMode: map{allowedAppsInKioskMode: [str], kioskAppOnStartup: str}, localization: map{language: str, secondaryLanguage: str, timezone: str}, moto: map{enableMoto: bool, maxAmount: int(int32)}, nexo: map{displayUrls: map, encryptionKey: map, eventUrls: map, nexoEventUrls: [str], notification: map}, offlineProcessing: map{chipFloorLimit: int(int32), offlineSwipeLimits: [map]}, opi: map{enablePayAtTable: bool, payAtTableStoreNumber: str, payAtTableURL: str}, passcodes: map{adminMenuPin: str, refundPin: str, screenLockPin: str, txMenuPin: str}, payAtTable: map{authenticationMethod: str, enablePayAtTable: bool, paymentInstrument: str}, payment: map{contactlessCurrency: str, hideMinorUnitsInCurrencies: [str]}, receiptOptions: map{logo: str, promptBeforePrinting: bool, qrCodeData: str}, receiptPrinting: map{merchantApproved: bool, merchantCancelled: bool, merchantCaptureApproved: bool, merchantCaptureRefused: bool, merchantRefundApproved: bool, merchantRefundRefused: bool, merchantRefused: bool, merchantVoid: bool, shopperApproved: bool, shopperCancelled: bool, shopperCaptureApproved: bool, shopperCaptureRefused: bool, shopperRefundApproved: bool, shopperRefundRefused: bool, shopperRefused: bool, shopperVoid: bool}, refunds: map{referenced: map, unreferenced: map}, signature: map{askSignatureOnScreen: bool, deviceName: str, deviceSlogan: str, skipSignature: bool}, standalone: map{currencyCode: str, enableGratuities: bool, enableStandalone: bool}, storeAndForward: map{maxAmount: [map], maxPayments: int(int32), supportedCardTypes: map}, surcharge: map{askConfirmation: bool, configurations: [map], excludeGratuityFromSurcharge: bool}, tapToPay: map{merchantDisplayName: str}, terminalInstructions: map{adyenAppRestart: bool}, timeouts: map{fromActiveToSleep: int(int32)}, wifiProfiles: map{profiles: [map], settings: map}}\n@returns(200) {cardholderReceipt: map{headerForAuthorizedReceipt: str}, connectivity: map{simcardStatus: str, terminalIPAddressURL: map{eventLocalUrls: [map], eventPublicUrls: [map]}}, gratuities: [map]?, hardware: map{displayMaximumBackLight: int(int32), resetTotalsHour: int(int32), restartHour: int(int32)}, homeScreen: map{hideNavigationBar: bool, showPaymentsMenu: bool, showSettingsMenu: bool}, kioskMode: map{allowedAppsInKioskMode: [str], kioskAppOnStartup: str}, localization: map{language: str, secondaryLanguage: str, timezone: str}, moto: map{enableMoto: bool, maxAmount: int(int32)}, nexo: map{displayUrls: map{localUrls: [map], publicUrls: [map]}, encryptionKey: map{identifier: str, passphrase: str, version: int(int32)}, eventUrls: map{eventLocalUrls: [map], eventPublicUrls: [map]}, nexoEventUrls: [str], notification: map{category: str, details: str, enabled: bool, showButton: bool, title: str}}, offlineProcessing: map{chipFloorLimit: int(int32), offlineSwipeLimits: [map]}, opi: map{enablePayAtTable: bool, payAtTableStoreNumber: str, payAtTableURL: str}, passcodes: map{adminMenuPin: str, refundPin: str, screenLockPin: str, txMenuPin: str}, payAtTable: map{authenticationMethod: str, enablePayAtTable: bool, paymentInstrument: str?}, payment: map{contactlessCurrency: str, hideMinorUnitsInCurrencies: [str]}, receiptOptions: map{logo: str, promptBeforePrinting: bool, qrCodeData: str}, receiptPrinting: map{merchantApproved: bool, merchantCancelled: bool, merchantCaptureApproved: bool, merchantCaptureRefused: bool, merchantRefundApproved: bool, merchantRefundRefused: bool, merchantRefused: bool, merchantVoid: bool, shopperApproved: bool, shopperCancelled: bool, shopperCaptureApproved: bool, shopperCaptureRefused: bool, shopperRefundApproved: bool, shopperRefundRefused: bool, shopperRefused: bool, shopperVoid: bool}, refunds: map{referenced: map{enableStandaloneRefunds: bool}, unreferenced: map{enableUnreferencedRefunds: bool}}, signature: map{askSignatureOnScreen: bool, deviceName: str, deviceSlogan: str, skipSignature: bool}, standalone: map{currencyCode: str, enableGratuities: bool, enableStandalone: bool}, storeAndForward: map{maxAmount: [map], maxPayments: int(int32), supportedCardTypes: map{credit: bool, debit: bool, deferredDebit: bool, prepaid: bool, unknown: bool}}, surcharge: map{askConfirmation: bool, configurations: [map], excludeGratuityFromSurcharge: bool}, tapToPay: map{merchantDisplayName: str}, terminalInstructions: map{adyenAppRestart: bool}, timeouts: map{fromActiveToSleep: int(int32)}, wifiProfiles: map{profiles: [map], settings: map{band: str, roaming: bool, timeout: int(int32)}}} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"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}}}\n\n@endgroup\n\n@group terminals\n@endpoint GET /terminals\n@desc Get a list of terminals\n@optional {searchQuery: str # Returns terminals with an ID that contains the specified string. If present, other query parameters are ignored., otpQuery: str # 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., countries: str # Returns terminals located in the countries specified by their [two-letter country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)., merchantIds: str # Returns terminals that belong to the merchant accounts specified by their unique merchant account ID., storeIds: str # Returns terminals that are assigned to the [stores](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores) specified by their unique store ID., brandModels: str # Returns terminals of the [models](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/companies/{companyId}/terminalModels) specified in the format *brand.model*., pageNumber: int(int32) # The number of the page to fetch., pageSize: int(int32) # The number of items to have on a page, maximum 100. The default is 20 items on a page.}\n@returns(200) {_links: map{first: map{href: str}, last: map{href: str}, next: map{href: str}, prev: map{href: str}, self: map{href: str}}, data: [map], itemsTotal: int(int32), pagesTotal: int(int32)} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint POST /terminals/scheduleActions\n@desc Create a terminal action\n@optional {actionDetails: any # Information about the action to take., scheduledAt: str # The date and time when the action should happen.  Format: [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339), but without the **Z** before the time offset. For example, **2021-11-15T12:16:21+0100**  The 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.  An empty value causes the action to be sent as soon as possible: at the next maintenance call., storeId: str # 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., terminalIds: [str] # 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.}\n@returns(200) {actionDetails: any, items: [map], scheduledAt: str, storeId: str, terminalIds: [str], terminalsWithErrors: map, totalErrors: int(int32), totalScheduled: int(int32)} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"terminalIds\":[\"S1E-000150183300032\",\"S1E-000150183300033\",\"S1F2-000150183300034\"],\"storeId\":\"\",\"scheduledAt\":\"2021-12-12T20:21:22-0100\",\"actionDetails\":{\"type\":\"InstallAndroidApp\",\"appId\":\"ANDA422LZ223223K5F694GCCF732K8\"}}\n\n@endpoint GET /terminals/{terminalId}/terminalLogos\n@desc Get the terminal logo\n@required {terminalId: str # The unique identifier of the payment terminal.}\n@returns(200) {data: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint PATCH /terminals/{terminalId}/terminalLogos\n@desc Update the logo\n@required {terminalId: str # The unique identifier of the payment terminal.}\n@optional {data: str # The image file, converted to a Base64-encoded string, of the logo to be shown on the terminal.}\n@returns(200) {data: str} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"data\":\"\"}\n\n@endpoint GET /terminals/{terminalId}/terminalSettings\n@desc Get terminal settings\n@required {terminalId: str # The unique identifier of the payment terminal.}\n@returns(200) {cardholderReceipt: map{headerForAuthorizedReceipt: str}, connectivity: map{simcardStatus: str, terminalIPAddressURL: map{eventLocalUrls: [map], eventPublicUrls: [map]}}, gratuities: [map]?, hardware: map{displayMaximumBackLight: int(int32), resetTotalsHour: int(int32), restartHour: int(int32)}, homeScreen: map{hideNavigationBar: bool, showPaymentsMenu: bool, showSettingsMenu: bool}, kioskMode: map{allowedAppsInKioskMode: [str], kioskAppOnStartup: str}, localization: map{language: str, secondaryLanguage: str, timezone: str}, moto: map{enableMoto: bool, maxAmount: int(int32)}, nexo: map{displayUrls: map{localUrls: [map], publicUrls: [map]}, encryptionKey: map{identifier: str, passphrase: str, version: int(int32)}, eventUrls: map{eventLocalUrls: [map], eventPublicUrls: [map]}, nexoEventUrls: [str], notification: map{category: str, details: str, enabled: bool, showButton: bool, title: str}}, offlineProcessing: map{chipFloorLimit: int(int32), offlineSwipeLimits: [map]}, opi: map{enablePayAtTable: bool, payAtTableStoreNumber: str, payAtTableURL: str}, passcodes: map{adminMenuPin: str, refundPin: str, screenLockPin: str, txMenuPin: str}, payAtTable: map{authenticationMethod: str, enablePayAtTable: bool, paymentInstrument: str?}, payment: map{contactlessCurrency: str, hideMinorUnitsInCurrencies: [str]}, receiptOptions: map{logo: str, promptBeforePrinting: bool, qrCodeData: str}, receiptPrinting: map{merchantApproved: bool, merchantCancelled: bool, merchantCaptureApproved: bool, merchantCaptureRefused: bool, merchantRefundApproved: bool, merchantRefundRefused: bool, merchantRefused: bool, merchantVoid: bool, shopperApproved: bool, shopperCancelled: bool, shopperCaptureApproved: bool, shopperCaptureRefused: bool, shopperRefundApproved: bool, shopperRefundRefused: bool, shopperRefused: bool, shopperVoid: bool}, refunds: map{referenced: map{enableStandaloneRefunds: bool}, unreferenced: map{enableUnreferencedRefunds: bool}}, signature: map{askSignatureOnScreen: bool, deviceName: str, deviceSlogan: str, skipSignature: bool}, standalone: map{currencyCode: str, enableGratuities: bool, enableStandalone: bool}, storeAndForward: map{maxAmount: [map], maxPayments: int(int32), supportedCardTypes: map{credit: bool, debit: bool, deferredDebit: bool, prepaid: bool, unknown: bool}}, surcharge: map{askConfirmation: bool, configurations: [map], excludeGratuityFromSurcharge: bool}, tapToPay: map{merchantDisplayName: str}, terminalInstructions: map{adyenAppRestart: bool}, timeouts: map{fromActiveToSleep: int(int32)}, wifiProfiles: map{profiles: [map], settings: map{band: str, roaming: bool, timeout: int(int32)}}} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n\n@endpoint PATCH /terminals/{terminalId}/terminalSettings\n@desc Update terminal settings\n@required {terminalId: str # The unique identifier of the payment terminal.}\n@optional {cardholderReceipt: map{headerForAuthorizedReceipt: str}, connectivity: map{simcardStatus: str, terminalIPAddressURL: map}, gratuities: [map{allowCustomAmount: bool, currency: str, predefinedTipEntries: [str], usePredefinedTipEntries: bool}] # 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., hardware: map{displayMaximumBackLight: int(int32), resetTotalsHour: int(int32), restartHour: int(int32)}, homeScreen: map{hideNavigationBar: bool, showPaymentsMenu: bool, showSettingsMenu: bool}, kioskMode: map{allowedAppsInKioskMode: [str], kioskAppOnStartup: str}, localization: map{language: str, secondaryLanguage: str, timezone: str}, moto: map{enableMoto: bool, maxAmount: int(int32)}, nexo: map{displayUrls: map, encryptionKey: map, eventUrls: map, nexoEventUrls: [str], notification: map}, offlineProcessing: map{chipFloorLimit: int(int32), offlineSwipeLimits: [map]}, opi: map{enablePayAtTable: bool, payAtTableStoreNumber: str, payAtTableURL: str}, passcodes: map{adminMenuPin: str, refundPin: str, screenLockPin: str, txMenuPin: str}, payAtTable: map{authenticationMethod: str, enablePayAtTable: bool, paymentInstrument: str}, payment: map{contactlessCurrency: str, hideMinorUnitsInCurrencies: [str]}, receiptOptions: map{logo: str, promptBeforePrinting: bool, qrCodeData: str}, receiptPrinting: map{merchantApproved: bool, merchantCancelled: bool, merchantCaptureApproved: bool, merchantCaptureRefused: bool, merchantRefundApproved: bool, merchantRefundRefused: bool, merchantRefused: bool, merchantVoid: bool, shopperApproved: bool, shopperCancelled: bool, shopperCaptureApproved: bool, shopperCaptureRefused: bool, shopperRefundApproved: bool, shopperRefundRefused: bool, shopperRefused: bool, shopperVoid: bool}, refunds: map{referenced: map, unreferenced: map}, signature: map{askSignatureOnScreen: bool, deviceName: str, deviceSlogan: str, skipSignature: bool}, standalone: map{currencyCode: str, enableGratuities: bool, enableStandalone: bool}, storeAndForward: map{maxAmount: [map], maxPayments: int(int32), supportedCardTypes: map}, surcharge: map{askConfirmation: bool, configurations: [map], excludeGratuityFromSurcharge: bool}, tapToPay: map{merchantDisplayName: str}, terminalInstructions: map{adyenAppRestart: bool}, timeouts: map{fromActiveToSleep: int(int32)}, wifiProfiles: map{profiles: [map], settings: map}}\n@returns(200) {cardholderReceipt: map{headerForAuthorizedReceipt: str}, connectivity: map{simcardStatus: str, terminalIPAddressURL: map{eventLocalUrls: [map], eventPublicUrls: [map]}}, gratuities: [map]?, hardware: map{displayMaximumBackLight: int(int32), resetTotalsHour: int(int32), restartHour: int(int32)}, homeScreen: map{hideNavigationBar: bool, showPaymentsMenu: bool, showSettingsMenu: bool}, kioskMode: map{allowedAppsInKioskMode: [str], kioskAppOnStartup: str}, localization: map{language: str, secondaryLanguage: str, timezone: str}, moto: map{enableMoto: bool, maxAmount: int(int32)}, nexo: map{displayUrls: map{localUrls: [map], publicUrls: [map]}, encryptionKey: map{identifier: str, passphrase: str, version: int(int32)}, eventUrls: map{eventLocalUrls: [map], eventPublicUrls: [map]}, nexoEventUrls: [str], notification: map{category: str, details: str, enabled: bool, showButton: bool, title: str}}, offlineProcessing: map{chipFloorLimit: int(int32), offlineSwipeLimits: [map]}, opi: map{enablePayAtTable: bool, payAtTableStoreNumber: str, payAtTableURL: str}, passcodes: map{adminMenuPin: str, refundPin: str, screenLockPin: str, txMenuPin: str}, payAtTable: map{authenticationMethod: str, enablePayAtTable: bool, paymentInstrument: str?}, payment: map{contactlessCurrency: str, hideMinorUnitsInCurrencies: [str]}, receiptOptions: map{logo: str, promptBeforePrinting: bool, qrCodeData: str}, receiptPrinting: map{merchantApproved: bool, merchantCancelled: bool, merchantCaptureApproved: bool, merchantCaptureRefused: bool, merchantRefundApproved: bool, merchantRefundRefused: bool, merchantRefused: bool, merchantVoid: bool, shopperApproved: bool, shopperCancelled: bool, shopperCaptureApproved: bool, shopperCaptureRefused: bool, shopperRefundApproved: bool, shopperRefundRefused: bool, shopperRefused: bool, shopperVoid: bool}, refunds: map{referenced: map{enableStandaloneRefunds: bool}, unreferenced: map{enableUnreferencedRefunds: bool}}, signature: map{askSignatureOnScreen: bool, deviceName: str, deviceSlogan: str, skipSignature: bool}, standalone: map{currencyCode: str, enableGratuities: bool, enableStandalone: bool}, storeAndForward: map{maxAmount: [map], maxPayments: int(int32), supportedCardTypes: map{credit: bool, debit: bool, deferredDebit: bool, prepaid: bool, unknown: bool}}, surcharge: map{askConfirmation: bool, configurations: [map], excludeGratuityFromSurcharge: bool}, tapToPay: map{merchantDisplayName: str}, terminalInstructions: map{adyenAppRestart: bool}, timeouts: map{fromActiveToSleep: int(int32)}, wifiProfiles: map{profiles: [map], settings: map{band: str, roaming: bool, timeout: int(int32)}}} # OK - the request has succeeded.\n@errors {400: Bad Request - a problem reading or understanding the request., 401: Unauthorized - authentication required., 403: Forbidden - insufficient permissions to process the request., 422: Unprocessable Entity - a request validation error., 500: Internal Server Error - the server could not process the request.}\n@example_request {\"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}}}\n\n@endgroup\n\n@end\n"}