diff --git a/json/ManagementNotificationService-v1.json b/json/ManagementNotificationService-v1.json index 325e5f9..981a2e8 100644 --- a/json/ManagementNotificationService-v1.json +++ b/json/ManagementNotificationService-v1.json @@ -11,10 +11,6 @@ "url" : "https://github.com/Adyen/adyen-openapi" } }, - "x-groups" : [ - "Merchant account", - "Payment method" - ], "tags" : [ { "name" : "Merchant account" @@ -34,7 +30,6 @@ "description" : "A merchant account [was created](https://docs.adyen.com/api-explorer/#/ManagementService/latest/post/merchants).", "x-addedInVersion" : "1", "operationId" : "post-merchant.created", - "x-groupName" : "Merchant account", "x-sortIndex" : 1, "x-methodName" : "merchantAccountCreated", "security" : [ @@ -85,7 +80,6 @@ "description" : "There were changes to the verification status and capabilities of a [merchant account](https://docs.adyen.com/api-explorer/#/ManagementService/latest/post/merchants). If the verification fails, this webhook includes the errors and the actions that you can take to resolve them.", "x-addedInVersion" : "1", "operationId" : "post-merchant.updated", - "x-groupName" : "Merchant account", "x-sortIndex" : 2, "x-methodName" : "merchantAccountCapabilityUpdated", "security" : [ @@ -142,7 +136,6 @@ "description" : "A request to [add a payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings) was completed.", "x-addedInVersion" : "1", "operationId" : "post-paymentMethod.created", - "x-groupName" : "Payment method", "x-sortIndex" : 1, "x-methodName" : "paymentMethodCreated", "security" : [ diff --git a/json/ManagementNotificationService-v3.json b/json/ManagementNotificationService-v3.json index 8144d4c..b15a574 100644 --- a/json/ManagementNotificationService-v3.json +++ b/json/ManagementNotificationService-v3.json @@ -11,10 +11,6 @@ "url" : "https://github.com/Adyen/adyen-openapi" } }, - "x-groups" : [ - "Merchant account", - "Payment method" - ], "tags" : [ { "name" : "Merchant account" @@ -34,7 +30,6 @@ "description" : "A merchant account [was created](https://docs.adyen.com/api-explorer/#/ManagementService/latest/post/merchants).", "x-addedInVersion" : "1", "operationId" : "post-merchant.created", - "x-groupName" : "Merchant account", "x-sortIndex" : 1, "x-methodName" : "merchantAccountCreated", "security" : [ @@ -85,7 +80,6 @@ "description" : "There were changes to the verification status and capabilities of a [merchant account](https://docs.adyen.com/api-explorer/#/ManagementService/latest/post/merchants). If the verification fails, this webhook includes the errors and the actions that you can take to resolve them.", "x-addedInVersion" : "1", "operationId" : "post-merchant.updated", - "x-groupName" : "Merchant account", "x-sortIndex" : 2, "x-methodName" : "merchantAccountCapabilityUpdated", "security" : [ @@ -142,7 +136,6 @@ "description" : "A request to [add a payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings) was completed.", "x-addedInVersion" : "1", "operationId" : "post-paymentMethod.created", - "x-groupName" : "Payment method", "x-sortIndex" : 1, "x-methodName" : "paymentMethodCreated", "security" : [ @@ -193,7 +186,6 @@ "description" : "A request to add a payment method is removed. You must make another request to [add a payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings).", "x-addedInVersion" : "2", "operationId" : "post-paymentMethod.requestRemoved", - "x-groupName" : "Payment method", "x-sortIndex" : 3, "x-methodName" : "paymentMethodRequestRemoved", "security" : [ @@ -244,7 +236,6 @@ "description" : "A request to [add a payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings) will be removed in 30 days. To make sure the payment method is added, provide the missing [KYC information](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details).", "x-addedInVersion" : "2", "operationId" : "post-paymentMethod.requestScheduledForRemoval", - "x-groupName" : "Payment method", "x-sortIndex" : 2, "x-methodName" : "paymentMethodRequestScheduledForRemoval", "security" : [ diff --git a/json/ManagementService-v1.json b/json/ManagementService-v1.json index 9c49aae..f3884ad 100644 --- a/json/ManagementService-v1.json +++ b/json/ManagementService-v1.json @@ -16,37 +16,6 @@ "url" : "https://github.com/Adyen/adyen-openapi" } }, - "x-groups" : [ - "Account - company level", - "Account - merchant level", - "Account - store level", - "Payout settings - merchant level", - "Users - company level", - "Users - merchant level", - "My API credential", - "API credentials - company level", - "API credentials - merchant level", - "API key - company level", - "API key - merchant level", - "Client key - company level", - "Client key - merchant level", - "Allowed origins - company level", - "Allowed origins - merchant level", - "Webhooks - company level", - "Webhooks - merchant level", - "Payment methods - merchant level", - "Terminals - terminal level", - "Terminal actions - company level", - "Terminal actions - terminal level", - "Terminal orders - company level", - "Terminal orders - merchant level", - "Terminal settings - company level", - "Terminal settings - merchant level", - "Terminal settings - store level", - "Terminal settings - terminal level", - "Android files - company level", - "Split configuration - merchant level" - ], "tags" : [ { "name" : "Account - company level" @@ -145,7 +114,6 @@ "summary" : "Get a list of company accounts", "description" : "Returns the list of company accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\n* Management API—Account read", "operationId" : "get-companies", - "x-groupName" : "Account - company level", "x-sortIndex" : 0, "x-methodName" : "listCompanyAccounts", "security" : [ @@ -257,7 +225,6 @@ "summary" : "Get a company account", "description" : "Returns the company account specified in the path. Your API credential must have access to the company account. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Account read", "operationId" : "get-companies-companyId", - "x-groupName" : "Account - company level", "x-sortIndex" : 0, "x-methodName" : "getCompanyAccount", "security" : [ @@ -358,7 +325,6 @@ "summary" : "Get a list of Android apps", "description" : "Returns a list of the Android apps that are available for the company identified in the path. \nThese apps have been uploaded to Adyen and can be installed or uninstalled on Android payment terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Android files read\n* Management API—Android files read and write\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write", "operationId" : "get-companies-companyId-androidApps", - "x-groupName" : "Android files - company level", "x-sortIndex" : 1, "x-methodName" : "listAndroidApps", "security" : [ @@ -498,7 +464,6 @@ "summary" : "Get Android app", "description" : "Returns the details of the Android app identified in the path. \nThese apps have been uploaded to Adyen and can be installed or uninstalled on Android payment terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Android files read\n* Management API—Android files read and write", "operationId" : "get-companies-companyId-androidApps-id", - "x-groupName" : "Android files - company level", "x-sortIndex" : 3, "x-methodName" : "getAndroidApp", "security" : [ @@ -603,7 +568,6 @@ "summary" : "Get a list of Android certificates", "description" : "Returns a list of the Android certificates that are available for the company identified in the path.\nTypically, these certificates enable running apps on Android payment terminals. The certifcates in the list have been uploaded to Adyen and can be installed or uninstalled on Android terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Android files read\n* Management API—Android files read and write\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write", "operationId" : "get-companies-companyId-androidCertificates", - "x-groupName" : "Android files - company level", "x-sortIndex" : 2, "x-methodName" : "listAndroidCertificates", "security" : [ @@ -733,7 +697,6 @@ "summary" : "Get a list of API credentials", "description" : "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the company account. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "get-companies-companyId-apiCredentials", - "x-groupName" : "API credentials - company level", "x-sortIndex" : 0, "x-methodName" : "listApiCredentials", "security" : [ @@ -852,7 +815,6 @@ "summary" : "Create an API credential.", "description" : "Creates an [API credential](https://docs.adyen.com/development-resources/api-credentials) for the company account identified in the path. In the request, you can specify which merchant accounts the new API credential will have access to, as well as its roles and allowed origins.\n\nThe response includes several types of authentication details:\n* [API key](https://docs.adyen.com/development-resources/api-authentication#api-key-authentication): used for API request authentication.\n* [Client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works): public key used for client-side authentication.\n* [Username and password](https://docs.adyen.com/development-resources/api-authentication#using-basic-authentication): used for basic authentication.\n\n> Make sure you store the API key securely in your system. You won't be able to retrieve it later.\n\nIf your API key is lost or compromised, you need to [generate a new API key](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/apiCredentials/{apiCredentialId}/generateApiKey).\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "post-companies-companyId-apiCredentials", - "x-groupName" : "API credentials - company level", "x-sortIndex" : 0, "x-methodName" : "createApiCredential", "security" : [ @@ -967,7 +929,6 @@ "summary" : "Get an API credential", "description" : "Returns the [API credential](https://docs.adyen.com/development-resources/api-credentials) identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "get-companies-companyId-apiCredentials-apiCredentialId", - "x-groupName" : "API credentials - company level", "x-sortIndex" : 0, "x-methodName" : "getApiCredential", "security" : [ @@ -1075,7 +1036,6 @@ "summary" : "Update an API credential.", "description" : "Changes the API credential's roles, merchant account access, or allowed origins. The request has the new values for the fields you want to change. The response contains the full updated API credential, including the new values from the request. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "patch-companies-companyId-apiCredentials-apiCredentialId", - "x-groupName" : "API credentials - company level", "x-sortIndex" : 0, "x-methodName" : "updateApiCredential", "security" : [ @@ -1199,7 +1159,6 @@ "summary" : "Get a list of allowed origins", "description" : "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "get-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins", - "x-groupName" : "Allowed origins - company level", "x-sortIndex" : 0, "x-methodName" : "listAllowedOrigins", "security" : [ @@ -1307,7 +1266,6 @@ "summary" : "Create an allowed origin", "description" : "Adds a new [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) to the API credential's list of allowed origins.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "post-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins", - "x-groupName" : "Allowed origins - company level", "x-sortIndex" : 0, "x-methodName" : "createAllowedOrigin", "security" : [ @@ -1431,7 +1389,6 @@ "summary" : "Delete an allowed origin", "description" : "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. As soon as an allowed origin is removed, we no longer accept client-side requests from that domain.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "delete-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-originId", - "x-groupName" : "Allowed origins - company level", "x-sortIndex" : 0, "x-methodName" : "deleteAllowedOrigin", "security" : [ @@ -1536,7 +1493,6 @@ "summary" : "Get an allowed origin", "description" : "Returns the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "get-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-originId", - "x-groupName" : "Allowed origins - company level", "x-sortIndex" : 0, "x-methodName" : "getAllowedOrigin", "security" : [ @@ -1655,7 +1611,6 @@ "summary" : "Generate new API key", "description" : "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "post-companies-companyId-apiCredentials-apiCredentialId-generateApiKey", - "x-groupName" : "API key - company level", "x-sortIndex" : 0, "x-methodName" : "generateNewApiKey", "security" : [ @@ -1760,7 +1715,6 @@ "summary" : "Generate new client key", "description" : "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "post-companies-companyId-apiCredentials-apiCredentialId-generateClientKey", - "x-groupName" : "Client key - company level", "x-sortIndex" : 0, "x-methodName" : "generateNewClientKey", "security" : [ @@ -1865,7 +1819,6 @@ "summary" : "Get a list of billing entities", "description" : "Returns the billing entities of the company identified in the path and all merchant accounts belonging to the company.\nA billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write", "operationId" : "get-companies-companyId-billingEntities", - "x-groupName" : "Terminal orders - company level", "x-sortIndex" : 3, "x-methodName" : "listBillingEntities", "security" : [ @@ -1975,7 +1928,6 @@ "summary" : "Get a list of merchant accounts", "description" : "Returns the list of merchant accounts under the company account specified in the path. The list only includes merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Account read", "operationId" : "get-companies-companyId-merchants", - "x-groupName" : "Account - company level", "x-sortIndex" : 0, "x-methodName" : "listMerchantAccounts", "security" : [ @@ -2096,7 +2048,6 @@ "summary" : "Get a list of shipping locations", "description" : "Returns the shipping locations for the company identified in the path and all merchant accounts belonging to the company.\nA shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write", "operationId" : "get-companies-companyId-shippingLocations", - "x-groupName" : "Terminal orders - company level", "x-sortIndex" : 4, "x-methodName" : "listShippingLocations", "security" : [ @@ -2224,7 +2175,6 @@ "summary" : "Create a shipping location", "description" : "Creates a shipping location for the company identified in the path. A shipping location defines an address where orders can be delivered.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write", "operationId" : "post-companies-companyId-shippingLocations", - "x-groupName" : "Terminal orders - company level", "x-sortIndex" : 5, "x-methodName" : "createShippingLocation", "security" : [ @@ -2339,7 +2289,6 @@ "summary" : "Get a list of terminal actions", "description" : "Returns the [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) that have been scheduled for the company identified in the path.The response doesn't include actions that are scheduled by Adyen.\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write", "operationId" : "get-companies-companyId-terminalActions", - "x-groupName" : "Terminal actions - company level", "x-sortIndex" : 1, "x-methodName" : "listTerminalActions", "security" : [ @@ -2478,7 +2427,6 @@ "summary" : "Get terminal action", "description" : "Returns the details of the [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) identified in the path.\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write", "operationId" : "get-companies-companyId-terminalActions-actionId", - "x-groupName" : "Terminal actions - company level", "x-sortIndex" : 2, "x-methodName" : "getTerminalAction", "security" : [ @@ -2588,7 +2536,6 @@ "summary" : "Get the terminal logo", "description" : "Returns the logo that is configured for a specific payment terminal model at the company identified in the path. \n\nThe logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. \nThis logo applies to all terminals of the specified model under the company, unless a different logo is configured at a lower level (merchant account, store, or individual terminal).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write", "operationId" : "get-companies-companyId-terminalLogos", - "x-groupName" : "Terminal settings - company level", "x-sortIndex" : 2, "x-methodName" : "getTerminalLogo", "security" : [ @@ -2696,7 +2643,6 @@ "summary" : "Update the terminal logo", "description" : "Updates the logo that is configured for a specific payment terminal model at the company identified in the path. You can update the logo for only one terminal model at a time.\nThis logo applies to all terminals of the specified model under the company, unless a different logo is configured at a lower level (merchant account, store, or individual terminal). \n* To change the logo, specify the image file as a Base64-encoded string.\n* To restore the logo inherited from the Adyen PSP level, specify an empty logo value.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write", "operationId" : "patch-companies-companyId-terminalLogos", - "x-groupName" : "Terminal settings - company level", "x-sortIndex" : 4, "x-methodName" : "updateTerminalLogo", "security" : [ @@ -2826,7 +2772,6 @@ "summary" : "Get a list of terminal models", "description" : "Returns a list of payment terminal models that the company identified in the path has access to.\nThe response includes the terminal model ID, which can be used as a query parameter when getting a list of terminals or a list of products for ordering.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write", "operationId" : "get-companies-companyId-terminalModels", - "x-groupName" : "Terminal orders - company level", "x-sortIndex" : 1, "x-methodName" : "listTerminalModels", "security" : [ @@ -2927,7 +2872,6 @@ "summary" : "Get a list of orders", "description" : "Returns a lists of terminal products orders for the company identified in the path.\nTo filter the list, use one or more of the query parameters.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write", "operationId" : "get-companies-companyId-terminalOrders", - "x-groupName" : "Terminal orders - company level", "x-sortIndex" : 7, "x-methodName" : "listOrders", "security" : [ @@ -3064,7 +3008,6 @@ "summary" : "Create an order", "description" : "Creates an order for payment terminal products for the company identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write\n>Requests to the Management API test endpoint do not create actual orders for test terminals. To order test terminals, you need to [submit a sales order](https://docs.adyen.com/point-of-sale/managing-terminals/order-terminals/#sales-order-steps) in your Customer Area.", "operationId" : "post-companies-companyId-terminalOrders", - "x-groupName" : "Terminal orders - company level", "x-sortIndex" : 6, "x-methodName" : "createOrder", "security" : [ @@ -3179,7 +3122,6 @@ "summary" : "Get an order", "description" : "Returns the details of the terminal products order identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write", "operationId" : "get-companies-companyId-terminalOrders-orderId", - "x-groupName" : "Terminal orders - company level", "x-sortIndex" : 8, "x-methodName" : "getOrder", "security" : [ @@ -3287,7 +3229,6 @@ "summary" : "Update an order", "description" : "Updates the terminal products order identified in the path.\nUpdating is only possible while the order has the status **Placed**.\n\nThe request body only needs to contain what you want to change. \nHowever, to update the products in the `items` array, you must provide the entire array. For example, if the array has three items:\n To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write", "operationId" : "patch-companies-companyId-terminalOrders-orderId", - "x-groupName" : "Terminal orders - company level", "x-sortIndex" : 9, "x-methodName" : "updateOrder", "security" : [ @@ -3411,7 +3352,6 @@ "summary" : "Cancel an order", "description" : "Cancels the terminal products order identified in the path.\nCancelling is only possible while the order has the status **Placed**.\nTo cancel an order, make a POST call without a request body. The response returns the full order details, but with the status changed to **Cancelled**.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write", "operationId" : "post-companies-companyId-terminalOrders-orderId-cancel", - "x-groupName" : "Terminal orders - company level", "x-sortIndex" : 10, "x-methodName" : "cancelOrder", "security" : [ @@ -3521,7 +3461,6 @@ "summary" : "Get a list of terminal products", "description" : "Returns a country-specific list of payment terminal packages and parts that the company identified in the path has access to.\n \nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write", "operationId" : "get-companies-companyId-terminalProducts", - "x-groupName" : "Terminal orders - company level", "x-sortIndex" : 2, "x-methodName" : "listTerminalProducts", "security" : [ @@ -3660,7 +3599,6 @@ "summary" : "Get terminal settings", "description" : "Returns the payment terminal settings that are configured for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level (merchant account, store, or individual terminal).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write", "operationId" : "get-companies-companyId-terminalSettings", - "x-groupName" : "Terminal settings - company level", "x-sortIndex" : 1, "x-methodName" : "getTerminalSettings", "security" : [ @@ -3759,7 +3697,6 @@ "summary" : "Update terminal settings", "description" : "Updates payment terminal settings for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level (merchant account, store, or individual terminal).\n\n* To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.\n* To restore a parameter value inherited from the Adyen PSP level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter.\n* Objects that are not included in the request are not updated.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write", "operationId" : "patch-companies-companyId-terminalSettings", - "x-groupName" : "Terminal settings - company level", "x-sortIndex" : 3, "x-methodName" : "updateTerminalSettings", "security" : [ @@ -3880,7 +3817,6 @@ "summary" : "Get a list of users", "description" : "Returns the list of users for the `companyId` identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n", "operationId" : "get-companies-companyId-users", - "x-groupName" : "Users - company level", "x-sortIndex" : 0, "x-methodName" : "listUsers", "security" : [ @@ -4003,7 +3939,6 @@ "summary" : "Create a new user", "description" : "Creates the user for the `companyId` identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n", "operationId" : "post-companies-companyId-users", - "x-groupName" : "Users - company level", "x-sortIndex" : 0, "x-methodName" : "createNewUser", "security" : [ @@ -4118,7 +4053,6 @@ "summary" : "Get user details", "description" : "Returns user details for the `userId` and the `companyId` identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n", "operationId" : "get-companies-companyId-users-userId", - "x-groupName" : "Users - company level", "x-sortIndex" : 0, "x-methodName" : "getUserDetails", "security" : [ @@ -4221,7 +4155,6 @@ "summary" : "Update user details", "description" : "Updates user details for the `userId` and the `companyId` identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n", "operationId" : "patch-companies-companyId-users-userId", - "x-groupName" : "Users - company level", "x-sortIndex" : 0, "x-methodName" : "updateUserDetails", "security" : [ @@ -4335,7 +4268,6 @@ "summary" : "List all webhooks", "description" : "Lists all webhook configurations for the company account.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read\n* Management API—Webhooks read and write", "operationId" : "get-companies-companyId-webhooks", - "x-groupName" : "Webhooks - company level", "x-sortIndex" : 2, "x-methodName" : "listAllWebhooks", "security" : [ @@ -4454,7 +4386,6 @@ "summary" : "Set up a webhook", "description" : "Subscribe to receive webhook notifications about events related to your company account. You can add basic authentication to make sure the data is secure.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write", "operationId" : "post-companies-companyId-webhooks", - "x-groupName" : "Webhooks - company level", "x-sortIndex" : 1, "x-methodName" : "setUpWebhook", "security" : [ @@ -4569,7 +4500,6 @@ "summary" : "Remove a webhook", "description" : "Remove the configuration for the webhook identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write", "operationId" : "delete-companies-companyId-webhooks-webhookId", - "x-groupName" : "Webhooks - company level", "x-sortIndex" : 5, "x-methodName" : "removeWebhook", "security" : [ @@ -4665,7 +4595,6 @@ "summary" : "Get a webhook", "description" : "Returns the configuration for the webhook identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read\n* Management API—Webhooks read and write", "operationId" : "get-companies-companyId-webhooks-webhookId", - "x-groupName" : "Webhooks - company level", "x-sortIndex" : 3, "x-methodName" : "getWebhook", "security" : [ @@ -4773,7 +4702,6 @@ "summary" : "Update a webhook", "description" : "Make changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration. The response contains the full configuration for the webhook, which includes the new values from the request.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write", "operationId" : "patch-companies-companyId-webhooks-webhookId", - "x-groupName" : "Webhooks - company level", "x-sortIndex" : 4, "x-methodName" : "updateWebhook", "security" : [ @@ -4897,7 +4825,6 @@ "summary" : "Generate an HMAC key", "description" : "Returns an [HMAC key](https://en.wikipedia.org/wiki/HMAC) for the webhook identified in the path. This key allows you to check the integrity and the origin of the notifications you receive.By creating an HMAC key, you start receiving [HMAC-signed notifications](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures#enable-hmac-signatures) from Adyen. Find out more about how to [verify HMAC signatures](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures).\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write", "operationId" : "post-companies-companyId-webhooks-webhookId-generateHmac", - "x-groupName" : "Webhooks - company level", "x-sortIndex" : 6, "x-methodName" : "generateHmacKey", "security" : [ @@ -5007,7 +4934,6 @@ "summary" : "Test a webhook", "description" : "Sends sample notifications to test if the webhook is set up correctly.\n\nWe send sample notifications for maximum 20 of the merchant accounts that the webhook is configured for. If the webhook is configured for more than 20 merchant accounts, use the `merchantIds` array to specify a subset of the merchant accounts for which to send test notifications.\n\nWe send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP, regardless of the currencies configured in the merchant accounts. For custom notifications, we only send the specified custom notification.\n\nThe response describes the result of the test. The `status` field tells you if the test was successful or not. You can use the other response fields to troubleshoot unsuccessful tests.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write", "operationId" : "post-companies-companyId-webhooks-webhookId-test", - "x-groupName" : "Webhooks - company level", "x-sortIndex" : 7, "x-methodName" : "testWebhook", "security" : [ @@ -5131,7 +5057,6 @@ "summary" : "Get API credential details", "description" : "Returns your [API credential](https://docs.adyen.com/development-resources/api-credentials) details based on the API Key you used in the request.\n\nYou can make this request with any of the Management API roles.", "operationId" : "get-me", - "x-groupName" : "My API credential", "x-sortIndex" : 0, "x-methodName" : "getApiCredentialDetails", "security" : [ @@ -5216,7 +5141,6 @@ "summary" : "Get allowed origins", "description" : "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) of your [API credential](https://docs.adyen.com/development-resources/api-credentials) based on the API key you used in the request.\n\nYou can make this request with any of the Management API roles.", "operationId" : "get-me-allowedOrigins", - "x-groupName" : "My API credential", "x-sortIndex" : 0, "x-methodName" : "getAllowedOrigins", "security" : [ @@ -5299,7 +5223,6 @@ "summary" : "Add allowed origin", "description" : "Adds an allowed origin to the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) of your API credential.\nThe API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials).\n\nYou can make this request with any of the Management API roles.", "operationId" : "post-me-allowedOrigins", - "x-groupName" : "My API credential", "x-sortIndex" : 0, "x-methodName" : "addAllowedOrigin", "security" : [ @@ -5393,7 +5316,6 @@ "summary" : "Remove allowed origin", "description" : "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) specified in the path.\nThe API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials).\n\nYou can make this request with any of the Management API roles.", "operationId" : "delete-me-allowedOrigins-originId", - "x-groupName" : "My API credential", "x-sortIndex" : 0, "x-methodName" : "removeAllowedOrigin", "security" : [ @@ -5480,7 +5402,6 @@ "summary" : "Get allowed origin details", "description" : "Returns the details of the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) specified in the path.\nThe API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials).\n\nYou can make this request with any of the Management API roles.", "operationId" : "get-me-allowedOrigins-originId", - "x-groupName" : "My API credential", "x-sortIndex" : 0, "x-methodName" : "getAllowedOriginDetails", "security" : [ @@ -5576,7 +5497,6 @@ "summary" : "Generate a client key", "description" : "Generates a new [client key](https://docs.adyen.com/development-resources/client-side-authentication/) used to authenticate requests from your payment environment.\nYou can use the new client key a few minutes after generating it.\nThe old client key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "post-me-generateClientKey", - "x-groupName" : "My API credential", "x-sortIndex" : 0, "x-methodName" : "generateClientKey", "security" : [ @@ -5661,7 +5581,6 @@ "summary" : "Get a list of merchant accounts", "description" : "Returns the list of merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Account read", "operationId" : "get-merchants", - "x-groupName" : "Account - merchant level", "x-sortIndex" : 4, "x-methodName" : "listMerchantAccounts", "security" : [ @@ -5774,7 +5693,6 @@ "summary" : "Create a merchant account", "description" : "Creates a merchant account for the company account specified in the request.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Accounts read and write", "operationId" : "post-merchants", - "x-groupName" : "Account - merchant level", "x-sortIndex" : 1, "x-methodName" : "createMerchantAccount", "security" : [ @@ -5881,7 +5799,6 @@ "summary" : "Get a merchant account", "description" : "Returns the merchant account specified in the path. Your API credential must have access to the merchant account.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Account read", "operationId" : "get-merchants-merchantId", - "x-groupName" : "Account - merchant level", "x-sortIndex" : 3, "x-methodName" : "getMerchantAccount", "security" : [ @@ -5985,7 +5902,6 @@ "summary" : "Request to activate a merchant account", "description" : "Sends a request to activate the merchant account identified in the path.\n\nYou get the result of the activation asynchronously through a [`merchant.updated`](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.updated) webhook. Once the merchant account is activated, you can start using it to accept payments and payouts.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Accounts read and write", "operationId" : "post-merchants-merchantId-activate", - "x-groupName" : "Account - merchant level", "x-sortIndex" : 2, "x-methodName" : "requestToActivateMerchantAccount", "security" : [ @@ -6084,7 +6000,6 @@ "summary" : "Get a list of API credentials", "description" : "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the merchant account. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "get-merchants-merchantId-apiCredentials", - "x-groupName" : "API credentials - merchant level", "x-sortIndex" : 0, "x-methodName" : "listApiCredentials", "security" : [ @@ -6206,7 +6121,6 @@ "summary" : "Create an API credential", "description" : "Creates an [API credential](https://docs.adyen.com/development-resources/api-credentials) for the company account identified in the path. In the request, you can specify the roles and allowed origins for the new API credential.\n\nThe response includes the:\n* [API key](https://docs.adyen.com/development-resources/api-authentication#api-key-authentication): used for API request authentication.\n* [Client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works): public key used for client-side authentication.\n* [Username and password](https://docs.adyen.com/development-resources/api-authentication#using-basic-authentication): used for basic authentication.\n\n> Make sure you store the API key securely in your system. You won't be able to retrieve it later.\n\nIf your API key is lost or compromised, you need to [generate a new API key](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateApiKey).\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "post-merchants-merchantId-apiCredentials", - "x-groupName" : "API credentials - merchant level", "x-sortIndex" : 0, "x-methodName" : "createApiCredential", "security" : [ @@ -6324,7 +6238,6 @@ "summary" : "Get an API credential", "description" : "Returns the [API credential](https://docs.adyen.com/development-resources/api-credentials) identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "get-merchants-merchantId-apiCredentials-apiCredentialId", - "x-groupName" : "API credentials - merchant level", "x-sortIndex" : 0, "x-methodName" : "getApiCredential", "security" : [ @@ -6435,7 +6348,6 @@ "summary" : "Update an API credential", "description" : "Changes the API credential's roles, or allowed origins. The request has the new values for the fields you want to change. The response contains the full updated API credential, including the new values from the request. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "patch-merchants-merchantId-apiCredentials-apiCredentialId", - "x-groupName" : "API credentials - merchant level", "x-sortIndex" : 0, "x-methodName" : "updateApiCredential", "security" : [ @@ -6562,7 +6474,6 @@ "summary" : "Get a list of allowed origins", "description" : "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "get-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins", - "x-groupName" : "Allowed origins - merchant level", "x-sortIndex" : 0, "x-methodName" : "listAllowedOrigins", "security" : [ @@ -6673,7 +6584,6 @@ "summary" : "Create an allowed origin", "description" : "Adds a new [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) to the API credential's list of allowed origins.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "post-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins", - "x-groupName" : "Allowed origins - merchant level", "x-sortIndex" : 0, "x-methodName" : "createAllowedOrigin", "security" : [ @@ -6800,7 +6710,6 @@ "summary" : "Delete an allowed origin", "description" : "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. As soon as an allowed origin is removed, we no longer accept client-side requests from that domain.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "delete-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-originId", - "x-groupName" : "Allowed origins - merchant level", "x-sortIndex" : 0, "x-methodName" : "deleteAllowedOrigin", "security" : [ @@ -6905,7 +6814,6 @@ "summary" : "Get an allowed origin", "description" : "Returns the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "get-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-originId", - "x-groupName" : "Allowed origins - merchant level", "x-sortIndex" : 0, "x-methodName" : "getAllowedOrigin", "security" : [ @@ -7027,7 +6935,6 @@ "summary" : "Generate new API key", "description" : "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "post-merchants-merchantId-apiCredentials-apiCredentialId-generateApiKey", - "x-groupName" : "API key - merchant level", "x-sortIndex" : 0, "x-methodName" : "generateNewApiKey", "security" : [ @@ -7135,7 +7042,6 @@ "summary" : "Generate new client key", "description" : "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "post-merchants-merchantId-apiCredentials-apiCredentialId-generateClientKey", - "x-groupName" : "Client key - merchant level", "x-sortIndex" : 0, "x-methodName" : "generateNewClientKey", "security" : [ @@ -7243,7 +7149,6 @@ "summary" : "Get a list of billing entities", "description" : "Returns the billing entities of the merchant account identified in the path.\nA billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write", "operationId" : "get-merchants-merchantId-billingEntities", - "x-groupName" : "Terminal orders - merchant level", "x-sortIndex" : 3, "x-methodName" : "listBillingEntities", "security" : [ @@ -7356,7 +7261,6 @@ "summary" : "Get all payment methods", "description" : "Returns details for all payment methods of the merchant account identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read\n", "operationId" : "get-merchants-merchantId-paymentMethodSettings", - "x-groupName" : "Payment methods - merchant level", "x-sortIndex" : 2, "x-methodName" : "getAllPaymentMethods", "security" : [ @@ -7491,7 +7395,6 @@ "summary" : "Request a payment method", "description" : "Sends a request to add a new payment method to the merchant account identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read and write\n", "operationId" : "post-merchants-merchantId-paymentMethodSettings", - "x-groupName" : "Payment methods - merchant level", "x-sortIndex" : 1, "x-methodName" : "requestPaymentMethod", "security" : [ @@ -7615,7 +7518,6 @@ "summary" : "Get payment method details", "description" : "Returns details for the merchant account and the payment method identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read\n", "operationId" : "get-merchants-merchantId-paymentMethodSettings-paymentMethodId", - "x-groupName" : "Payment methods - merchant level", "x-sortIndex" : 3, "x-methodName" : "getPaymentMethodDetails", "security" : [ @@ -7721,7 +7623,6 @@ "summary" : "Update a payment method", "description" : "Updates payment method details for the merchant account and the payment method identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read and write\n", "operationId" : "patch-merchants-merchantId-paymentMethodSettings-paymentMethodId", - "x-groupName" : "Payment methods - merchant level", "x-sortIndex" : 4, "x-methodName" : "updatePaymentMethod", "security" : [ @@ -7838,7 +7739,6 @@ "summary" : "Add an Apple Pay domain", "description" : "Adds the new domain to the list of Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/enable-apple-pay#register-merchant-domain).\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read and write\n", "operationId" : "post-merchants-merchantId-paymentMethodSettings-paymentMethodId-addApplePayDomains", - "x-groupName" : "Payment methods - merchant level", "x-sortIndex" : 5, "x-methodName" : "addApplePayDomain", "security" : [ @@ -7950,7 +7850,6 @@ "summary" : "Get Apple Pay domains", "description" : "Returns all Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/enable-apple-pay#register-merchant-domain).\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read\n", "operationId" : "get-merchants-merchantId-paymentMethodSettings-paymentMethodId-getApplePayDomains", - "x-groupName" : "Payment methods - merchant level", "x-sortIndex" : 6, "x-methodName" : "getApplePayDomains", "security" : [ @@ -8058,7 +7957,6 @@ "summary" : "Get a list of payout settings", "description" : "Returns the list of payout settings for the merchant account identified in the path.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payout account settings read", "operationId" : "get-merchants-merchantId-payoutSettings", - "x-groupName" : "Payout settings - merchant level", "x-sortIndex" : 3, "x-methodName" : "listPayoutSettings", "security" : [ @@ -8155,7 +8053,6 @@ "summary" : "Add a payout setting", "description" : "Sends a request to add a payout setting for the merchant account specified in the path. A payout setting links the merchant account to the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the payout bank account. Adyen verifies the bank account before allowing and enabling the payout setting.\n\nIf you're accepting payments in multiple currencies, you may add multiple payout settings for the merchant account.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\n* Management API—Payout account settings read and write", "operationId" : "post-merchants-merchantId-payoutSettings", - "x-groupName" : "Payout settings - merchant level", "x-sortIndex" : 1, "x-methodName" : "addPayoutSetting", "security" : [ @@ -8263,7 +8160,6 @@ "summary" : "Delete a payout setting", "description" : "Deletes the payout setting identified in the path.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\n* Management API—Payout account settings read and write", "operationId" : "delete-merchants-merchantId-payoutSettings-payoutSettingsId", - "x-groupName" : "Payout settings - merchant level", "x-sortIndex" : 5, "x-methodName" : "deletePayoutSetting", "security" : [ @@ -8359,7 +8255,6 @@ "summary" : "Get a payout setting", "description" : "Returns the payout setting identified in the path.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payout account settings read", "operationId" : "get-merchants-merchantId-payoutSettings-payoutSettingsId", - "x-groupName" : "Payout settings - merchant level", "x-sortIndex" : 4, "x-methodName" : "getPayoutSetting", "security" : [ @@ -8465,7 +8360,6 @@ "summary" : "Update a payout setting", "description" : "Updates the payout setting identified in the path. You can enable or disable the payout setting.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\n* Management API—Payout account settings read and write", "operationId" : "patch-merchants-merchantId-payoutSettings-payoutSettingsId", - "x-groupName" : "Payout settings - merchant level", "x-sortIndex" : 2, "x-methodName" : "updatePayoutSetting", "security" : [ @@ -8582,7 +8476,6 @@ "summary" : "Get a list of shipping locations", "description" : "Returns the shipping locations for the merchant account identified in the path.\nA shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write", "operationId" : "get-merchants-merchantId-shippingLocations", - "x-groupName" : "Terminal orders - merchant level", "x-sortIndex" : 4, "x-methodName" : "listShippingLocations", "security" : [ @@ -8713,7 +8606,6 @@ "summary" : "Create a shipping location", "description" : "Creates a shipping location for the merchant account identified in the path. A shipping location defines an address where orders can be shipped to. \n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write", "operationId" : "post-merchants-merchantId-shippingLocations", - "x-groupName" : "Terminal orders - merchant level", "x-sortIndex" : 5, "x-methodName" : "createShippingLocation", "security" : [ @@ -8831,7 +8723,6 @@ "summary" : "Get a list of split configurations", "description" : "Returns the list of split configurations for the merchant account.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write", "operationId" : "get-merchants-merchantId-splitConfigurations", - "x-groupName" : "Split configuration - merchant level", "x-sortIndex" : 3, "x-methodName" : "listSplitConfigurations", "security" : [ @@ -8933,7 +8824,6 @@ "summary" : "Create a split configuration", "description" : "Creates a split configuration for the merchant account specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write", "operationId" : "post-merchants-merchantId-splitConfigurations", - "x-groupName" : "Split configuration - merchant level", "x-sortIndex" : 1, "x-methodName" : "createSplitConfiguration", "security" : [ @@ -9051,7 +8941,6 @@ "summary" : "Delete a split configuration", "description" : "Deletes the split configuration specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write", "operationId" : "delete-merchants-merchantId-splitConfigurations-splitConfigurationId", - "x-groupName" : "Split configuration - merchant level", "x-sortIndex" : 8, "x-methodName" : "deleteSplitConfiguration", "security" : [ @@ -9157,7 +9046,6 @@ "summary" : "Get a split configuration", "description" : "Returns the split configuration specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write", "operationId" : "get-merchants-merchantId-splitConfigurations-splitConfigurationId", - "x-groupName" : "Split configuration - merchant level", "x-sortIndex" : 4, "x-methodName" : "getSplitConfiguration", "security" : [ @@ -9268,7 +9156,6 @@ "summary" : "Update split configuration description", "description" : "Changes the description of the split configuration specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write", "operationId" : "patch-merchants-merchantId-splitConfigurations-splitConfigurationId", - "x-groupName" : "Split configuration - merchant level", "x-sortIndex" : 5, "x-methodName" : "updateSplitConfigurationDescription", "security" : [ @@ -9393,7 +9280,6 @@ "summary" : "Create a rule", "description" : "Creates a rule in the split configuration specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write", "operationId" : "post-merchants-merchantId-splitConfigurations-splitConfigurationId", - "x-groupName" : "Split configuration - merchant level", "x-sortIndex" : 2, "x-methodName" : "createRule", "security" : [ @@ -9520,7 +9406,6 @@ "summary" : "Delete a split configuration rule", "description" : "Deletes the split configuration rule specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write", "operationId" : "delete-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId", - "x-groupName" : "Split configuration - merchant level", "x-sortIndex" : 9, "x-methodName" : "deleteSplitConfigurationRule", "security" : [ @@ -9634,7 +9519,6 @@ "summary" : "Update split conditions", "description" : "Changes the conditions of the split configuration rule specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write", "operationId" : "patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId", - "x-groupName" : "Split configuration - merchant level", "x-sortIndex" : 6, "x-methodName" : "updateSplitConditions", "security" : [ @@ -9770,7 +9654,6 @@ "summary" : "Update the split logic", "description" : "Changes the split logic specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write", "operationId" : "patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId-splitLogic-splitLogicId", - "x-groupName" : "Split configuration - merchant level", "x-sortIndex" : 7, "x-methodName" : "updateSplitLogic", "security" : [ @@ -9915,7 +9798,6 @@ "summary" : "Get a list of stores", "description" : "Returns a list of stores for the merchant account identified in the path. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read\n* Management API—Stores read and write", "operationId" : "get-merchants-merchantId-stores", - "x-groupName" : "Account - store level", "x-sortIndex" : 1, "x-methodName" : "listStoresByMerchantId", "security" : [ @@ -10046,7 +9928,6 @@ "summary" : "Create a store", "description" : "Creates a store for the merchant account identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read and write", "operationId" : "post-merchants-merchantId-stores", - "x-groupName" : "Account - store level", "x-sortIndex" : 0, "x-methodName" : "createStoreByMerchantId", "security" : [ @@ -10164,7 +10045,6 @@ "summary" : "Get the terminal logo", "description" : "Returns the logo that is configured for a specific payment terminal model at the store identified in the path. \nThe logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. \nThis logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write", "operationId" : "get-merchants-merchantId-stores-reference-terminalLogos", - "x-groupName" : "Terminal settings - store level", "x-sortIndex" : 2, "x-methodName" : "getTerminalLogo", "security" : [ @@ -10284,7 +10164,6 @@ "summary" : "Update the terminal logo", "description" : "Updates the logo that is configured for a specific payment terminal model at the store identified in the path. You can update the logo for only one terminal model at a time.\nThis logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. \n\n* To change the logo, specify the image file as a Base64-encoded string.\n* To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write", "operationId" : "patch-merchants-merchantId-stores-reference-terminalLogos", - "x-groupName" : "Terminal settings - store level", "x-sortIndex" : 4, "x-methodName" : "updateTerminalLogo", "security" : [ @@ -10426,7 +10305,6 @@ "summary" : "Get terminal settings", "description" : "Returns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless different values are configured for an individual terminal.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write", "operationId" : "get-merchants-merchantId-stores-reference-terminalSettings", - "x-groupName" : "Terminal settings - store level", "x-sortIndex" : 1, "x-methodName" : "getTerminalSettings", "security" : [ @@ -10537,7 +10415,6 @@ "summary" : "Update terminal settings", "description" : "Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal.\n\n* To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.\n* To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter.\n* Objects that are not included in the request are not updated.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write", "operationId" : "patch-merchants-merchantId-stores-reference-terminalSettings", - "x-groupName" : "Terminal settings - store level", "x-sortIndex" : 3, "x-methodName" : "updateTerminalSettings", "security" : [ @@ -10670,7 +10547,6 @@ "summary" : "Get a store", "description" : "Returns the details of the store identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read\n* Management API—Stores read and write", "operationId" : "get-merchants-merchantId-stores-storeId", - "x-groupName" : "Account - store level", "x-sortIndex" : 2, "x-methodName" : "getStore", "security" : [ @@ -10781,7 +10657,6 @@ "summary" : "Update a store", "description" : "Updates the store identified in the path. You can only update some store parameters.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read and write", "operationId" : "patch-merchants-merchantId-stores-storeId", - "x-groupName" : "Account - store level", "x-sortIndex" : 3, "x-methodName" : "updateStore", "security" : [ @@ -10914,7 +10789,6 @@ "summary" : "Get the terminal logo", "description" : "Returns the logo that is configured for a specific payment terminal model at the merchant account identified in the path. \nThe logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. \nThis logo applies to all terminals of the specified model under the merchant account, unless a different logo is configured at a lower level (store or individual terminal).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write", "operationId" : "get-merchants-merchantId-terminalLogos", - "x-groupName" : "Terminal settings - merchant level", "x-sortIndex" : 2, "x-methodName" : "getTerminalLogo", "security" : [ @@ -11025,7 +10899,6 @@ "summary" : "Update the terminal logo", "description" : "Updates the logo for a specific payment terminal model at the merchant account identified in the path. You can update the logo for only one terminal model at a time. \nThis logo applies to all terminals of the specified model under the merchant account, unless a different logo is configured at a lower level (store or individual terminal).\n\n* To change the logo, specify the image file as a Base64-encoded string.\n* To restore the logo inherited from the company account, specify an empty logo value.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write", "operationId" : "patch-merchants-merchantId-terminalLogos", - "x-groupName" : "Terminal settings - merchant level", "x-sortIndex" : 4, "x-methodName" : "updateTerminalLogo", "security" : [ @@ -11158,7 +11031,6 @@ "summary" : "Get a list of terminal models", "description" : "Returns the payment terminal models that merchant account identified in the path has access to. The response includes the terminal model ID, which can be used as a query parameter when getting a list of terminals or a list of products for ordering.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write", "operationId" : "get-merchants-merchantId-terminalModels", - "x-groupName" : "Terminal orders - merchant level", "x-sortIndex" : 1, "x-methodName" : "listTerminalModels", "security" : [ @@ -11262,7 +11134,6 @@ "summary" : "Get a list of orders", "description" : "Returns a list of terminal products orders for the merchant account identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write", "operationId" : "get-merchants-merchantId-terminalOrders", - "x-groupName" : "Terminal orders - merchant level", "x-sortIndex" : 7, "x-methodName" : "listOrders", "security" : [ @@ -11401,7 +11272,6 @@ "summary" : "Create an order", "description" : "Creates an order for payment terminal products for the merchant account identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write\n>Requests to the Management API test endpoint do not create actual orders for test terminals. To order test terminals, you need to [submit a sales order](https://docs.adyen.com/point-of-sale/managing-terminals/order-terminals/#sales-order-steps) in your Customer Area.", "operationId" : "post-merchants-merchantId-terminalOrders", - "x-groupName" : "Terminal orders - merchant level", "x-sortIndex" : 6, "x-methodName" : "createOrder", "security" : [ @@ -11519,7 +11389,6 @@ "summary" : "Get an order", "description" : "Returns the details of the terminal products order identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write", "operationId" : "get-merchants-merchantId-terminalOrders-orderId", - "x-groupName" : "Terminal orders - merchant level", "x-sortIndex" : 8, "x-methodName" : "getOrder", "security" : [ @@ -11630,7 +11499,6 @@ "summary" : "Update an order", "description" : "Updates the terminal products order identified in the path.\nUpdating is only possible while the order has the status **Placed**.\n\nThe request body only needs to contain what you want to change. \nHowever, to update the products in the `items` array, you must provide the entire array. For example, if the array has three items:\n To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write", "operationId" : "patch-merchants-merchantId-terminalOrders-orderId", - "x-groupName" : "Terminal orders - merchant level", "x-sortIndex" : 9, "x-methodName" : "updateOrder", "security" : [ @@ -11757,7 +11625,6 @@ "summary" : "Cancel an order", "description" : "Cancels the terminal products order identified in the path.\nCancelling is only possible while the order has the status **Placed**.\nTo cancel an order, make a POST call without a request body. The response returns the full order details, but with the status changed to **Cancelled**.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write", "operationId" : "post-merchants-merchantId-terminalOrders-orderId-cancel", - "x-groupName" : "Terminal orders - merchant level", "x-sortIndex" : 10, "x-methodName" : "cancelOrder", "security" : [ @@ -11870,7 +11737,6 @@ "summary" : "Get a list of terminal products", "description" : "Returns a country-specific list of payment terminal packages and parts that the merchant account identified in the path has access to.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write", "operationId" : "get-merchants-merchantId-terminalProducts", - "x-groupName" : "Terminal orders - merchant level", "x-sortIndex" : 2, "x-methodName" : "listTerminalProducts", "security" : [ @@ -12012,7 +11878,6 @@ "summary" : "Get terminal settings", "description" : "Returns the payment terminal settings that are configured for the merchant account identified in the path. These settings apply to all terminals under the merchant account unless different values are configured at a lower level (store or individual terminal).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write", "operationId" : "get-merchants-merchantId-terminalSettings", - "x-groupName" : "Terminal settings - merchant level", "x-sortIndex" : 1, "x-methodName" : "getTerminalSettings", "security" : [ @@ -12114,7 +11979,6 @@ "summary" : "Update terminal settings", "description" : "Updates payment terminal settings for the merchant account identified in the path.\nThese settings apply to all terminals under the merchant account, unless different values are configured at a lower level (store or individual terminal).\n\n* To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.\n* To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter.\n* Objects that are not included in the request are not updated.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write", "operationId" : "patch-merchants-merchantId-terminalSettings", - "x-groupName" : "Terminal settings - merchant level", "x-sortIndex" : 3, "x-methodName" : "updateTerminalSettings", "security" : [ @@ -12238,7 +12102,6 @@ "summary" : "Get a list of users", "description" : "Returns a list of users associated with the `merchantId` specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n", "operationId" : "get-merchants-merchantId-users", - "x-groupName" : "Users - merchant level", "x-sortIndex" : 0, "x-methodName" : "listUsers", "security" : [ @@ -12364,7 +12227,6 @@ "summary" : "Create a new user", "description" : "Creates a user for the `merchantId` specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n", "operationId" : "post-merchants-merchantId-users", - "x-groupName" : "Users - merchant level", "x-sortIndex" : 0, "x-methodName" : "createNewUser", "security" : [ @@ -12482,7 +12344,6 @@ "summary" : "Get user details", "description" : "Returns user details for the `userId` and the `merchantId` specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n", "operationId" : "get-merchants-merchantId-users-userId", - "x-groupName" : "Users - merchant level", "x-sortIndex" : 0, "x-methodName" : "getUserDetails", "security" : [ @@ -12588,7 +12449,6 @@ "summary" : "Update a user", "description" : "Updates user details for the `userId` and the `merchantId` specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n", "operationId" : "patch-merchants-merchantId-users-userId", - "x-groupName" : "Users - merchant level", "x-sortIndex" : 0, "x-methodName" : "updateUser", "security" : [ @@ -12705,7 +12565,6 @@ "summary" : "List all webhooks", "description" : "Lists all webhook configurations for the merchant account.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read\n* Management API—Webhooks read and write", "operationId" : "get-merchants-merchantId-webhooks", - "x-groupName" : "Webhooks - merchant level", "x-sortIndex" : 2, "x-methodName" : "listAllWebhooks", "security" : [ @@ -12827,7 +12686,6 @@ "summary" : "Set up a webhook", "description" : "Subscribe to receive webhook notifications about events related to your merchant account. You can add basic authentication to make sure the data is secure.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write", "operationId" : "post-merchants-merchantId-webhooks", - "x-groupName" : "Webhooks - merchant level", "x-sortIndex" : 1, "x-methodName" : "setUpWebhook", "security" : [ @@ -12945,7 +12803,6 @@ "summary" : "Remove a webhook", "description" : "Remove the configuration for the webhook identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write", "operationId" : "delete-merchants-merchantId-webhooks-webhookId", - "x-groupName" : "Webhooks - merchant level", "x-sortIndex" : 5, "x-methodName" : "removeWebhook", "security" : [ @@ -13041,7 +12898,6 @@ "summary" : "Get a webhook", "description" : "Returns the configuration for the webhook identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read\n* Management API—Webhooks read and write", "operationId" : "get-merchants-merchantId-webhooks-webhookId", - "x-groupName" : "Webhooks - merchant level", "x-sortIndex" : 3, "x-methodName" : "getWebhook", "security" : [ @@ -13152,7 +13008,6 @@ "summary" : "Update a webhook", "description" : "Make changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration. The response contains the full configuration for the webhook, which includes the new values from the request.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write", "operationId" : "patch-merchants-merchantId-webhooks-webhookId", - "x-groupName" : "Webhooks - merchant level", "x-sortIndex" : 4, "x-methodName" : "updateWebhook", "security" : [ @@ -13279,7 +13134,6 @@ "summary" : "Generate an HMAC key", "description" : "Returns an [HMAC key](https://en.wikipedia.org/wiki/HMAC) for the webhook identified in the path. This key allows you to check the integrity and the origin of the notifications you receive.By creating an HMAC key, you start receiving [HMAC-signed notifications](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures#enable-hmac-signatures) from Adyen. Find out more about how to [verify HMAC signatures](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures).\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write", "operationId" : "post-merchants-merchantId-webhooks-webhookId-generateHmac", - "x-groupName" : "Webhooks - merchant level", "x-sortIndex" : 6, "x-methodName" : "generateHmacKey", "security" : [ @@ -13391,7 +13245,6 @@ "summary" : "Test a webhook", "description" : "Sends sample notifications to test if the webhook is set up correctly.\n\nWe send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP, regardless of the currencies configured in the merchant accounts. For custom notifications, we only send the specified custom notification.\n\nThe response describes the result of the test. The `status` field tells you if the test was successful or not. You can use the other fields to troubleshoot unsuccessful tests.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write", "operationId" : "post-merchants-merchantId-webhooks-webhookId-test", - "x-groupName" : "Webhooks - merchant level", "x-sortIndex" : 7, "x-methodName" : "testWebhook", "security" : [ @@ -13518,7 +13371,6 @@ "summary" : "Get a list of stores", "description" : "Returns a list of stores. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read\n* Management API—Stores read and write", "operationId" : "get-stores", - "x-groupName" : "Account - store level", "x-sortIndex" : 4, "x-methodName" : "listStores", "security" : [ @@ -13646,7 +13498,6 @@ "summary" : "Create a store", "description" : "Creates a store for the merchant account specified in the request.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read and write", "operationId" : "post-stores", - "x-groupName" : "Account - store level", "x-sortIndex" : 5, "x-methodName" : "createStore", "security" : [ @@ -13750,7 +13601,6 @@ "summary" : "Get a store", "description" : "Returns the details of the store identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read\n* Management API—Stores read and write", "operationId" : "get-stores-storeId", - "x-groupName" : "Account - store level", "x-sortIndex" : 6, "x-methodName" : "getStoreById", "security" : [ @@ -13849,7 +13699,6 @@ "summary" : "Update a store", "description" : "Updates the store identified in the path.\nYou can only update some store parameters.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read and write", "operationId" : "patch-stores-storeId", - "x-groupName" : "Account - store level", "x-sortIndex" : 7, "x-methodName" : "updateStoreById", "security" : [ @@ -13967,7 +13816,6 @@ "summary" : "Get the terminal logo", "description" : "Returns the logo that is configured for a specific payment terminal model at the store identified in the path. \nThe logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. \nThis logo applies to all terminals of that model under the store unless a different logo is configured for an individual terminal.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write", "operationId" : "get-stores-storeId-terminalLogos", - "x-groupName" : "Terminal settings - store level", "x-sortIndex" : 2, "x-methodName" : "getTerminalLogoByStoreId", "security" : [ @@ -14075,7 +13923,6 @@ "summary" : "Update the terminal logo", "description" : "Updates the logo that is configured for a specific payment terminal model at the store identified in the path. You can update the logo for only one terminal model at a time.\nThis logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. \n\n* To change the logo, specify the image file as a Base64-encoded string.\n* To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write", "operationId" : "patch-stores-storeId-terminalLogos", - "x-groupName" : "Terminal settings - store level", "x-sortIndex" : 4, "x-methodName" : "updateTerminalLogoByStoreId", "security" : [ @@ -14205,7 +14052,6 @@ "summary" : "Get terminal settings", "description" : "Returns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless different values are configured for an individual terminal.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write", "operationId" : "get-stores-storeId-terminalSettings", - "x-groupName" : "Terminal settings - store level", "x-sortIndex" : 1, "x-methodName" : "getTerminalSettingsByStoreId", "security" : [ @@ -14304,7 +14150,6 @@ "summary" : "Update terminal settings", "description" : "Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal.\n\n* To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.\n* To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter.\n* Objects that are not included in the request are not updated.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write", "operationId" : "patch-stores-storeId-terminalSettings", - "x-groupName" : "Terminal settings - store level", "x-sortIndex" : 3, "x-methodName" : "updateTerminalSettingsByStoreId", "security" : [ @@ -14425,7 +14270,6 @@ "summary" : "Get a list of terminals", "description" : "Returns the payment terminals that the API credential has access to and that match the query parameters. \nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API — Terminal actions read", "operationId" : "get-terminals", - "x-groupName" : "Terminals - terminal level", "x-sortIndex" : 1, "x-methodName" : "listTerminals", "security" : [ @@ -14591,7 +14435,6 @@ "summary" : "Create a terminal action", "description" : "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. \n\nThe following restrictions apply:\n* You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. \n* The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. \n* If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. \n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal actions read and write", "operationId" : "post-terminals-scheduleActions", - "x-groupName" : "Terminal actions - terminal level", "x-sortIndex" : 1, "x-methodName" : "createTerminalAction", "security" : [ @@ -14709,7 +14552,6 @@ "summary" : "Get the terminal logo", "description" : "Returns the logo that is configured for the payment terminal identified in the path.\nThe logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write", "operationId" : "get-terminals-terminalId-terminalLogos", - "x-groupName" : "Terminal settings - terminal level", "x-sortIndex" : 4, "x-methodName" : "getTerminalLogo", "security" : [ @@ -14808,7 +14650,6 @@ "summary" : "Update the logo", "description" : "Updates the logo for the payment terminal identified in the path.\n\n* To change the logo, specify the image file as a Base64-encoded string.\n* To restore the logo inherited from a higher level (store, merchant account, or company account), specify an empty logo value.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write", "operationId" : "patch-terminals-terminalId-terminalLogos", - "x-groupName" : "Terminal settings - terminal level", "x-sortIndex" : 6, "x-methodName" : "updateLogo", "security" : [ @@ -14929,7 +14770,6 @@ "summary" : "Get terminal settings", "description" : "Returns the settings that are configured for the payment terminal identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write", "operationId" : "get-terminals-terminalId-terminalSettings", - "x-groupName" : "Terminal settings - terminal level", "x-sortIndex" : 3, "x-methodName" : "getTerminalSettings", "security" : [ @@ -15028,7 +14868,6 @@ "summary" : "Update terminal settings", "description" : "Updates the settings that are configured for the payment terminal identified in the path.\n\n* To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.\n* To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter.\n* Objects that are not included in the request are not updated.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write", "operationId" : "patch-terminals-terminalId-terminalSettings", - "x-groupName" : "Terminal settings - terminal level", "x-sortIndex" : 5, "x-methodName" : "updateTerminalSettings", "security" : [ @@ -19234,6 +19073,15 @@ ], "type" : "object" }, + "TapToPay" : { + "properties" : { + "merchantDisplayName" : { + "description" : "Platform merchants can customize the text that appears on the TapToPay screen during a transaction", + "type" : "string" + } + }, + "type" : "object" + }, "Terminal" : { "properties" : { "assigned" : { @@ -19580,6 +19428,10 @@ "description" : "Settings for payment [surcharge](https://docs.adyen.com/point-of-sale/surcharge) features.", "$ref" : "#/components/schemas/Surcharge" }, + "tapToPay" : { + "description" : "Settings for apple tap to pay.", + "$ref" : "#/components/schemas/TapToPay" + }, "timeouts" : { "description" : "Settings for device [time-outs](https://docs.adyen.com/point-of-sale/pos-timeouts#device-time-out).", "$ref" : "#/components/schemas/Timeouts" diff --git a/json/ManagementService-v3.json b/json/ManagementService-v3.json index 3796a76..3fef64f 100644 --- a/json/ManagementService-v3.json +++ b/json/ManagementService-v3.json @@ -16,37 +16,6 @@ "url" : "https://github.com/Adyen/adyen-openapi" } }, - "x-groups" : [ - "Account - company level", - "Account - merchant level", - "Account - store level", - "Payout settings - merchant level", - "Users - company level", - "Users - merchant level", - "My API credential", - "API credentials - company level", - "API credentials - merchant level", - "API key - company level", - "API key - merchant level", - "Client key - company level", - "Client key - merchant level", - "Allowed origins - company level", - "Allowed origins - merchant level", - "Webhooks - company level", - "Webhooks - merchant level", - "Payment methods - merchant level", - "Terminals - terminal level", - "Terminal actions - company level", - "Terminal actions - terminal level", - "Terminal orders - company level", - "Terminal orders - merchant level", - "Terminal settings - company level", - "Terminal settings - merchant level", - "Terminal settings - store level", - "Terminal settings - terminal level", - "Android files - company level", - "Split configuration - merchant level" - ], "tags" : [ { "name" : "Account - company level" @@ -145,7 +114,6 @@ "summary" : "Get a list of company accounts", "description" : "Returns the list of company accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\n* Management API—Account read", "operationId" : "get-companies", - "x-groupName" : "Account - company level", "x-sortIndex" : 0, "x-methodName" : "listCompanyAccounts", "security" : [ @@ -257,7 +225,6 @@ "summary" : "Get a company account", "description" : "Returns the company account specified in the path. Your API credential must have access to the company account. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Account read", "operationId" : "get-companies-companyId", - "x-groupName" : "Account - company level", "x-sortIndex" : 0, "x-methodName" : "getCompanyAccount", "security" : [ @@ -358,7 +325,6 @@ "summary" : "Get a list of Android apps", "description" : "Returns a list of the Android apps that are available for the company identified in the path. \nThese apps have been uploaded to Adyen and can be installed or uninstalled on Android payment terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Android files read\n* Management API—Android files read and write\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write", "operationId" : "get-companies-companyId-androidApps", - "x-groupName" : "Android files - company level", "x-sortIndex" : 1, "x-methodName" : "listAndroidApps", "security" : [ @@ -497,7 +463,6 @@ "description" : "Uploads an Android APK file to Adyen.\nThe maximum APK file size is 200 MB.\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Android files read and write\n\n>By choosing to upload, install, or run any third-party applications on an Adyen payment terminal, you accept full responsibility and liability for any consequences of uploading, installing, or running any such applications.", "x-addedInVersion" : "3", "operationId" : "post-companies-companyId-androidApps", - "x-groupName" : "Android files - company level", "x-sortIndex" : 4, "x-methodName" : "uploadAndroidApp", "security" : [ @@ -583,7 +548,6 @@ "summary" : "Get Android app", "description" : "Returns the details of the Android app identified in the path. \nThese apps have been uploaded to Adyen and can be installed or uninstalled on Android payment terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Android files read\n* Management API—Android files read and write", "operationId" : "get-companies-companyId-androidApps-id", - "x-groupName" : "Android files - company level", "x-sortIndex" : 3, "x-methodName" : "getAndroidApp", "security" : [ @@ -688,7 +652,6 @@ "summary" : "Get a list of Android certificates", "description" : "Returns a list of the Android certificates that are available for the company identified in the path.\nTypically, these certificates enable running apps on Android payment terminals. The certifcates in the list have been uploaded to Adyen and can be installed or uninstalled on Android terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Android files read\n* Management API—Android files read and write\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write", "operationId" : "get-companies-companyId-androidCertificates", - "x-groupName" : "Android files - company level", "x-sortIndex" : 2, "x-methodName" : "listAndroidCertificates", "security" : [ @@ -818,7 +781,6 @@ "summary" : "Get a list of API credentials", "description" : "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the company account. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "get-companies-companyId-apiCredentials", - "x-groupName" : "API credentials - company level", "x-sortIndex" : 0, "x-methodName" : "listApiCredentials", "security" : [ @@ -937,7 +899,6 @@ "summary" : "Create an API credential.", "description" : "Creates an [API credential](https://docs.adyen.com/development-resources/api-credentials) for the company account identified in the path. In the request, you can specify which merchant accounts the new API credential will have access to, as well as its roles and allowed origins.\n\nThe response includes several types of authentication details:\n* [API key](https://docs.adyen.com/development-resources/api-authentication#api-key-authentication): used for API request authentication.\n* [Client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works): public key used for client-side authentication.\n* [Username and password](https://docs.adyen.com/development-resources/api-authentication#using-basic-authentication): used for basic authentication.\n\n> Make sure you store the API key securely in your system. You won't be able to retrieve it later.\n\nIf your API key is lost or compromised, you need to [generate a new API key](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/apiCredentials/{apiCredentialId}/generateApiKey).\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "post-companies-companyId-apiCredentials", - "x-groupName" : "API credentials - company level", "x-sortIndex" : 0, "x-methodName" : "createApiCredential", "security" : [ @@ -1052,7 +1013,6 @@ "summary" : "Get an API credential", "description" : "Returns the [API credential](https://docs.adyen.com/development-resources/api-credentials) identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "get-companies-companyId-apiCredentials-apiCredentialId", - "x-groupName" : "API credentials - company level", "x-sortIndex" : 0, "x-methodName" : "getApiCredential", "security" : [ @@ -1160,7 +1120,6 @@ "summary" : "Update an API credential.", "description" : "Changes the API credential's roles, merchant account access, or allowed origins. The request has the new values for the fields you want to change. The response contains the full updated API credential, including the new values from the request. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "patch-companies-companyId-apiCredentials-apiCredentialId", - "x-groupName" : "API credentials - company level", "x-sortIndex" : 0, "x-methodName" : "updateApiCredential", "security" : [ @@ -1284,7 +1243,6 @@ "summary" : "Get a list of allowed origins", "description" : "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "get-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins", - "x-groupName" : "Allowed origins - company level", "x-sortIndex" : 0, "x-methodName" : "listAllowedOrigins", "security" : [ @@ -1392,7 +1350,6 @@ "summary" : "Create an allowed origin", "description" : "Adds a new [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) to the API credential's list of allowed origins.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "post-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins", - "x-groupName" : "Allowed origins - company level", "x-sortIndex" : 0, "x-methodName" : "createAllowedOrigin", "security" : [ @@ -1516,7 +1473,6 @@ "summary" : "Delete an allowed origin", "description" : "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. As soon as an allowed origin is removed, we no longer accept client-side requests from that domain.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "delete-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-originId", - "x-groupName" : "Allowed origins - company level", "x-sortIndex" : 0, "x-methodName" : "deleteAllowedOrigin", "security" : [ @@ -1621,7 +1577,6 @@ "summary" : "Get an allowed origin", "description" : "Returns the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "get-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-originId", - "x-groupName" : "Allowed origins - company level", "x-sortIndex" : 0, "x-methodName" : "getAllowedOrigin", "security" : [ @@ -1740,7 +1695,6 @@ "summary" : "Generate new API key", "description" : "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "post-companies-companyId-apiCredentials-apiCredentialId-generateApiKey", - "x-groupName" : "API key - company level", "x-sortIndex" : 0, "x-methodName" : "generateNewApiKey", "security" : [ @@ -1845,7 +1799,6 @@ "summary" : "Generate new client key", "description" : "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "post-companies-companyId-apiCredentials-apiCredentialId-generateClientKey", - "x-groupName" : "Client key - company level", "x-sortIndex" : 0, "x-methodName" : "generateNewClientKey", "security" : [ @@ -1950,7 +1903,6 @@ "summary" : "Get a list of billing entities", "description" : "Returns the billing entities of the company identified in the path and all merchant accounts belonging to the company.\nA billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write", "operationId" : "get-companies-companyId-billingEntities", - "x-groupName" : "Terminal orders - company level", "x-sortIndex" : 3, "x-methodName" : "listBillingEntities", "security" : [ @@ -2060,7 +2012,6 @@ "summary" : "Get a list of merchant accounts", "description" : "Returns the list of merchant accounts under the company account specified in the path. The list only includes merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Account read", "operationId" : "get-companies-companyId-merchants", - "x-groupName" : "Account - company level", "x-sortIndex" : 0, "x-methodName" : "listMerchantAccounts", "security" : [ @@ -2181,7 +2132,6 @@ "summary" : "Get a list of shipping locations", "description" : "Returns the shipping locations for the company identified in the path and all merchant accounts belonging to the company.\nA shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write", "operationId" : "get-companies-companyId-shippingLocations", - "x-groupName" : "Terminal orders - company level", "x-sortIndex" : 4, "x-methodName" : "listShippingLocations", "security" : [ @@ -2309,7 +2259,6 @@ "summary" : "Create a shipping location", "description" : "Creates a shipping location for the company identified in the path. A shipping location defines an address where orders can be delivered.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write", "operationId" : "post-companies-companyId-shippingLocations", - "x-groupName" : "Terminal orders - company level", "x-sortIndex" : 5, "x-methodName" : "createShippingLocation", "security" : [ @@ -2424,7 +2373,6 @@ "summary" : "Get a list of terminal actions", "description" : "Returns the [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) that have been scheduled for the company identified in the path.The response doesn't include actions that are scheduled by Adyen.\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write", "operationId" : "get-companies-companyId-terminalActions", - "x-groupName" : "Terminal actions - company level", "x-sortIndex" : 1, "x-methodName" : "listTerminalActions", "security" : [ @@ -2563,7 +2511,6 @@ "summary" : "Get terminal action", "description" : "Returns the details of the [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) identified in the path.\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write", "operationId" : "get-companies-companyId-terminalActions-actionId", - "x-groupName" : "Terminal actions - company level", "x-sortIndex" : 2, "x-methodName" : "getTerminalAction", "security" : [ @@ -2673,7 +2620,6 @@ "summary" : "Get the terminal logo", "description" : "Returns the logo that is configured for a specific payment terminal model at the company identified in the path. \n\nThe logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. \nThis logo applies to all terminals of the specified model under the company, unless a different logo is configured at a lower level (merchant account, store, or individual terminal).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write", "operationId" : "get-companies-companyId-terminalLogos", - "x-groupName" : "Terminal settings - company level", "x-sortIndex" : 2, "x-methodName" : "getTerminalLogo", "security" : [ @@ -2781,7 +2727,6 @@ "summary" : "Update the terminal logo", "description" : "Updates the logo that is configured for a specific payment terminal model at the company identified in the path. You can update the logo for only one terminal model at a time.\nThis logo applies to all terminals of the specified model under the company, unless a different logo is configured at a lower level (merchant account, store, or individual terminal). \n* To change the logo, specify the image file as a Base64-encoded string.\n* To restore the logo inherited from the Adyen PSP level, specify an empty logo value.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write", "operationId" : "patch-companies-companyId-terminalLogos", - "x-groupName" : "Terminal settings - company level", "x-sortIndex" : 4, "x-methodName" : "updateTerminalLogo", "security" : [ @@ -2911,7 +2856,6 @@ "summary" : "Get a list of terminal models", "description" : "Returns a list of payment terminal models that the company identified in the path has access to.\nThe response includes the terminal model ID, which can be used as a query parameter when getting a list of terminals or a list of products for ordering.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write", "operationId" : "get-companies-companyId-terminalModels", - "x-groupName" : "Terminal orders - company level", "x-sortIndex" : 1, "x-methodName" : "listTerminalModels", "security" : [ @@ -3012,7 +2956,6 @@ "summary" : "Get a list of orders", "description" : "Returns a lists of terminal products orders for the company identified in the path.\nTo filter the list, use one or more of the query parameters.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write", "operationId" : "get-companies-companyId-terminalOrders", - "x-groupName" : "Terminal orders - company level", "x-sortIndex" : 7, "x-methodName" : "listOrders", "security" : [ @@ -3149,7 +3092,6 @@ "summary" : "Create an order", "description" : "Creates an order for payment terminal products for the company identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write\n>Requests to the Management API test endpoint do not create actual orders for test terminals. To order test terminals, you need to [submit a sales order](https://docs.adyen.com/point-of-sale/managing-terminals/order-terminals/#sales-order-steps) in your Customer Area.", "operationId" : "post-companies-companyId-terminalOrders", - "x-groupName" : "Terminal orders - company level", "x-sortIndex" : 6, "x-methodName" : "createOrder", "security" : [ @@ -3264,7 +3206,6 @@ "summary" : "Get an order", "description" : "Returns the details of the terminal products order identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write", "operationId" : "get-companies-companyId-terminalOrders-orderId", - "x-groupName" : "Terminal orders - company level", "x-sortIndex" : 8, "x-methodName" : "getOrder", "security" : [ @@ -3372,7 +3313,6 @@ "summary" : "Update an order", "description" : "Updates the terminal products order identified in the path.\nUpdating is only possible while the order has the status **Placed**.\n\nThe request body only needs to contain what you want to change. \nHowever, to update the products in the `items` array, you must provide the entire array. For example, if the array has three items:\n To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write", "operationId" : "patch-companies-companyId-terminalOrders-orderId", - "x-groupName" : "Terminal orders - company level", "x-sortIndex" : 9, "x-methodName" : "updateOrder", "security" : [ @@ -3496,7 +3436,6 @@ "summary" : "Cancel an order", "description" : "Cancels the terminal products order identified in the path.\nCancelling is only possible while the order has the status **Placed**.\nTo cancel an order, make a POST call without a request body. The response returns the full order details, but with the status changed to **Cancelled**.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write", "operationId" : "post-companies-companyId-terminalOrders-orderId-cancel", - "x-groupName" : "Terminal orders - company level", "x-sortIndex" : 10, "x-methodName" : "cancelOrder", "security" : [ @@ -3606,7 +3545,6 @@ "summary" : "Get a list of terminal products", "description" : "Returns a country-specific list of payment terminal packages and parts that the company identified in the path has access to.\n \nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write", "operationId" : "get-companies-companyId-terminalProducts", - "x-groupName" : "Terminal orders - company level", "x-sortIndex" : 2, "x-methodName" : "listTerminalProducts", "security" : [ @@ -3745,7 +3683,6 @@ "summary" : "Get terminal settings", "description" : "Returns the payment terminal settings that are configured for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level (merchant account, store, or individual terminal).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write", "operationId" : "get-companies-companyId-terminalSettings", - "x-groupName" : "Terminal settings - company level", "x-sortIndex" : 1, "x-methodName" : "getTerminalSettings", "security" : [ @@ -3844,7 +3781,6 @@ "summary" : "Update terminal settings", "description" : "Updates payment terminal settings for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level (merchant account, store, or individual terminal).\n\n* To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.\n* To restore a parameter value inherited from the Adyen PSP level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter.\n* Objects that are not included in the request are not updated.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write", "operationId" : "patch-companies-companyId-terminalSettings", - "x-groupName" : "Terminal settings - company level", "x-sortIndex" : 3, "x-methodName" : "updateTerminalSettings", "security" : [ @@ -3965,7 +3901,6 @@ "summary" : "Get a list of users", "description" : "Returns the list of users for the `companyId` identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n", "operationId" : "get-companies-companyId-users", - "x-groupName" : "Users - company level", "x-sortIndex" : 0, "x-methodName" : "listUsers", "security" : [ @@ -4088,7 +4023,6 @@ "summary" : "Create a new user", "description" : "Creates the user for the `companyId` identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n", "operationId" : "post-companies-companyId-users", - "x-groupName" : "Users - company level", "x-sortIndex" : 0, "x-methodName" : "createNewUser", "security" : [ @@ -4203,7 +4137,6 @@ "summary" : "Get user details", "description" : "Returns user details for the `userId` and the `companyId` identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n", "operationId" : "get-companies-companyId-users-userId", - "x-groupName" : "Users - company level", "x-sortIndex" : 0, "x-methodName" : "getUserDetails", "security" : [ @@ -4306,7 +4239,6 @@ "summary" : "Update user details", "description" : "Updates user details for the `userId` and the `companyId` identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n", "operationId" : "patch-companies-companyId-users-userId", - "x-groupName" : "Users - company level", "x-sortIndex" : 0, "x-methodName" : "updateUserDetails", "security" : [ @@ -4420,7 +4352,6 @@ "summary" : "List all webhooks", "description" : "Lists all webhook configurations for the company account.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read\n* Management API—Webhooks read and write", "operationId" : "get-companies-companyId-webhooks", - "x-groupName" : "Webhooks - company level", "x-sortIndex" : 2, "x-methodName" : "listAllWebhooks", "security" : [ @@ -4539,7 +4470,6 @@ "summary" : "Set up a webhook", "description" : "Subscribe to receive webhook notifications about events related to your company account. You can add basic authentication to make sure the data is secure.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write", "operationId" : "post-companies-companyId-webhooks", - "x-groupName" : "Webhooks - company level", "x-sortIndex" : 1, "x-methodName" : "setUpWebhook", "security" : [ @@ -4654,7 +4584,6 @@ "summary" : "Remove a webhook", "description" : "Remove the configuration for the webhook identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write", "operationId" : "delete-companies-companyId-webhooks-webhookId", - "x-groupName" : "Webhooks - company level", "x-sortIndex" : 5, "x-methodName" : "removeWebhook", "security" : [ @@ -4750,7 +4679,6 @@ "summary" : "Get a webhook", "description" : "Returns the configuration for the webhook identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read\n* Management API—Webhooks read and write", "operationId" : "get-companies-companyId-webhooks-webhookId", - "x-groupName" : "Webhooks - company level", "x-sortIndex" : 3, "x-methodName" : "getWebhook", "security" : [ @@ -4858,7 +4786,6 @@ "summary" : "Update a webhook", "description" : "Make changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration. The response contains the full configuration for the webhook, which includes the new values from the request.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write", "operationId" : "patch-companies-companyId-webhooks-webhookId", - "x-groupName" : "Webhooks - company level", "x-sortIndex" : 4, "x-methodName" : "updateWebhook", "security" : [ @@ -4982,7 +4909,6 @@ "summary" : "Generate an HMAC key", "description" : "Returns an [HMAC key](https://en.wikipedia.org/wiki/HMAC) for the webhook identified in the path. This key allows you to check the integrity and the origin of the notifications you receive.By creating an HMAC key, you start receiving [HMAC-signed notifications](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures#enable-hmac-signatures) from Adyen. Find out more about how to [verify HMAC signatures](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures).\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write", "operationId" : "post-companies-companyId-webhooks-webhookId-generateHmac", - "x-groupName" : "Webhooks - company level", "x-sortIndex" : 6, "x-methodName" : "generateHmacKey", "security" : [ @@ -5092,7 +5018,6 @@ "summary" : "Test a webhook", "description" : "Sends sample notifications to test if the webhook is set up correctly.\n\nWe send sample notifications for maximum 20 of the merchant accounts that the webhook is configured for. If the webhook is configured for more than 20 merchant accounts, use the `merchantIds` array to specify a subset of the merchant accounts for which to send test notifications.\n\nWe send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP, regardless of the currencies configured in the merchant accounts. For custom notifications, we only send the specified custom notification.\n\nThe response describes the result of the test. The `status` field tells you if the test was successful or not. You can use the other response fields to troubleshoot unsuccessful tests.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write", "operationId" : "post-companies-companyId-webhooks-webhookId-test", - "x-groupName" : "Webhooks - company level", "x-sortIndex" : 7, "x-methodName" : "testWebhook", "security" : [ @@ -5216,7 +5141,6 @@ "summary" : "Get API credential details", "description" : "Returns your [API credential](https://docs.adyen.com/development-resources/api-credentials) details based on the API Key you used in the request.\n\nYou can make this request with any of the Management API roles.", "operationId" : "get-me", - "x-groupName" : "My API credential", "x-sortIndex" : 0, "x-methodName" : "getApiCredentialDetails", "security" : [ @@ -5301,7 +5225,6 @@ "summary" : "Get allowed origins", "description" : "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) of your [API credential](https://docs.adyen.com/development-resources/api-credentials) based on the API key you used in the request.\n\nYou can make this request with any of the Management API roles.", "operationId" : "get-me-allowedOrigins", - "x-groupName" : "My API credential", "x-sortIndex" : 0, "x-methodName" : "getAllowedOrigins", "security" : [ @@ -5384,7 +5307,6 @@ "summary" : "Add allowed origin", "description" : "Adds an allowed origin to the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) of your API credential.\nThe API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials).\n\nYou can make this request with any of the Management API roles.", "operationId" : "post-me-allowedOrigins", - "x-groupName" : "My API credential", "x-sortIndex" : 0, "x-methodName" : "addAllowedOrigin", "security" : [ @@ -5478,7 +5400,6 @@ "summary" : "Remove allowed origin", "description" : "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) specified in the path.\nThe API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials).\n\nYou can make this request with any of the Management API roles.", "operationId" : "delete-me-allowedOrigins-originId", - "x-groupName" : "My API credential", "x-sortIndex" : 0, "x-methodName" : "removeAllowedOrigin", "security" : [ @@ -5565,7 +5486,6 @@ "summary" : "Get allowed origin details", "description" : "Returns the details of the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) specified in the path.\nThe API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials).\n\nYou can make this request with any of the Management API roles.", "operationId" : "get-me-allowedOrigins-originId", - "x-groupName" : "My API credential", "x-sortIndex" : 0, "x-methodName" : "getAllowedOriginDetails", "security" : [ @@ -5661,7 +5581,6 @@ "summary" : "Generate a client key", "description" : "Generates a new [client key](https://docs.adyen.com/development-resources/client-side-authentication/) used to authenticate requests from your payment environment.\nYou can use the new client key a few minutes after generating it.\nThe old client key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "post-me-generateClientKey", - "x-groupName" : "My API credential", "x-sortIndex" : 0, "x-methodName" : "generateClientKey", "security" : [ @@ -5746,7 +5665,6 @@ "summary" : "Get a list of merchant accounts", "description" : "Returns the list of merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Account read", "operationId" : "get-merchants", - "x-groupName" : "Account - merchant level", "x-sortIndex" : 4, "x-methodName" : "listMerchantAccounts", "security" : [ @@ -5859,7 +5777,6 @@ "summary" : "Create a merchant account", "description" : "Creates a merchant account for the company account specified in the request.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Accounts read and write", "operationId" : "post-merchants", - "x-groupName" : "Account - merchant level", "x-sortIndex" : 1, "x-methodName" : "createMerchantAccount", "security" : [ @@ -5966,7 +5883,6 @@ "summary" : "Get a merchant account", "description" : "Returns the merchant account specified in the path. Your API credential must have access to the merchant account.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Account read", "operationId" : "get-merchants-merchantId", - "x-groupName" : "Account - merchant level", "x-sortIndex" : 3, "x-methodName" : "getMerchantAccount", "security" : [ @@ -6070,7 +5986,6 @@ "summary" : "Request to activate a merchant account", "description" : "Sends a request to activate the merchant account identified in the path.\n\nYou get the result of the activation asynchronously through a [`merchant.updated`](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.updated) webhook. Once the merchant account is activated, you can start using it to accept payments and payouts.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Accounts read and write", "operationId" : "post-merchants-merchantId-activate", - "x-groupName" : "Account - merchant level", "x-sortIndex" : 2, "x-methodName" : "requestToActivateMerchantAccount", "security" : [ @@ -6169,7 +6084,6 @@ "summary" : "Get a list of API credentials", "description" : "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the merchant account. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "get-merchants-merchantId-apiCredentials", - "x-groupName" : "API credentials - merchant level", "x-sortIndex" : 0, "x-methodName" : "listApiCredentials", "security" : [ @@ -6291,7 +6205,6 @@ "summary" : "Create an API credential", "description" : "Creates an [API credential](https://docs.adyen.com/development-resources/api-credentials) for the company account identified in the path. In the request, you can specify the roles and allowed origins for the new API credential.\n\nThe response includes the:\n* [API key](https://docs.adyen.com/development-resources/api-authentication#api-key-authentication): used for API request authentication.\n* [Client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works): public key used for client-side authentication.\n* [Username and password](https://docs.adyen.com/development-resources/api-authentication#using-basic-authentication): used for basic authentication.\n\n> Make sure you store the API key securely in your system. You won't be able to retrieve it later.\n\nIf your API key is lost or compromised, you need to [generate a new API key](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateApiKey).\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "post-merchants-merchantId-apiCredentials", - "x-groupName" : "API credentials - merchant level", "x-sortIndex" : 0, "x-methodName" : "createApiCredential", "security" : [ @@ -6409,7 +6322,6 @@ "summary" : "Get an API credential", "description" : "Returns the [API credential](https://docs.adyen.com/development-resources/api-credentials) identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "get-merchants-merchantId-apiCredentials-apiCredentialId", - "x-groupName" : "API credentials - merchant level", "x-sortIndex" : 0, "x-methodName" : "getApiCredential", "security" : [ @@ -6520,7 +6432,6 @@ "summary" : "Update an API credential", "description" : "Changes the API credential's roles, or allowed origins. The request has the new values for the fields you want to change. The response contains the full updated API credential, including the new values from the request. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "patch-merchants-merchantId-apiCredentials-apiCredentialId", - "x-groupName" : "API credentials - merchant level", "x-sortIndex" : 0, "x-methodName" : "updateApiCredential", "security" : [ @@ -6647,7 +6558,6 @@ "summary" : "Get a list of allowed origins", "description" : "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "get-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins", - "x-groupName" : "Allowed origins - merchant level", "x-sortIndex" : 0, "x-methodName" : "listAllowedOrigins", "security" : [ @@ -6758,7 +6668,6 @@ "summary" : "Create an allowed origin", "description" : "Adds a new [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) to the API credential's list of allowed origins.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "post-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins", - "x-groupName" : "Allowed origins - merchant level", "x-sortIndex" : 0, "x-methodName" : "createAllowedOrigin", "security" : [ @@ -6885,7 +6794,6 @@ "summary" : "Delete an allowed origin", "description" : "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. As soon as an allowed origin is removed, we no longer accept client-side requests from that domain.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "delete-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-originId", - "x-groupName" : "Allowed origins - merchant level", "x-sortIndex" : 0, "x-methodName" : "deleteAllowedOrigin", "security" : [ @@ -6990,7 +6898,6 @@ "summary" : "Get an allowed origin", "description" : "Returns the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "get-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-originId", - "x-groupName" : "Allowed origins - merchant level", "x-sortIndex" : 0, "x-methodName" : "getAllowedOrigin", "security" : [ @@ -7112,7 +7019,6 @@ "summary" : "Generate new API key", "description" : "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "post-merchants-merchantId-apiCredentials-apiCredentialId-generateApiKey", - "x-groupName" : "API key - merchant level", "x-sortIndex" : 0, "x-methodName" : "generateNewApiKey", "security" : [ @@ -7220,7 +7126,6 @@ "summary" : "Generate new client key", "description" : "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", "operationId" : "post-merchants-merchantId-apiCredentials-apiCredentialId-generateClientKey", - "x-groupName" : "Client key - merchant level", "x-sortIndex" : 0, "x-methodName" : "generateNewClientKey", "security" : [ @@ -7328,7 +7233,6 @@ "summary" : "Get a list of billing entities", "description" : "Returns the billing entities of the merchant account identified in the path.\nA billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write", "operationId" : "get-merchants-merchantId-billingEntities", - "x-groupName" : "Terminal orders - merchant level", "x-sortIndex" : 3, "x-methodName" : "listBillingEntities", "security" : [ @@ -7441,7 +7345,6 @@ "summary" : "Get all payment methods", "description" : "Returns details for all payment methods of the merchant account identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read\n", "operationId" : "get-merchants-merchantId-paymentMethodSettings", - "x-groupName" : "Payment methods - merchant level", "x-sortIndex" : 2, "x-methodName" : "getAllPaymentMethods", "security" : [ @@ -7576,7 +7479,6 @@ "summary" : "Request a payment method", "description" : "Sends a request to add a new payment method to the merchant account identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read and write\n", "operationId" : "post-merchants-merchantId-paymentMethodSettings", - "x-groupName" : "Payment methods - merchant level", "x-sortIndex" : 1, "x-methodName" : "requestPaymentMethod", "security" : [ @@ -7700,7 +7602,6 @@ "summary" : "Get payment method details", "description" : "Returns details for the merchant account and the payment method identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read\n", "operationId" : "get-merchants-merchantId-paymentMethodSettings-paymentMethodId", - "x-groupName" : "Payment methods - merchant level", "x-sortIndex" : 3, "x-methodName" : "getPaymentMethodDetails", "security" : [ @@ -7806,7 +7707,6 @@ "summary" : "Update a payment method", "description" : "Updates payment method details for the merchant account and the payment method identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read and write\n", "operationId" : "patch-merchants-merchantId-paymentMethodSettings-paymentMethodId", - "x-groupName" : "Payment methods - merchant level", "x-sortIndex" : 4, "x-methodName" : "updatePaymentMethod", "security" : [ @@ -7923,7 +7823,6 @@ "summary" : "Add an Apple Pay domain", "description" : "Adds the new domain to the list of Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/enable-apple-pay#register-merchant-domain).\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read and write\n", "operationId" : "post-merchants-merchantId-paymentMethodSettings-paymentMethodId-addApplePayDomains", - "x-groupName" : "Payment methods - merchant level", "x-sortIndex" : 5, "x-methodName" : "addApplePayDomain", "security" : [ @@ -8035,7 +7934,6 @@ "summary" : "Get Apple Pay domains", "description" : "Returns all Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/enable-apple-pay#register-merchant-domain).\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read\n", "operationId" : "get-merchants-merchantId-paymentMethodSettings-paymentMethodId-getApplePayDomains", - "x-groupName" : "Payment methods - merchant level", "x-sortIndex" : 6, "x-methodName" : "getApplePayDomains", "security" : [ @@ -8143,7 +8041,6 @@ "summary" : "Get a list of payout settings", "description" : "Returns the list of payout settings for the merchant account identified in the path.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payout account settings read", "operationId" : "get-merchants-merchantId-payoutSettings", - "x-groupName" : "Payout settings - merchant level", "x-sortIndex" : 3, "x-methodName" : "listPayoutSettings", "security" : [ @@ -8240,7 +8137,6 @@ "summary" : "Add a payout setting", "description" : "Sends a request to add a payout setting for the merchant account specified in the path. A payout setting links the merchant account to the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the payout bank account. Adyen verifies the bank account before allowing and enabling the payout setting.\n\nIf you're accepting payments in multiple currencies, you may add multiple payout settings for the merchant account.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\n* Management API—Payout account settings read and write", "operationId" : "post-merchants-merchantId-payoutSettings", - "x-groupName" : "Payout settings - merchant level", "x-sortIndex" : 1, "x-methodName" : "addPayoutSetting", "security" : [ @@ -8348,7 +8244,6 @@ "summary" : "Delete a payout setting", "description" : "Deletes the payout setting identified in the path.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\n* Management API—Payout account settings read and write", "operationId" : "delete-merchants-merchantId-payoutSettings-payoutSettingsId", - "x-groupName" : "Payout settings - merchant level", "x-sortIndex" : 5, "x-methodName" : "deletePayoutSetting", "security" : [ @@ -8444,7 +8339,6 @@ "summary" : "Get a payout setting", "description" : "Returns the payout setting identified in the path.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payout account settings read", "operationId" : "get-merchants-merchantId-payoutSettings-payoutSettingsId", - "x-groupName" : "Payout settings - merchant level", "x-sortIndex" : 4, "x-methodName" : "getPayoutSetting", "security" : [ @@ -8550,7 +8444,6 @@ "summary" : "Update a payout setting", "description" : "Updates the payout setting identified in the path. You can enable or disable the payout setting.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\n* Management API—Payout account settings read and write", "operationId" : "patch-merchants-merchantId-payoutSettings-payoutSettingsId", - "x-groupName" : "Payout settings - merchant level", "x-sortIndex" : 2, "x-methodName" : "updatePayoutSetting", "security" : [ @@ -8667,7 +8560,6 @@ "summary" : "Get a list of shipping locations", "description" : "Returns the shipping locations for the merchant account identified in the path.\nA shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write", "operationId" : "get-merchants-merchantId-shippingLocations", - "x-groupName" : "Terminal orders - merchant level", "x-sortIndex" : 4, "x-methodName" : "listShippingLocations", "security" : [ @@ -8798,7 +8690,6 @@ "summary" : "Create a shipping location", "description" : "Creates a shipping location for the merchant account identified in the path. A shipping location defines an address where orders can be shipped to. \n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write", "operationId" : "post-merchants-merchantId-shippingLocations", - "x-groupName" : "Terminal orders - merchant level", "x-sortIndex" : 5, "x-methodName" : "createShippingLocation", "security" : [ @@ -8916,7 +8807,6 @@ "summary" : "Get a list of split configurations", "description" : "Returns the list of split configurations for the merchant account.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write", "operationId" : "get-merchants-merchantId-splitConfigurations", - "x-groupName" : "Split configuration - merchant level", "x-sortIndex" : 3, "x-methodName" : "listSplitConfigurations", "security" : [ @@ -9018,7 +8908,6 @@ "summary" : "Create a split configuration", "description" : "Creates a split configuration for the merchant account specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write", "operationId" : "post-merchants-merchantId-splitConfigurations", - "x-groupName" : "Split configuration - merchant level", "x-sortIndex" : 1, "x-methodName" : "createSplitConfiguration", "security" : [ @@ -9136,7 +9025,6 @@ "summary" : "Delete a split configuration", "description" : "Deletes the split configuration specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write", "operationId" : "delete-merchants-merchantId-splitConfigurations-splitConfigurationId", - "x-groupName" : "Split configuration - merchant level", "x-sortIndex" : 8, "x-methodName" : "deleteSplitConfiguration", "security" : [ @@ -9242,7 +9130,6 @@ "summary" : "Get a split configuration", "description" : "Returns the split configuration specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write", "operationId" : "get-merchants-merchantId-splitConfigurations-splitConfigurationId", - "x-groupName" : "Split configuration - merchant level", "x-sortIndex" : 4, "x-methodName" : "getSplitConfiguration", "security" : [ @@ -9353,7 +9240,6 @@ "summary" : "Update split configuration description", "description" : "Changes the description of the split configuration specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write", "operationId" : "patch-merchants-merchantId-splitConfigurations-splitConfigurationId", - "x-groupName" : "Split configuration - merchant level", "x-sortIndex" : 5, "x-methodName" : "updateSplitConfigurationDescription", "security" : [ @@ -9478,7 +9364,6 @@ "summary" : "Create a rule", "description" : "Creates a rule in the split configuration specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write", "operationId" : "post-merchants-merchantId-splitConfigurations-splitConfigurationId", - "x-groupName" : "Split configuration - merchant level", "x-sortIndex" : 2, "x-methodName" : "createRule", "security" : [ @@ -9605,7 +9490,6 @@ "summary" : "Delete a split configuration rule", "description" : "Deletes the split configuration rule specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write", "operationId" : "delete-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId", - "x-groupName" : "Split configuration - merchant level", "x-sortIndex" : 9, "x-methodName" : "deleteSplitConfigurationRule", "security" : [ @@ -9719,7 +9603,6 @@ "summary" : "Update split conditions", "description" : "Changes the conditions of the split configuration rule specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write", "operationId" : "patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId", - "x-groupName" : "Split configuration - merchant level", "x-sortIndex" : 6, "x-methodName" : "updateSplitConditions", "security" : [ @@ -9855,7 +9738,6 @@ "summary" : "Update the split logic", "description" : "Changes the split logic specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write", "operationId" : "patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId-splitLogic-splitLogicId", - "x-groupName" : "Split configuration - merchant level", "x-sortIndex" : 7, "x-methodName" : "updateSplitLogic", "security" : [ @@ -10000,7 +9882,6 @@ "summary" : "Get a list of stores", "description" : "Returns a list of stores for the merchant account identified in the path. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read\n* Management API—Stores read and write", "operationId" : "get-merchants-merchantId-stores", - "x-groupName" : "Account - store level", "x-sortIndex" : 1, "x-methodName" : "listStoresByMerchantId", "security" : [ @@ -10131,7 +10012,6 @@ "summary" : "Create a store", "description" : "Creates a store for the merchant account identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read and write", "operationId" : "post-merchants-merchantId-stores", - "x-groupName" : "Account - store level", "x-sortIndex" : 0, "x-methodName" : "createStoreByMerchantId", "security" : [ @@ -10249,7 +10129,6 @@ "summary" : "Get the terminal logo", "description" : "Returns the logo that is configured for a specific payment terminal model at the store identified in the path. \nThe logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. \nThis logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write", "operationId" : "get-merchants-merchantId-stores-reference-terminalLogos", - "x-groupName" : "Terminal settings - store level", "x-sortIndex" : 2, "x-methodName" : "getTerminalLogo", "security" : [ @@ -10369,7 +10248,6 @@ "summary" : "Update the terminal logo", "description" : "Updates the logo that is configured for a specific payment terminal model at the store identified in the path. You can update the logo for only one terminal model at a time.\nThis logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. \n\n* To change the logo, specify the image file as a Base64-encoded string.\n* To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write", "operationId" : "patch-merchants-merchantId-stores-reference-terminalLogos", - "x-groupName" : "Terminal settings - store level", "x-sortIndex" : 4, "x-methodName" : "updateTerminalLogo", "security" : [ @@ -10511,7 +10389,6 @@ "summary" : "Get terminal settings", "description" : "Returns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless different values are configured for an individual terminal.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write", "operationId" : "get-merchants-merchantId-stores-reference-terminalSettings", - "x-groupName" : "Terminal settings - store level", "x-sortIndex" : 1, "x-methodName" : "getTerminalSettings", "security" : [ @@ -10622,7 +10499,6 @@ "summary" : "Update terminal settings", "description" : "Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal.\n\n* To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.\n* To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter.\n* Objects that are not included in the request are not updated.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write", "operationId" : "patch-merchants-merchantId-stores-reference-terminalSettings", - "x-groupName" : "Terminal settings - store level", "x-sortIndex" : 3, "x-methodName" : "updateTerminalSettings", "security" : [ @@ -10755,7 +10631,6 @@ "summary" : "Get a store", "description" : "Returns the details of the store identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read\n* Management API—Stores read and write", "operationId" : "get-merchants-merchantId-stores-storeId", - "x-groupName" : "Account - store level", "x-sortIndex" : 2, "x-methodName" : "getStore", "security" : [ @@ -10866,7 +10741,6 @@ "summary" : "Update a store", "description" : "Updates the store identified in the path. You can only update some store parameters.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read and write", "operationId" : "patch-merchants-merchantId-stores-storeId", - "x-groupName" : "Account - store level", "x-sortIndex" : 3, "x-methodName" : "updateStore", "security" : [ @@ -10999,7 +10873,6 @@ "summary" : "Get the terminal logo", "description" : "Returns the logo that is configured for a specific payment terminal model at the merchant account identified in the path. \nThe logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. \nThis logo applies to all terminals of the specified model under the merchant account, unless a different logo is configured at a lower level (store or individual terminal).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write", "operationId" : "get-merchants-merchantId-terminalLogos", - "x-groupName" : "Terminal settings - merchant level", "x-sortIndex" : 2, "x-methodName" : "getTerminalLogo", "security" : [ @@ -11110,7 +10983,6 @@ "summary" : "Update the terminal logo", "description" : "Updates the logo for a specific payment terminal model at the merchant account identified in the path. You can update the logo for only one terminal model at a time. \nThis logo applies to all terminals of the specified model under the merchant account, unless a different logo is configured at a lower level (store or individual terminal).\n\n* To change the logo, specify the image file as a Base64-encoded string.\n* To restore the logo inherited from the company account, specify an empty logo value.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write", "operationId" : "patch-merchants-merchantId-terminalLogos", - "x-groupName" : "Terminal settings - merchant level", "x-sortIndex" : 4, "x-methodName" : "updateTerminalLogo", "security" : [ @@ -11243,7 +11115,6 @@ "summary" : "Get a list of terminal models", "description" : "Returns the payment terminal models that merchant account identified in the path has access to. The response includes the terminal model ID, which can be used as a query parameter when getting a list of terminals or a list of products for ordering.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write", "operationId" : "get-merchants-merchantId-terminalModels", - "x-groupName" : "Terminal orders - merchant level", "x-sortIndex" : 1, "x-methodName" : "listTerminalModels", "security" : [ @@ -11347,7 +11218,6 @@ "summary" : "Get a list of orders", "description" : "Returns a list of terminal products orders for the merchant account identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write", "operationId" : "get-merchants-merchantId-terminalOrders", - "x-groupName" : "Terminal orders - merchant level", "x-sortIndex" : 7, "x-methodName" : "listOrders", "security" : [ @@ -11486,7 +11356,6 @@ "summary" : "Create an order", "description" : "Creates an order for payment terminal products for the merchant account identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write\n>Requests to the Management API test endpoint do not create actual orders for test terminals. To order test terminals, you need to [submit a sales order](https://docs.adyen.com/point-of-sale/managing-terminals/order-terminals/#sales-order-steps) in your Customer Area.", "operationId" : "post-merchants-merchantId-terminalOrders", - "x-groupName" : "Terminal orders - merchant level", "x-sortIndex" : 6, "x-methodName" : "createOrder", "security" : [ @@ -11604,7 +11473,6 @@ "summary" : "Get an order", "description" : "Returns the details of the terminal products order identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write", "operationId" : "get-merchants-merchantId-terminalOrders-orderId", - "x-groupName" : "Terminal orders - merchant level", "x-sortIndex" : 8, "x-methodName" : "getOrder", "security" : [ @@ -11715,7 +11583,6 @@ "summary" : "Update an order", "description" : "Updates the terminal products order identified in the path.\nUpdating is only possible while the order has the status **Placed**.\n\nThe request body only needs to contain what you want to change. \nHowever, to update the products in the `items` array, you must provide the entire array. For example, if the array has three items:\n To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write", "operationId" : "patch-merchants-merchantId-terminalOrders-orderId", - "x-groupName" : "Terminal orders - merchant level", "x-sortIndex" : 9, "x-methodName" : "updateOrder", "security" : [ @@ -11842,7 +11709,6 @@ "summary" : "Cancel an order", "description" : "Cancels the terminal products order identified in the path.\nCancelling is only possible while the order has the status **Placed**.\nTo cancel an order, make a POST call without a request body. The response returns the full order details, but with the status changed to **Cancelled**.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write", "operationId" : "post-merchants-merchantId-terminalOrders-orderId-cancel", - "x-groupName" : "Terminal orders - merchant level", "x-sortIndex" : 10, "x-methodName" : "cancelOrder", "security" : [ @@ -11955,7 +11821,6 @@ "summary" : "Get a list of terminal products", "description" : "Returns a country-specific list of payment terminal packages and parts that the merchant account identified in the path has access to.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write", "operationId" : "get-merchants-merchantId-terminalProducts", - "x-groupName" : "Terminal orders - merchant level", "x-sortIndex" : 2, "x-methodName" : "listTerminalProducts", "security" : [ @@ -12097,7 +11962,6 @@ "summary" : "Get terminal settings", "description" : "Returns the payment terminal settings that are configured for the merchant account identified in the path. These settings apply to all terminals under the merchant account unless different values are configured at a lower level (store or individual terminal).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write", "operationId" : "get-merchants-merchantId-terminalSettings", - "x-groupName" : "Terminal settings - merchant level", "x-sortIndex" : 1, "x-methodName" : "getTerminalSettings", "security" : [ @@ -12199,7 +12063,6 @@ "summary" : "Update terminal settings", "description" : "Updates payment terminal settings for the merchant account identified in the path.\nThese settings apply to all terminals under the merchant account, unless different values are configured at a lower level (store or individual terminal).\n\n* To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.\n* To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter.\n* Objects that are not included in the request are not updated.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write", "operationId" : "patch-merchants-merchantId-terminalSettings", - "x-groupName" : "Terminal settings - merchant level", "x-sortIndex" : 3, "x-methodName" : "updateTerminalSettings", "security" : [ @@ -12323,7 +12186,6 @@ "summary" : "Get a list of users", "description" : "Returns a list of users associated with the `merchantId` specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n", "operationId" : "get-merchants-merchantId-users", - "x-groupName" : "Users - merchant level", "x-sortIndex" : 0, "x-methodName" : "listUsers", "security" : [ @@ -12449,7 +12311,6 @@ "summary" : "Create a new user", "description" : "Creates a user for the `merchantId` specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n", "operationId" : "post-merchants-merchantId-users", - "x-groupName" : "Users - merchant level", "x-sortIndex" : 0, "x-methodName" : "createNewUser", "security" : [ @@ -12567,7 +12428,6 @@ "summary" : "Get user details", "description" : "Returns user details for the `userId` and the `merchantId` specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n", "operationId" : "get-merchants-merchantId-users-userId", - "x-groupName" : "Users - merchant level", "x-sortIndex" : 0, "x-methodName" : "getUserDetails", "security" : [ @@ -12673,7 +12533,6 @@ "summary" : "Update a user", "description" : "Updates user details for the `userId` and the `merchantId` specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n", "operationId" : "patch-merchants-merchantId-users-userId", - "x-groupName" : "Users - merchant level", "x-sortIndex" : 0, "x-methodName" : "updateUser", "security" : [ @@ -12790,7 +12649,6 @@ "summary" : "List all webhooks", "description" : "Lists all webhook configurations for the merchant account.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read\n* Management API—Webhooks read and write", "operationId" : "get-merchants-merchantId-webhooks", - "x-groupName" : "Webhooks - merchant level", "x-sortIndex" : 2, "x-methodName" : "listAllWebhooks", "security" : [ @@ -12912,7 +12770,6 @@ "summary" : "Set up a webhook", "description" : "Subscribe to receive webhook notifications about events related to your merchant account. You can add basic authentication to make sure the data is secure.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write", "operationId" : "post-merchants-merchantId-webhooks", - "x-groupName" : "Webhooks - merchant level", "x-sortIndex" : 1, "x-methodName" : "setUpWebhook", "security" : [ @@ -13030,7 +12887,6 @@ "summary" : "Remove a webhook", "description" : "Remove the configuration for the webhook identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write", "operationId" : "delete-merchants-merchantId-webhooks-webhookId", - "x-groupName" : "Webhooks - merchant level", "x-sortIndex" : 5, "x-methodName" : "removeWebhook", "security" : [ @@ -13126,7 +12982,6 @@ "summary" : "Get a webhook", "description" : "Returns the configuration for the webhook identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read\n* Management API—Webhooks read and write", "operationId" : "get-merchants-merchantId-webhooks-webhookId", - "x-groupName" : "Webhooks - merchant level", "x-sortIndex" : 3, "x-methodName" : "getWebhook", "security" : [ @@ -13237,7 +13092,6 @@ "summary" : "Update a webhook", "description" : "Make changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration. The response contains the full configuration for the webhook, which includes the new values from the request.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write", "operationId" : "patch-merchants-merchantId-webhooks-webhookId", - "x-groupName" : "Webhooks - merchant level", "x-sortIndex" : 4, "x-methodName" : "updateWebhook", "security" : [ @@ -13364,7 +13218,6 @@ "summary" : "Generate an HMAC key", "description" : "Returns an [HMAC key](https://en.wikipedia.org/wiki/HMAC) for the webhook identified in the path. This key allows you to check the integrity and the origin of the notifications you receive.By creating an HMAC key, you start receiving [HMAC-signed notifications](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures#enable-hmac-signatures) from Adyen. Find out more about how to [verify HMAC signatures](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures).\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write", "operationId" : "post-merchants-merchantId-webhooks-webhookId-generateHmac", - "x-groupName" : "Webhooks - merchant level", "x-sortIndex" : 6, "x-methodName" : "generateHmacKey", "security" : [ @@ -13476,7 +13329,6 @@ "summary" : "Test a webhook", "description" : "Sends sample notifications to test if the webhook is set up correctly.\n\nWe send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP, regardless of the currencies configured in the merchant accounts. For custom notifications, we only send the specified custom notification.\n\nThe response describes the result of the test. The `status` field tells you if the test was successful or not. You can use the other fields to troubleshoot unsuccessful tests.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write", "operationId" : "post-merchants-merchantId-webhooks-webhookId-test", - "x-groupName" : "Webhooks - merchant level", "x-sortIndex" : 7, "x-methodName" : "testWebhook", "security" : [ @@ -13603,7 +13455,6 @@ "summary" : "Get a list of stores", "description" : "Returns a list of stores. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read\n* Management API—Stores read and write", "operationId" : "get-stores", - "x-groupName" : "Account - store level", "x-sortIndex" : 4, "x-methodName" : "listStores", "security" : [ @@ -13731,7 +13582,6 @@ "summary" : "Create a store", "description" : "Creates a store for the merchant account specified in the request.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read and write", "operationId" : "post-stores", - "x-groupName" : "Account - store level", "x-sortIndex" : 5, "x-methodName" : "createStore", "security" : [ @@ -13835,7 +13685,6 @@ "summary" : "Get a store", "description" : "Returns the details of the store identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read\n* Management API—Stores read and write", "operationId" : "get-stores-storeId", - "x-groupName" : "Account - store level", "x-sortIndex" : 6, "x-methodName" : "getStoreById", "security" : [ @@ -13934,7 +13783,6 @@ "summary" : "Update a store", "description" : "Updates the store identified in the path.\nYou can only update some store parameters.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read and write", "operationId" : "patch-stores-storeId", - "x-groupName" : "Account - store level", "x-sortIndex" : 7, "x-methodName" : "updateStoreById", "security" : [ @@ -14052,7 +13900,6 @@ "summary" : "Get the terminal logo", "description" : "Returns the logo that is configured for a specific payment terminal model at the store identified in the path. \nThe logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. \nThis logo applies to all terminals of that model under the store unless a different logo is configured for an individual terminal.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write", "operationId" : "get-stores-storeId-terminalLogos", - "x-groupName" : "Terminal settings - store level", "x-sortIndex" : 2, "x-methodName" : "getTerminalLogoByStoreId", "security" : [ @@ -14160,7 +14007,6 @@ "summary" : "Update the terminal logo", "description" : "Updates the logo that is configured for a specific payment terminal model at the store identified in the path. You can update the logo for only one terminal model at a time.\nThis logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. \n\n* To change the logo, specify the image file as a Base64-encoded string.\n* To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write", "operationId" : "patch-stores-storeId-terminalLogos", - "x-groupName" : "Terminal settings - store level", "x-sortIndex" : 4, "x-methodName" : "updateTerminalLogoByStoreId", "security" : [ @@ -14290,7 +14136,6 @@ "summary" : "Get terminal settings", "description" : "Returns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless different values are configured for an individual terminal.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write", "operationId" : "get-stores-storeId-terminalSettings", - "x-groupName" : "Terminal settings - store level", "x-sortIndex" : 1, "x-methodName" : "getTerminalSettingsByStoreId", "security" : [ @@ -14389,7 +14234,6 @@ "summary" : "Update terminal settings", "description" : "Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal.\n\n* To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.\n* To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter.\n* Objects that are not included in the request are not updated.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write", "operationId" : "patch-stores-storeId-terminalSettings", - "x-groupName" : "Terminal settings - store level", "x-sortIndex" : 3, "x-methodName" : "updateTerminalSettingsByStoreId", "security" : [ @@ -14510,7 +14354,6 @@ "summary" : "Get a list of terminals", "description" : "Returns the payment terminals that the API credential has access to and that match the query parameters. \nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API — Terminal actions read", "operationId" : "get-terminals", - "x-groupName" : "Terminals - terminal level", "x-sortIndex" : 1, "x-methodName" : "listTerminals", "security" : [ @@ -14676,7 +14519,6 @@ "summary" : "Create a terminal action", "description" : "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. \n\nThe following restrictions apply:\n* You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. \n* The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. \n* If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. \n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal actions read and write", "operationId" : "post-terminals-scheduleActions", - "x-groupName" : "Terminal actions - terminal level", "x-sortIndex" : 1, "x-methodName" : "createTerminalAction", "security" : [ @@ -14795,7 +14637,6 @@ "description" : "Reassigns a payment terminal to a company account, merchant account, merchant account inventory, or a store.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Assign Terminal", "x-addedInVersion" : "3", "operationId" : "post-terminals-terminalId-reassign", - "x-groupName" : "Terminals - terminal level", "x-sortIndex" : 2, "x-methodName" : "reassignTerminal", "security" : [ @@ -14893,7 +14734,6 @@ "summary" : "Get the terminal logo", "description" : "Returns the logo that is configured for the payment terminal identified in the path.\nThe logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write", "operationId" : "get-terminals-terminalId-terminalLogos", - "x-groupName" : "Terminal settings - terminal level", "x-sortIndex" : 4, "x-methodName" : "getTerminalLogo", "security" : [ @@ -14992,7 +14832,6 @@ "summary" : "Update the logo", "description" : "Updates the logo for the payment terminal identified in the path.\n\n* To change the logo, specify the image file as a Base64-encoded string.\n* To restore the logo inherited from a higher level (store, merchant account, or company account), specify an empty logo value.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write", "operationId" : "patch-terminals-terminalId-terminalLogos", - "x-groupName" : "Terminal settings - terminal level", "x-sortIndex" : 6, "x-methodName" : "updateLogo", "security" : [ @@ -15113,7 +14952,6 @@ "summary" : "Get terminal settings", "description" : "Returns the settings that are configured for the payment terminal identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write", "operationId" : "get-terminals-terminalId-terminalSettings", - "x-groupName" : "Terminal settings - terminal level", "x-sortIndex" : 3, "x-methodName" : "getTerminalSettings", "security" : [ @@ -15212,7 +15050,6 @@ "summary" : "Update terminal settings", "description" : "Updates the settings that are configured for the payment terminal identified in the path.\n\n* To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.\n* To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter.\n* Objects that are not included in the request are not updated.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write", "operationId" : "patch-terminals-terminalId-terminalSettings", - "x-groupName" : "Terminal settings - terminal level", "x-sortIndex" : 5, "x-methodName" : "updateTerminalSettings", "security" : [ @@ -19404,6 +19241,15 @@ ], "type" : "object" }, + "TapToPay" : { + "properties" : { + "merchantDisplayName" : { + "description" : "Platform merchants can customize the text that appears on the TapToPay screen during a transaction", + "type" : "string" + } + }, + "type" : "object" + }, "Terminal" : { "properties" : { "assignment" : { @@ -19844,6 +19690,10 @@ "description" : "Settings for payment [surcharge](https://docs.adyen.com/point-of-sale/surcharge) features.", "$ref" : "#/components/schemas/Surcharge" }, + "tapToPay" : { + "description" : "Settings for apple tap to pay.", + "$ref" : "#/components/schemas/TapToPay" + }, "timeouts" : { "description" : "Settings for device [time-outs](https://docs.adyen.com/point-of-sale/pos-timeouts#device-time-out).", "$ref" : "#/components/schemas/Timeouts" diff --git a/yaml/ManagementNotificationService-v1.yaml b/yaml/ManagementNotificationService-v1.yaml index 25265d2..0957d21 100644 --- a/yaml/ManagementNotificationService-v1.yaml +++ b/yaml/ManagementNotificationService-v1.yaml @@ -18,9 +18,6 @@ info: contact: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi -x-groups: -- Merchant account -- Payment method tags: - name: Merchant account - name: Payment method @@ -34,7 +31,6 @@ webhooks: description: A merchant account [was created](https://docs.adyen.com/api-explorer/#/ManagementService/latest/post/merchants). x-addedInVersion: '1' operationId: post-merchant.created - x-groupName: Merchant account x-sortIndex: 1 x-methodName: merchantAccountCreated security: @@ -68,7 +64,6 @@ webhooks: that you can take to resolve them. x-addedInVersion: '1' operationId: post-merchant.updated - x-groupName: Merchant account x-sortIndex: 2 x-methodName: merchantAccountCapabilityUpdated security: @@ -104,7 +99,6 @@ webhooks: was completed. x-addedInVersion: '1' operationId: post-paymentMethod.created - x-groupName: Payment method x-sortIndex: 1 x-methodName: paymentMethodCreated security: diff --git a/yaml/ManagementNotificationService-v3.yaml b/yaml/ManagementNotificationService-v3.yaml index cf9c8d3..13e807e 100644 --- a/yaml/ManagementNotificationService-v3.yaml +++ b/yaml/ManagementNotificationService-v3.yaml @@ -18,9 +18,6 @@ info: contact: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi -x-groups: -- Merchant account -- Payment method tags: - name: Merchant account - name: Payment method @@ -34,7 +31,6 @@ webhooks: description: A merchant account [was created](https://docs.adyen.com/api-explorer/#/ManagementService/latest/post/merchants). x-addedInVersion: '1' operationId: post-merchant.created - x-groupName: Merchant account x-sortIndex: 1 x-methodName: merchantAccountCreated security: @@ -68,7 +64,6 @@ webhooks: that you can take to resolve them. x-addedInVersion: '1' operationId: post-merchant.updated - x-groupName: Merchant account x-sortIndex: 2 x-methodName: merchantAccountCapabilityUpdated security: @@ -104,7 +99,6 @@ webhooks: was completed. x-addedInVersion: '1' operationId: post-paymentMethod.created - x-groupName: Payment method x-sortIndex: 1 x-methodName: paymentMethodCreated security: @@ -136,7 +130,6 @@ webhooks: request to [add a payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings). x-addedInVersion: '2' operationId: post-paymentMethod.requestRemoved - x-groupName: Payment method x-sortIndex: 3 x-methodName: paymentMethodRequestRemoved security: @@ -169,7 +162,6 @@ webhooks: the missing [KYC information](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details). x-addedInVersion: '2' operationId: post-paymentMethod.requestScheduledForRemoval - x-groupName: Payment method x-sortIndex: 2 x-methodName: paymentMethodRequestScheduledForRemoval security: diff --git a/yaml/ManagementService-v1.yaml b/yaml/ManagementService-v1.yaml index 6014e88..7be5ace 100644 --- a/yaml/ManagementService-v1.yaml +++ b/yaml/ManagementService-v1.yaml @@ -55,36 +55,6 @@ info: contact: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi -x-groups: -- Account - company level -- Account - merchant level -- Account - store level -- Payout settings - merchant level -- Users - company level -- Users - merchant level -- My API credential -- API credentials - company level -- API credentials - merchant level -- API key - company level -- API key - merchant level -- Client key - company level -- Client key - merchant level -- Allowed origins - company level -- Allowed origins - merchant level -- Webhooks - company level -- Webhooks - merchant level -- Payment methods - merchant level -- Terminals - terminal level -- Terminal actions - company level -- Terminal actions - terminal level -- Terminal orders - company level -- Terminal orders - merchant level -- Terminal settings - company level -- Terminal settings - merchant level -- Terminal settings - store level -- Terminal settings - terminal level -- Android files - company level -- Split configuration - merchant level tags: - name: Account - company level - name: Account - merchant level @@ -126,7 +96,6 @@ paths: \nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ \n* Management API\u2014Account read" operationId: get-companies - x-groupName: Account - company level x-sortIndex: 0 x-methodName: listCompanyAccounts security: @@ -198,7 +167,6 @@ paths: \ API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Account read" operationId: get-companies-companyId - x-groupName: Account - company level x-sortIndex: 0 x-methodName: getCompanyAccount security: @@ -266,7 +234,6 @@ paths: \ read and write\n* Management API\u2014Terminal actions read\n* Management\ \ API\u2014Terminal actions read and write" operationId: get-companies-companyId-androidApps - x-groupName: Android files - company level x-sortIndex: 1 x-methodName: listAndroidApps security: @@ -360,7 +327,6 @@ paths: * Management API\u2014Android files read\n* Management API\u2014Android files\ \ read and write" operationId: get-companies-companyId-androidApps-id - x-groupName: Android files - company level x-sortIndex: 3 x-methodName: getAndroidApp security: @@ -432,7 +398,6 @@ paths: \ read and write\n* Management API\u2014Terminal actions read\n* Management\ \ API\u2014Terminal actions read and write" operationId: get-companies-companyId-androidCertificates - x-groupName: Android files - company level x-sortIndex: 2 x-methodName: listAndroidCertificates security: @@ -517,7 +482,6 @@ paths: \ the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: get-companies-companyId-apiCredentials - x-groupName: API credentials - company level x-sortIndex: 0 x-methodName: listApiCredentials security: @@ -602,7 +566,6 @@ paths: \nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: post-companies-companyId-apiCredentials - x-groupName: API credentials - company level x-sortIndex: 0 x-methodName: createApiCredential security: @@ -673,7 +636,6 @@ paths: \ have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: get-companies-companyId-apiCredentials-apiCredentialId - x-groupName: API credentials - company level x-sortIndex: 0 x-methodName: getApiCredential security: @@ -743,7 +705,6 @@ paths: \ must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: patch-companies-companyId-apiCredentials-apiCredentialId - x-groupName: API credentials - company level x-sortIndex: 0 x-methodName: updateApiCredential security: @@ -820,7 +781,6 @@ paths: \ your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: get-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins - x-groupName: Allowed origins - company level x-sortIndex: 0 x-methodName: listAllowedOrigins security: @@ -888,7 +848,6 @@ paths: \ your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: post-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins - x-groupName: Allowed origins - company level x-sortIndex: 0 x-methodName: createAllowedOrigin security: @@ -966,7 +925,6 @@ paths: \ API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: delete-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-originId - x-groupName: Allowed origins - company level x-sortIndex: 0 x-methodName: deleteAllowedOrigin security: @@ -1034,7 +992,6 @@ paths: \ have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: get-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-originId - x-groupName: Allowed origins - company level x-sortIndex: 0 x-methodName: getAllowedOrigin security: @@ -1110,7 +1067,6 @@ paths: \ must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: post-companies-companyId-apiCredentials-apiCredentialId-generateApiKey - x-groupName: API key - company level x-sortIndex: 0 x-methodName: generateNewApiKey security: @@ -1178,7 +1134,6 @@ paths: \ must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: post-companies-companyId-apiCredentials-apiCredentialId-generateClientKey - x-groupName: Client key - company level x-sortIndex: 0 x-methodName: generateNewClientKey security: @@ -1247,7 +1202,6 @@ paths: * Management API\u2014Terminal ordering read\n* Management API\u2014Terminal\ \ ordering read and write" operationId: get-companies-companyId-billingEntities - x-groupName: Terminal orders - company level x-sortIndex: 3 x-methodName: listBillingEntities security: @@ -1318,7 +1272,6 @@ paths: \ have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Account read" operationId: get-companies-companyId-merchants - x-groupName: Account - company level x-sortIndex: 0 x-methodName: listMerchantAccounts security: @@ -1399,7 +1352,6 @@ paths: * Management API\u2014Terminal ordering read\n* Management API\u2014Terminal\ \ ordering read and write" operationId: get-companies-companyId-shippingLocations - x-groupName: Terminal orders - company level x-sortIndex: 4 x-methodName: listShippingLocations security: @@ -1481,7 +1433,6 @@ paths: \nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal ordering read and write" operationId: post-companies-companyId-shippingLocations - x-groupName: Terminal orders - company level x-sortIndex: 5 x-methodName: createShippingLocation security: @@ -1554,7 +1505,6 @@ paths: * Management API\u2014Terminal actions read\n* Management API\u2014Terminal\ \ actions read and write" operationId: get-companies-companyId-terminalActions - x-groupName: Terminal actions - company level x-sortIndex: 1 x-methodName: listTerminalActions security: @@ -1648,7 +1598,6 @@ paths: * Management API\u2014Terminal actions read\n* Management API\u2014Terminal\ \ actions read and write" operationId: get-companies-companyId-terminalActions-actionId - x-groupName: Terminal actions - company level x-sortIndex: 2 x-methodName: getTerminalAction security: @@ -1722,7 +1671,6 @@ paths: * Management API\u2014Terminal settings read\n* Management API\u2014Terminal\ \ settings read and write" operationId: get-companies-companyId-terminalLogos - x-groupName: Terminal settings - company level x-sortIndex: 2 x-methodName: getTerminalLogo security: @@ -1798,7 +1746,6 @@ paths: \ [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal settings read and write" operationId: patch-companies-companyId-terminalLogos - x-groupName: Terminal settings - company level x-sortIndex: 4 x-methodName: updateTerminalLogo security: @@ -1884,7 +1831,6 @@ paths: * Management API\u2014Terminal ordering read\n* Management API\u2014Terminal\ \ ordering read and write" operationId: get-companies-companyId-terminalModels - x-groupName: Terminal orders - company level x-sortIndex: 1 x-methodName: listTerminalModels security: @@ -1949,7 +1895,6 @@ paths: * Management API\u2014Terminal ordering read\n* Management API\u2014Terminal\ \ ordering read and write" operationId: get-companies-companyId-terminalOrders - x-groupName: Terminal orders - company level x-sortIndex: 7 x-methodName: listOrders security: @@ -2041,7 +1986,6 @@ paths: \ test terminals, you need to [submit a sales order](https://docs.adyen.com/point-of-sale/managing-terminals/order-terminals/#sales-order-steps)\ \ in your Customer Area." operationId: post-companies-companyId-terminalOrders - x-groupName: Terminal orders - company level x-sortIndex: 6 x-methodName: createOrder security: @@ -2113,7 +2057,6 @@ paths: * Management API\u2014Terminal ordering read\n* Management API\u2014Terminal\ \ ordering read and write" operationId: get-companies-companyId-terminalOrders-orderId - x-groupName: Terminal orders - company level x-sortIndex: 8 x-methodName: getOrder security: @@ -2186,7 +2129,6 @@ paths: \ have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal ordering read and write" operationId: patch-companies-companyId-terminalOrders-orderId - x-groupName: Terminal orders - company level x-sortIndex: 9 x-methodName: updateOrder security: @@ -2265,7 +2207,6 @@ paths: To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal ordering read and write" operationId: post-companies-companyId-terminalOrders-orderId-cancel - x-groupName: Terminal orders - company level x-sortIndex: 10 x-methodName: cancelOrder security: @@ -2335,7 +2276,6 @@ paths: * Management API\u2014Terminal ordering read\n* Management API\u2014Terminal\ \ ordering read and write" operationId: get-companies-companyId-terminalProducts - x-groupName: Terminal orders - company level x-sortIndex: 2 x-methodName: listTerminalProducts security: @@ -2432,7 +2372,6 @@ paths: \ your API credential must have the following role:\n* Management API\u2014\ Terminal settings Advanced read and write" operationId: get-companies-companyId-terminalSettings - x-groupName: Terminal settings - company level x-sortIndex: 1 x-methodName: getTerminalSettings security: @@ -2504,7 +2443,6 @@ paths: \ your API credential must have the following role:\n* Management API\u2014\ Terminal settings Advanced read and write" operationId: patch-companies-companyId-terminalSettings - x-groupName: Terminal settings - company level x-sortIndex: 3 x-methodName: updateTerminalSettings security: @@ -2579,7 +2517,6 @@ paths: \ [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Users read and write\n" operationId: get-companies-companyId-users - x-groupName: Users - company level x-sortIndex: 0 x-methodName: listUsers security: @@ -2658,7 +2595,6 @@ paths: \nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Users read and write\n" operationId: post-companies-companyId-users - x-groupName: Users - company level x-sortIndex: 0 x-methodName: createNewUser security: @@ -2729,7 +2665,6 @@ paths: \ following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Users read and write\n" operationId: get-companies-companyId-users-userId - x-groupName: Users - company level x-sortIndex: 0 x-methodName: getUserDetails security: @@ -2794,7 +2729,6 @@ paths: \ following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Users read and write\n" operationId: patch-companies-companyId-users-userId - x-groupName: Users - company level x-sortIndex: 0 x-methodName: updateUserDetails security: @@ -2865,7 +2799,6 @@ paths: * Management API\u2014Webhooks read\n* Management API\u2014Webhooks read and\ \ write" operationId: get-companies-companyId-webhooks - x-groupName: Webhooks - company level x-sortIndex: 2 x-methodName: listAllWebhooks security: @@ -2943,7 +2876,6 @@ paths: \ following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Webhooks read and write" operationId: post-companies-companyId-webhooks - x-groupName: Webhooks - company level x-sortIndex: 1 x-methodName: setUpWebhook security: @@ -3013,7 +2945,6 @@ paths: \nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Webhooks read and write" operationId: delete-companies-companyId-webhooks-webhookId - x-groupName: Webhooks - company level x-sortIndex: 5 x-methodName: removeWebhook security: @@ -3076,7 +3007,6 @@ paths: * Management API\u2014Webhooks read\n* Management API\u2014Webhooks read and\ \ write" operationId: get-companies-companyId-webhooks-webhookId - x-groupName: Webhooks - company level x-sortIndex: 3 x-methodName: getWebhook security: @@ -3146,7 +3076,6 @@ paths: \ your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Webhooks read and write" operationId: patch-companies-companyId-webhooks-webhookId - x-groupName: Webhooks - company level x-sortIndex: 4 x-methodName: updateWebhook security: @@ -3226,7 +3155,6 @@ paths: \nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Webhooks read and write" operationId: post-companies-companyId-webhooks-webhookId-generateHmac - x-groupName: Webhooks - company level x-sortIndex: 6 x-methodName: generateHmacKey security: @@ -3305,7 +3233,6 @@ paths: \ [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Webhooks read and write" operationId: post-companies-companyId-webhooks-webhookId-test - x-groupName: Webhooks - company level x-sortIndex: 7 x-methodName: testWebhook security: @@ -3383,7 +3310,6 @@ paths: You can make this request with any of the Management API roles.' operationId: get-me - x-groupName: My API credential x-sortIndex: 0 x-methodName: getApiCredentialDetails security: @@ -3438,7 +3364,6 @@ paths: You can make this request with any of the Management API roles.' operationId: get-me-allowedOrigins - x-groupName: My API credential x-sortIndex: 0 x-methodName: getAllowedOrigins security: @@ -3493,7 +3418,6 @@ paths: You can make this request with any of the Management API roles.' operationId: post-me-allowedOrigins - x-groupName: My API credential x-sortIndex: 0 x-methodName: addAllowedOrigin security: @@ -3554,7 +3478,6 @@ paths: You can make this request with any of the Management API roles.' operationId: delete-me-allowedOrigins-originId - x-groupName: My API credential x-sortIndex: 0 x-methodName: removeAllowedOrigin security: @@ -3613,7 +3536,6 @@ paths: You can make this request with any of the Management API roles.' operationId: get-me-allowedOrigins-originId - x-groupName: My API credential x-sortIndex: 0 x-methodName: getAllowedOriginDetails security: @@ -3675,7 +3597,6 @@ paths: \ your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: post-me-generateClientKey - x-groupName: My API credential x-sortIndex: 0 x-methodName: generateClientKey security: @@ -3728,7 +3649,6 @@ paths: \ \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Account read" operationId: get-merchants - x-groupName: Account - merchant level x-sortIndex: 4 x-methodName: listMerchantAccounts security: @@ -3803,7 +3723,6 @@ paths: \nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Accounts read and write" operationId: post-merchants - x-groupName: Account - merchant level x-sortIndex: 1 x-methodName: createMerchantAccount security: @@ -3870,7 +3789,6 @@ paths: \ API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Account read" operationId: get-merchants-merchantId - x-groupName: Account - merchant level x-sortIndex: 3 x-methodName: getMerchantAccount security: @@ -3941,7 +3859,6 @@ paths: \ the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Accounts read and write" operationId: post-merchants-merchantId-activate - x-groupName: Account - merchant level x-sortIndex: 2 x-methodName: requestToActivateMerchantAccount security: @@ -4005,7 +3922,6 @@ paths: \ the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: get-merchants-merchantId-apiCredentials - x-groupName: API credentials - merchant level x-sortIndex: 0 x-methodName: listApiCredentials security: @@ -4092,7 +4008,6 @@ paths: \nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: post-merchants-merchantId-apiCredentials - x-groupName: API credentials - merchant level x-sortIndex: 0 x-methodName: createApiCredential security: @@ -4166,7 +4081,6 @@ paths: \ have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: get-merchants-merchantId-apiCredentials-apiCredentialId - x-groupName: API credentials - merchant level x-sortIndex: 0 x-methodName: getApiCredential security: @@ -4238,7 +4152,6 @@ paths: \ \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: patch-merchants-merchantId-apiCredentials-apiCredentialId - x-groupName: API credentials - merchant level x-sortIndex: 0 x-methodName: updateApiCredential security: @@ -4318,7 +4231,6 @@ paths: \ your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: get-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins - x-groupName: Allowed origins - merchant level x-sortIndex: 0 x-methodName: listAllowedOrigins security: @@ -4389,7 +4301,6 @@ paths: \ your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: post-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins - x-groupName: Allowed origins - merchant level x-sortIndex: 0 x-methodName: createAllowedOrigin security: @@ -4470,7 +4381,6 @@ paths: \ API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: delete-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-originId - x-groupName: Allowed origins - merchant level x-sortIndex: 0 x-methodName: deleteAllowedOrigin security: @@ -4538,7 +4448,6 @@ paths: \ have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: get-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-originId - x-groupName: Allowed origins - merchant level x-sortIndex: 0 x-methodName: getAllowedOrigin security: @@ -4617,7 +4526,6 @@ paths: \ must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: post-merchants-merchantId-apiCredentials-apiCredentialId-generateApiKey - x-groupName: API key - merchant level x-sortIndex: 0 x-methodName: generateNewApiKey security: @@ -4688,7 +4596,6 @@ paths: \ must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: post-merchants-merchantId-apiCredentials-apiCredentialId-generateClientKey - x-groupName: Client key - merchant level x-sortIndex: 0 x-methodName: generateNewClientKey security: @@ -4760,7 +4667,6 @@ paths: * Management API\u2014Terminal ordering read\n* Management API\u2014Terminal\ \ ordering read and write" operationId: get-merchants-merchantId-billingEntities - x-groupName: Terminal orders - merchant level x-sortIndex: 3 x-methodName: listBillingEntities security: @@ -4832,7 +4738,6 @@ paths: \ have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Payment methods read\n" operationId: get-merchants-merchantId-paymentMethodSettings - x-groupName: Payment methods - merchant level x-sortIndex: 2 x-methodName: getAllPaymentMethods security: @@ -4923,7 +4828,6 @@ paths: \ have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Payment methods read and write\n" operationId: post-merchants-merchantId-paymentMethodSettings - x-groupName: Payment methods - merchant level x-sortIndex: 1 x-methodName: requestPaymentMethod security: @@ -5001,7 +4905,6 @@ paths: \ have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Payment methods read\n" operationId: get-merchants-merchantId-paymentMethodSettings-paymentMethodId - x-groupName: Payment methods - merchant level x-sortIndex: 3 x-methodName: getPaymentMethodDetails security: @@ -5069,7 +4972,6 @@ paths: \ credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Payment methods read and write\n" operationId: patch-merchants-merchantId-paymentMethodSettings-paymentMethodId - x-groupName: Payment methods - merchant level x-sortIndex: 4 x-methodName: updatePaymentMethod security: @@ -5144,7 +5046,6 @@ paths: \nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Payment methods read and write\n" operationId: post-merchants-merchantId-paymentMethodSettings-paymentMethodId-addApplePayDomains - x-groupName: Payment methods - merchant level x-sortIndex: 5 x-methodName: addApplePayDomain security: @@ -5216,7 +5117,6 @@ paths: \nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Payment methods read\n" operationId: get-merchants-merchantId-paymentMethodSettings-paymentMethodId-getApplePayDomains - x-groupName: Payment methods - merchant level x-sortIndex: 6 x-methodName: getApplePayDomains security: @@ -5286,7 +5186,6 @@ paths: \nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Payout account settings read" operationId: get-merchants-merchantId-payoutSettings - x-groupName: Payout settings - merchant level x-sortIndex: 3 x-methodName: listPayoutSettings security: @@ -5355,7 +5254,6 @@ paths: \ [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ \n* Management API\u2014Payout account settings read and write" operationId: post-merchants-merchantId-payoutSettings - x-groupName: Payout settings - merchant level x-sortIndex: 1 x-methodName: addPayoutSetting security: @@ -5424,7 +5322,6 @@ paths: \ API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ \n* Management API\u2014Payout account settings read and write" operationId: delete-merchants-merchantId-payoutSettings-payoutSettingsId - x-groupName: Payout settings - merchant level x-sortIndex: 5 x-methodName: deletePayoutSetting security: @@ -5487,7 +5384,6 @@ paths: \ API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Payout account settings read" operationId: get-merchants-merchantId-payoutSettings-payoutSettingsId - x-groupName: Payout settings - merchant level x-sortIndex: 4 x-methodName: getPayoutSetting security: @@ -5557,7 +5453,6 @@ paths: \ the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ \n* Management API\u2014Payout account settings read and write" operationId: patch-merchants-merchantId-payoutSettings-payoutSettingsId - x-groupName: Payout settings - merchant level x-sortIndex: 2 x-methodName: updatePayoutSetting security: @@ -5634,7 +5529,6 @@ paths: * Management API\u2014Terminal ordering read\n* Management API\u2014Terminal\ \ ordering read and write" operationId: get-merchants-merchantId-shippingLocations - x-groupName: Terminal orders - merchant level x-sortIndex: 4 x-methodName: listShippingLocations security: @@ -5720,7 +5614,6 @@ paths: \ following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal ordering read and write" operationId: post-merchants-merchantId-shippingLocations - x-groupName: Terminal orders - merchant level x-sortIndex: 5 x-methodName: createShippingLocation security: @@ -5796,7 +5689,6 @@ paths: * Management API - SplitConfiguration read and write' operationId: get-merchants-merchantId-splitConfigurations - x-groupName: Split configuration - merchant level x-sortIndex: 3 x-methodName: listSplitConfigurations security: @@ -5864,7 +5756,6 @@ paths: * Management API - SplitConfiguration read and write' operationId: post-merchants-merchantId-splitConfigurations - x-groupName: Split configuration - merchant level x-sortIndex: 1 x-methodName: createSplitConfiguration security: @@ -5940,7 +5831,6 @@ paths: * Management API - SplitConfiguration read and write' operationId: delete-merchants-merchantId-splitConfigurations-splitConfigurationId - x-groupName: Split configuration - merchant level x-sortIndex: 8 x-methodName: deleteSplitConfiguration security: @@ -6010,7 +5900,6 @@ paths: * Management API - SplitConfiguration read and write' operationId: get-merchants-merchantId-splitConfigurations-splitConfigurationId - x-groupName: Split configuration - merchant level x-sortIndex: 4 x-methodName: getSplitConfiguration security: @@ -6084,7 +5973,6 @@ paths: * Management API - SplitConfiguration read and write' operationId: patch-merchants-merchantId-splitConfigurations-splitConfigurationId - x-groupName: Split configuration - merchant level x-sortIndex: 5 x-methodName: updateSplitConfigurationDescription security: @@ -6165,7 +6053,6 @@ paths: * Management API - SplitConfiguration read and write' operationId: post-merchants-merchantId-splitConfigurations-splitConfigurationId - x-groupName: Split configuration - merchant level x-sortIndex: 2 x-methodName: createRule security: @@ -6247,7 +6134,6 @@ paths: * Management API - SplitConfiguration read and write' operationId: delete-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId - x-groupName: Split configuration - merchant level x-sortIndex: 9 x-methodName: deleteSplitConfigurationRule security: @@ -6323,7 +6209,6 @@ paths: * Management API - SplitConfiguration read and write' operationId: patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId - x-groupName: Split configuration - merchant level x-sortIndex: 6 x-methodName: updateSplitConditions security: @@ -6411,7 +6296,6 @@ paths: * Management API - SplitConfiguration read and write' operationId: patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId-splitLogic-splitLogicId - x-groupName: Split configuration - merchant level x-sortIndex: 7 x-methodName: updateSplitLogic security: @@ -6504,7 +6388,6 @@ paths: \ [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Stores read\n* Management API\u2014Stores read and write" operationId: get-merchants-merchantId-stores - x-groupName: Account - store level x-sortIndex: 1 x-methodName: listStoresByMerchantId security: @@ -6589,7 +6472,6 @@ paths: \nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Stores read and write" operationId: post-merchants-merchantId-stores - x-groupName: Account - store level x-sortIndex: 0 x-methodName: createStoreByMerchantId security: @@ -6667,7 +6549,6 @@ paths: * Management API\u2014Terminal settings read\n* Management API\u2014Terminal\ \ settings read and write" operationId: get-merchants-merchantId-stores-reference-terminalLogos - x-groupName: Terminal settings - store level x-sortIndex: 2 x-methodName: getTerminalLogo security: @@ -6751,7 +6632,6 @@ paths: \ make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal settings read and write" operationId: patch-merchants-merchantId-stores-reference-terminalLogos - x-groupName: Terminal settings - store level x-sortIndex: 4 x-methodName: updateTerminalLogo security: @@ -6848,7 +6728,6 @@ paths: \ your API credential must have the following role:\n* Management API\u2014\ Terminal settings Advanced read and write" operationId: get-merchants-merchantId-stores-reference-terminalSettings - x-groupName: Terminal settings - store level x-sortIndex: 1 x-methodName: getTerminalSettings security: @@ -6929,7 +6808,6 @@ paths: \ your API credential must have the following role:\n* Management API\u2014\ Terminal settings Advanced read and write" operationId: patch-merchants-merchantId-stores-reference-terminalSettings - x-groupName: Terminal settings - store level x-sortIndex: 3 x-methodName: updateTerminalSettings security: @@ -7012,7 +6890,6 @@ paths: \ make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Stores read\n* Management API\u2014Stores read and write" operationId: get-merchants-merchantId-stores-storeId - x-groupName: Account - store level x-sortIndex: 2 x-methodName: getStore security: @@ -7083,7 +6960,6 @@ paths: \ have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Stores read and write" operationId: patch-merchants-merchantId-stores-storeId - x-groupName: Account - store level x-sortIndex: 3 x-methodName: updateStore security: @@ -7172,7 +7048,6 @@ paths: * Management API\u2014Terminal settings read\n* Management API\u2014Terminal\ \ settings read and write" operationId: get-merchants-merchantId-terminalLogos - x-groupName: Terminal settings - merchant level x-sortIndex: 2 x-methodName: getTerminalLogo security: @@ -7250,7 +7125,6 @@ paths: \ this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal settings read and write" operationId: patch-merchants-merchantId-terminalLogos - x-groupName: Terminal settings - merchant level x-sortIndex: 4 x-methodName: updateTerminalLogo security: @@ -7339,7 +7213,6 @@ paths: * Management API\u2014Terminal ordering read\n* Management API\u2014Terminal\ \ ordering read and write" operationId: get-merchants-merchantId-terminalModels - x-groupName: Terminal orders - merchant level x-sortIndex: 1 x-methodName: listTerminalModels security: @@ -7406,7 +7279,6 @@ paths: * Management API\u2014Terminal ordering read\n* Management API\u2014Terminal\ \ ordering read and write" operationId: get-merchants-merchantId-terminalOrders - x-groupName: Terminal orders - merchant level x-sortIndex: 7 x-methodName: listOrders security: @@ -7500,7 +7372,6 @@ paths: \ test terminals, you need to [submit a sales order](https://docs.adyen.com/point-of-sale/managing-terminals/order-terminals/#sales-order-steps)\ \ in your Customer Area." operationId: post-merchants-merchantId-terminalOrders - x-groupName: Terminal orders - merchant level x-sortIndex: 6 x-methodName: createOrder security: @@ -7575,7 +7446,6 @@ paths: * Management API\u2014Terminal ordering read\n* Management API\u2014Terminal\ \ ordering read and write" operationId: get-merchants-merchantId-terminalOrders-orderId - x-groupName: Terminal orders - merchant level x-sortIndex: 8 x-methodName: getOrder security: @@ -7651,7 +7521,6 @@ paths: \ have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal ordering read and write" operationId: patch-merchants-merchantId-terminalOrders-orderId - x-groupName: Terminal orders - merchant level x-sortIndex: 9 x-methodName: updateOrder security: @@ -7733,7 +7602,6 @@ paths: To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal ordering read and write" operationId: post-merchants-merchantId-terminalOrders-orderId-cancel - x-groupName: Terminal orders - merchant level x-sortIndex: 10 x-methodName: cancelOrder security: @@ -7806,7 +7674,6 @@ paths: * Management API\u2014Terminal ordering read\n* Management API\u2014Terminal\ \ ordering read and write" operationId: get-merchants-merchantId-terminalProducts - x-groupName: Terminal orders - merchant level x-sortIndex: 2 x-methodName: listTerminalProducts security: @@ -7904,7 +7771,6 @@ paths: * Management API\u2014Terminal settings read\n* Management API\u2014Terminal\ \ settings read and write" operationId: get-merchants-merchantId-terminalSettings - x-groupName: Terminal settings - merchant level x-sortIndex: 1 x-methodName: getTerminalSettings security: @@ -7976,7 +7842,6 @@ paths: \ must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal settings read and write" operationId: patch-merchants-merchantId-terminalSettings - x-groupName: Terminal settings - merchant level x-sortIndex: 3 x-methodName: updateTerminalSettings security: @@ -8054,7 +7919,6 @@ paths: \ following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Users read and write\n" operationId: get-merchants-merchantId-users - x-groupName: Users - merchant level x-sortIndex: 0 x-methodName: listUsers security: @@ -8136,7 +8000,6 @@ paths: To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Users read and write\n" operationId: post-merchants-merchantId-users - x-groupName: Users - merchant level x-sortIndex: 0 x-methodName: createNewUser security: @@ -8210,7 +8073,6 @@ paths: \ following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Users read and write\n" operationId: get-merchants-merchantId-users-userId - x-groupName: Users - merchant level x-sortIndex: 0 x-methodName: getUserDetails security: @@ -8278,7 +8140,6 @@ paths: \ following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Users read and write\n" operationId: patch-merchants-merchantId-users-userId - x-groupName: Users - merchant level x-sortIndex: 0 x-methodName: updateUser security: @@ -8352,7 +8213,6 @@ paths: * Management API\u2014Webhooks read\n* Management API\u2014Webhooks read and\ \ write" operationId: get-merchants-merchantId-webhooks - x-groupName: Webhooks - merchant level x-sortIndex: 2 x-methodName: listAllWebhooks security: @@ -8433,7 +8293,6 @@ paths: \ the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Webhooks read and write" operationId: post-merchants-merchantId-webhooks - x-groupName: Webhooks - merchant level x-sortIndex: 1 x-methodName: setUpWebhook security: @@ -8506,7 +8365,6 @@ paths: \nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Webhooks read and write" operationId: delete-merchants-merchantId-webhooks-webhookId - x-groupName: Webhooks - merchant level x-sortIndex: 5 x-methodName: removeWebhook security: @@ -8569,7 +8427,6 @@ paths: * Management API\u2014Webhooks read\n* Management API\u2014Webhooks read and\ \ write" operationId: get-merchants-merchantId-webhooks-webhookId - x-groupName: Webhooks - merchant level x-sortIndex: 3 x-methodName: getWebhook security: @@ -8642,7 +8499,6 @@ paths: \ your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Webhooks read and write" operationId: patch-merchants-merchantId-webhooks-webhookId - x-groupName: Webhooks - merchant level x-sortIndex: 4 x-methodName: updateWebhook security: @@ -8725,7 +8581,6 @@ paths: \nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Webhooks read and write" operationId: post-merchants-merchantId-webhooks-webhookId-generateHmac - x-groupName: Webhooks - merchant level x-sortIndex: 6 x-methodName: generateHmacKey security: @@ -8802,7 +8657,6 @@ paths: \ [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Webhooks read and write" operationId: post-merchants-merchantId-webhooks-webhookId-test - x-groupName: Webhooks - merchant level x-sortIndex: 7 x-methodName: testWebhook security: @@ -8882,7 +8736,6 @@ paths: \ have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Stores read\n* Management API\u2014Stores read and write" operationId: get-stores - x-groupName: Account - store level x-sortIndex: 4 x-methodName: listStores security: @@ -8964,7 +8817,6 @@ paths: \nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Stores read and write" operationId: post-stores - x-groupName: Account - store level x-sortIndex: 5 x-methodName: createStore security: @@ -9027,7 +8879,6 @@ paths: \ make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Stores read\n* Management API\u2014Stores read and write" operationId: get-stores-storeId - x-groupName: Account - store level x-sortIndex: 6 x-methodName: getStoreById security: @@ -9089,7 +8940,6 @@ paths: \ have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Stores read and write" operationId: patch-stores-storeId - x-groupName: Account - store level x-sortIndex: 7 x-methodName: updateStoreById security: @@ -9166,7 +9016,6 @@ paths: * Management API\u2014Terminal settings read\n* Management API\u2014Terminal\ \ settings read and write" operationId: get-stores-storeId-terminalLogos - x-groupName: Terminal settings - store level x-sortIndex: 2 x-methodName: getTerminalLogoByStoreId security: @@ -9241,7 +9090,6 @@ paths: \ make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal settings read and write" operationId: patch-stores-storeId-terminalLogos - x-groupName: Terminal settings - store level x-sortIndex: 4 x-methodName: updateTerminalLogoByStoreId security: @@ -9329,7 +9177,6 @@ paths: \ your API credential must have the following role:\n* Management API\u2014\ Terminal settings Advanced read and write" operationId: get-stores-storeId-terminalSettings - x-groupName: Terminal settings - store level x-sortIndex: 1 x-methodName: getTerminalSettingsByStoreId security: @@ -9401,7 +9248,6 @@ paths: \ your API credential must have the following role:\n* Management API\u2014\ Terminal settings Advanced read and write" operationId: patch-stores-storeId-terminalSettings - x-groupName: Terminal settings - store level x-sortIndex: 3 x-methodName: updateTerminalSettingsByStoreId security: @@ -9476,7 +9322,6 @@ paths: \ credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API \u2014 Terminal actions read" operationId: get-terminals - x-groupName: Terminals - terminal level x-sortIndex: 1 x-methodName: listTerminals security: @@ -9598,7 +9443,6 @@ paths: To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal actions read and write" operationId: post-terminals-scheduleActions - x-groupName: Terminal actions - terminal level x-sortIndex: 1 x-methodName: createTerminalAction security: @@ -9673,7 +9517,6 @@ paths: * Management API\u2014Terminal settings read\n* Management API\u2014Terminal\ \ settings read and write" operationId: get-terminals-terminalId-terminalLogos - x-groupName: Terminal settings - terminal level x-sortIndex: 4 x-methodName: getTerminalLogo security: @@ -9737,7 +9580,6 @@ paths: \ your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal settings read and write" operationId: patch-terminals-terminalId-terminalLogos - x-groupName: Terminal settings - terminal level x-sortIndex: 6 x-methodName: updateLogo security: @@ -9815,7 +9657,6 @@ paths: \ your API credential must have the following role:\n* Management API\u2014\ Terminal settings Advanced read and write" operationId: get-terminals-terminalId-terminalSettings - x-groupName: Terminal settings - terminal level x-sortIndex: 3 x-methodName: getTerminalSettings security: @@ -9885,7 +9726,6 @@ paths: \ your API credential must have the following role:\n* Management API\u2014\ Terminal settings Advanced read and write" operationId: patch-terminals-terminalId-terminalSettings - x-groupName: Terminal settings - terminal level x-sortIndex: 5 x-methodName: updateTerminalSettings security: @@ -13715,6 +13555,13 @@ components: required: - swishNumber type: object + TapToPay: + properties: + merchantDisplayName: + description: Platform merchants can customize the text that appears on the + TapToPay screen during a transaction + type: string + type: object Terminal: properties: assigned: @@ -14000,6 +13847,9 @@ components: description: Settings for payment [surcharge](https://docs.adyen.com/point-of-sale/surcharge) features. $ref: '#/components/schemas/Surcharge' + tapToPay: + description: Settings for apple tap to pay. + $ref: '#/components/schemas/TapToPay' timeouts: description: Settings for device [time-outs](https://docs.adyen.com/point-of-sale/pos-timeouts#device-time-out). $ref: '#/components/schemas/Timeouts' diff --git a/yaml/ManagementService-v3.yaml b/yaml/ManagementService-v3.yaml index 3706bed..8cdf81a 100644 --- a/yaml/ManagementService-v3.yaml +++ b/yaml/ManagementService-v3.yaml @@ -55,36 +55,6 @@ info: contact: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi -x-groups: -- Account - company level -- Account - merchant level -- Account - store level -- Payout settings - merchant level -- Users - company level -- Users - merchant level -- My API credential -- API credentials - company level -- API credentials - merchant level -- API key - company level -- API key - merchant level -- Client key - company level -- Client key - merchant level -- Allowed origins - company level -- Allowed origins - merchant level -- Webhooks - company level -- Webhooks - merchant level -- Payment methods - merchant level -- Terminals - terminal level -- Terminal actions - company level -- Terminal actions - terminal level -- Terminal orders - company level -- Terminal orders - merchant level -- Terminal settings - company level -- Terminal settings - merchant level -- Terminal settings - store level -- Terminal settings - terminal level -- Android files - company level -- Split configuration - merchant level tags: - name: Account - company level - name: Account - merchant level @@ -126,7 +96,6 @@ paths: \nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ \n* Management API\u2014Account read" operationId: get-companies - x-groupName: Account - company level x-sortIndex: 0 x-methodName: listCompanyAccounts security: @@ -198,7 +167,6 @@ paths: \ API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Account read" operationId: get-companies-companyId - x-groupName: Account - company level x-sortIndex: 0 x-methodName: getCompanyAccount security: @@ -266,7 +234,6 @@ paths: \ read and write\n* Management API\u2014Terminal actions read\n* Management\ \ API\u2014Terminal actions read and write" operationId: get-companies-companyId-androidApps - x-groupName: Android files - company level x-sortIndex: 1 x-methodName: listAndroidApps security: @@ -360,7 +327,6 @@ paths: \ installing, or running any such applications." x-addedInVersion: '3' operationId: post-companies-companyId-androidApps - x-groupName: Android files - company level x-sortIndex: 4 x-methodName: uploadAndroidApp security: @@ -417,7 +383,6 @@ paths: * Management API\u2014Android files read\n* Management API\u2014Android files\ \ read and write" operationId: get-companies-companyId-androidApps-id - x-groupName: Android files - company level x-sortIndex: 3 x-methodName: getAndroidApp security: @@ -489,7 +454,6 @@ paths: \ read and write\n* Management API\u2014Terminal actions read\n* Management\ \ API\u2014Terminal actions read and write" operationId: get-companies-companyId-androidCertificates - x-groupName: Android files - company level x-sortIndex: 2 x-methodName: listAndroidCertificates security: @@ -574,7 +538,6 @@ paths: \ the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: get-companies-companyId-apiCredentials - x-groupName: API credentials - company level x-sortIndex: 0 x-methodName: listApiCredentials security: @@ -659,7 +622,6 @@ paths: \nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: post-companies-companyId-apiCredentials - x-groupName: API credentials - company level x-sortIndex: 0 x-methodName: createApiCredential security: @@ -730,7 +692,6 @@ paths: \ have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: get-companies-companyId-apiCredentials-apiCredentialId - x-groupName: API credentials - company level x-sortIndex: 0 x-methodName: getApiCredential security: @@ -800,7 +761,6 @@ paths: \ must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: patch-companies-companyId-apiCredentials-apiCredentialId - x-groupName: API credentials - company level x-sortIndex: 0 x-methodName: updateApiCredential security: @@ -877,7 +837,6 @@ paths: \ your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: get-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins - x-groupName: Allowed origins - company level x-sortIndex: 0 x-methodName: listAllowedOrigins security: @@ -945,7 +904,6 @@ paths: \ your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: post-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins - x-groupName: Allowed origins - company level x-sortIndex: 0 x-methodName: createAllowedOrigin security: @@ -1023,7 +981,6 @@ paths: \ API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: delete-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-originId - x-groupName: Allowed origins - company level x-sortIndex: 0 x-methodName: deleteAllowedOrigin security: @@ -1091,7 +1048,6 @@ paths: \ have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: get-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-originId - x-groupName: Allowed origins - company level x-sortIndex: 0 x-methodName: getAllowedOrigin security: @@ -1167,7 +1123,6 @@ paths: \ must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: post-companies-companyId-apiCredentials-apiCredentialId-generateApiKey - x-groupName: API key - company level x-sortIndex: 0 x-methodName: generateNewApiKey security: @@ -1235,7 +1190,6 @@ paths: \ must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: post-companies-companyId-apiCredentials-apiCredentialId-generateClientKey - x-groupName: Client key - company level x-sortIndex: 0 x-methodName: generateNewClientKey security: @@ -1304,7 +1258,6 @@ paths: * Management API\u2014Terminal ordering read\n* Management API\u2014Terminal\ \ ordering read and write" operationId: get-companies-companyId-billingEntities - x-groupName: Terminal orders - company level x-sortIndex: 3 x-methodName: listBillingEntities security: @@ -1375,7 +1328,6 @@ paths: \ have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Account read" operationId: get-companies-companyId-merchants - x-groupName: Account - company level x-sortIndex: 0 x-methodName: listMerchantAccounts security: @@ -1456,7 +1408,6 @@ paths: * Management API\u2014Terminal ordering read\n* Management API\u2014Terminal\ \ ordering read and write" operationId: get-companies-companyId-shippingLocations - x-groupName: Terminal orders - company level x-sortIndex: 4 x-methodName: listShippingLocations security: @@ -1538,7 +1489,6 @@ paths: \nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal ordering read and write" operationId: post-companies-companyId-shippingLocations - x-groupName: Terminal orders - company level x-sortIndex: 5 x-methodName: createShippingLocation security: @@ -1611,7 +1561,6 @@ paths: * Management API\u2014Terminal actions read\n* Management API\u2014Terminal\ \ actions read and write" operationId: get-companies-companyId-terminalActions - x-groupName: Terminal actions - company level x-sortIndex: 1 x-methodName: listTerminalActions security: @@ -1705,7 +1654,6 @@ paths: * Management API\u2014Terminal actions read\n* Management API\u2014Terminal\ \ actions read and write" operationId: get-companies-companyId-terminalActions-actionId - x-groupName: Terminal actions - company level x-sortIndex: 2 x-methodName: getTerminalAction security: @@ -1779,7 +1727,6 @@ paths: * Management API\u2014Terminal settings read\n* Management API\u2014Terminal\ \ settings read and write" operationId: get-companies-companyId-terminalLogos - x-groupName: Terminal settings - company level x-sortIndex: 2 x-methodName: getTerminalLogo security: @@ -1855,7 +1802,6 @@ paths: \ [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal settings read and write" operationId: patch-companies-companyId-terminalLogos - x-groupName: Terminal settings - company level x-sortIndex: 4 x-methodName: updateTerminalLogo security: @@ -1941,7 +1887,6 @@ paths: * Management API\u2014Terminal ordering read\n* Management API\u2014Terminal\ \ ordering read and write" operationId: get-companies-companyId-terminalModels - x-groupName: Terminal orders - company level x-sortIndex: 1 x-methodName: listTerminalModels security: @@ -2006,7 +1951,6 @@ paths: * Management API\u2014Terminal ordering read\n* Management API\u2014Terminal\ \ ordering read and write" operationId: get-companies-companyId-terminalOrders - x-groupName: Terminal orders - company level x-sortIndex: 7 x-methodName: listOrders security: @@ -2098,7 +2042,6 @@ paths: \ test terminals, you need to [submit a sales order](https://docs.adyen.com/point-of-sale/managing-terminals/order-terminals/#sales-order-steps)\ \ in your Customer Area." operationId: post-companies-companyId-terminalOrders - x-groupName: Terminal orders - company level x-sortIndex: 6 x-methodName: createOrder security: @@ -2170,7 +2113,6 @@ paths: * Management API\u2014Terminal ordering read\n* Management API\u2014Terminal\ \ ordering read and write" operationId: get-companies-companyId-terminalOrders-orderId - x-groupName: Terminal orders - company level x-sortIndex: 8 x-methodName: getOrder security: @@ -2243,7 +2185,6 @@ paths: \ have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal ordering read and write" operationId: patch-companies-companyId-terminalOrders-orderId - x-groupName: Terminal orders - company level x-sortIndex: 9 x-methodName: updateOrder security: @@ -2322,7 +2263,6 @@ paths: To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal ordering read and write" operationId: post-companies-companyId-terminalOrders-orderId-cancel - x-groupName: Terminal orders - company level x-sortIndex: 10 x-methodName: cancelOrder security: @@ -2392,7 +2332,6 @@ paths: * Management API\u2014Terminal ordering read\n* Management API\u2014Terminal\ \ ordering read and write" operationId: get-companies-companyId-terminalProducts - x-groupName: Terminal orders - company level x-sortIndex: 2 x-methodName: listTerminalProducts security: @@ -2489,7 +2428,6 @@ paths: \ your API credential must have the following role:\n* Management API\u2014\ Terminal settings Advanced read and write" operationId: get-companies-companyId-terminalSettings - x-groupName: Terminal settings - company level x-sortIndex: 1 x-methodName: getTerminalSettings security: @@ -2561,7 +2499,6 @@ paths: \ your API credential must have the following role:\n* Management API\u2014\ Terminal settings Advanced read and write" operationId: patch-companies-companyId-terminalSettings - x-groupName: Terminal settings - company level x-sortIndex: 3 x-methodName: updateTerminalSettings security: @@ -2636,7 +2573,6 @@ paths: \ [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Users read and write\n" operationId: get-companies-companyId-users - x-groupName: Users - company level x-sortIndex: 0 x-methodName: listUsers security: @@ -2715,7 +2651,6 @@ paths: \nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Users read and write\n" operationId: post-companies-companyId-users - x-groupName: Users - company level x-sortIndex: 0 x-methodName: createNewUser security: @@ -2786,7 +2721,6 @@ paths: \ following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Users read and write\n" operationId: get-companies-companyId-users-userId - x-groupName: Users - company level x-sortIndex: 0 x-methodName: getUserDetails security: @@ -2851,7 +2785,6 @@ paths: \ following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Users read and write\n" operationId: patch-companies-companyId-users-userId - x-groupName: Users - company level x-sortIndex: 0 x-methodName: updateUserDetails security: @@ -2922,7 +2855,6 @@ paths: * Management API\u2014Webhooks read\n* Management API\u2014Webhooks read and\ \ write" operationId: get-companies-companyId-webhooks - x-groupName: Webhooks - company level x-sortIndex: 2 x-methodName: listAllWebhooks security: @@ -3000,7 +2932,6 @@ paths: \ following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Webhooks read and write" operationId: post-companies-companyId-webhooks - x-groupName: Webhooks - company level x-sortIndex: 1 x-methodName: setUpWebhook security: @@ -3070,7 +3001,6 @@ paths: \nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Webhooks read and write" operationId: delete-companies-companyId-webhooks-webhookId - x-groupName: Webhooks - company level x-sortIndex: 5 x-methodName: removeWebhook security: @@ -3133,7 +3063,6 @@ paths: * Management API\u2014Webhooks read\n* Management API\u2014Webhooks read and\ \ write" operationId: get-companies-companyId-webhooks-webhookId - x-groupName: Webhooks - company level x-sortIndex: 3 x-methodName: getWebhook security: @@ -3203,7 +3132,6 @@ paths: \ your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Webhooks read and write" operationId: patch-companies-companyId-webhooks-webhookId - x-groupName: Webhooks - company level x-sortIndex: 4 x-methodName: updateWebhook security: @@ -3283,7 +3211,6 @@ paths: \nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Webhooks read and write" operationId: post-companies-companyId-webhooks-webhookId-generateHmac - x-groupName: Webhooks - company level x-sortIndex: 6 x-methodName: generateHmacKey security: @@ -3362,7 +3289,6 @@ paths: \ [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Webhooks read and write" operationId: post-companies-companyId-webhooks-webhookId-test - x-groupName: Webhooks - company level x-sortIndex: 7 x-methodName: testWebhook security: @@ -3440,7 +3366,6 @@ paths: You can make this request with any of the Management API roles.' operationId: get-me - x-groupName: My API credential x-sortIndex: 0 x-methodName: getApiCredentialDetails security: @@ -3495,7 +3420,6 @@ paths: You can make this request with any of the Management API roles.' operationId: get-me-allowedOrigins - x-groupName: My API credential x-sortIndex: 0 x-methodName: getAllowedOrigins security: @@ -3550,7 +3474,6 @@ paths: You can make this request with any of the Management API roles.' operationId: post-me-allowedOrigins - x-groupName: My API credential x-sortIndex: 0 x-methodName: addAllowedOrigin security: @@ -3611,7 +3534,6 @@ paths: You can make this request with any of the Management API roles.' operationId: delete-me-allowedOrigins-originId - x-groupName: My API credential x-sortIndex: 0 x-methodName: removeAllowedOrigin security: @@ -3670,7 +3592,6 @@ paths: You can make this request with any of the Management API roles.' operationId: get-me-allowedOrigins-originId - x-groupName: My API credential x-sortIndex: 0 x-methodName: getAllowedOriginDetails security: @@ -3732,7 +3653,6 @@ paths: \ your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: post-me-generateClientKey - x-groupName: My API credential x-sortIndex: 0 x-methodName: generateClientKey security: @@ -3785,7 +3705,6 @@ paths: \ \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Account read" operationId: get-merchants - x-groupName: Account - merchant level x-sortIndex: 4 x-methodName: listMerchantAccounts security: @@ -3860,7 +3779,6 @@ paths: \nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Accounts read and write" operationId: post-merchants - x-groupName: Account - merchant level x-sortIndex: 1 x-methodName: createMerchantAccount security: @@ -3927,7 +3845,6 @@ paths: \ API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Account read" operationId: get-merchants-merchantId - x-groupName: Account - merchant level x-sortIndex: 3 x-methodName: getMerchantAccount security: @@ -3998,7 +3915,6 @@ paths: \ the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Accounts read and write" operationId: post-merchants-merchantId-activate - x-groupName: Account - merchant level x-sortIndex: 2 x-methodName: requestToActivateMerchantAccount security: @@ -4062,7 +3978,6 @@ paths: \ the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: get-merchants-merchantId-apiCredentials - x-groupName: API credentials - merchant level x-sortIndex: 0 x-methodName: listApiCredentials security: @@ -4149,7 +4064,6 @@ paths: \nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: post-merchants-merchantId-apiCredentials - x-groupName: API credentials - merchant level x-sortIndex: 0 x-methodName: createApiCredential security: @@ -4223,7 +4137,6 @@ paths: \ have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: get-merchants-merchantId-apiCredentials-apiCredentialId - x-groupName: API credentials - merchant level x-sortIndex: 0 x-methodName: getApiCredential security: @@ -4295,7 +4208,6 @@ paths: \ \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: patch-merchants-merchantId-apiCredentials-apiCredentialId - x-groupName: API credentials - merchant level x-sortIndex: 0 x-methodName: updateApiCredential security: @@ -4375,7 +4287,6 @@ paths: \ your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: get-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins - x-groupName: Allowed origins - merchant level x-sortIndex: 0 x-methodName: listAllowedOrigins security: @@ -4446,7 +4357,6 @@ paths: \ your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: post-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins - x-groupName: Allowed origins - merchant level x-sortIndex: 0 x-methodName: createAllowedOrigin security: @@ -4527,7 +4437,6 @@ paths: \ API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: delete-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-originId - x-groupName: Allowed origins - merchant level x-sortIndex: 0 x-methodName: deleteAllowedOrigin security: @@ -4595,7 +4504,6 @@ paths: \ have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: get-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-originId - x-groupName: Allowed origins - merchant level x-sortIndex: 0 x-methodName: getAllowedOrigin security: @@ -4674,7 +4582,6 @@ paths: \ must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: post-merchants-merchantId-apiCredentials-apiCredentialId-generateApiKey - x-groupName: API key - merchant level x-sortIndex: 0 x-methodName: generateNewApiKey security: @@ -4745,7 +4652,6 @@ paths: \ must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014API credentials read and write" operationId: post-merchants-merchantId-apiCredentials-apiCredentialId-generateClientKey - x-groupName: Client key - merchant level x-sortIndex: 0 x-methodName: generateNewClientKey security: @@ -4817,7 +4723,6 @@ paths: * Management API\u2014Terminal ordering read\n* Management API\u2014Terminal\ \ ordering read and write" operationId: get-merchants-merchantId-billingEntities - x-groupName: Terminal orders - merchant level x-sortIndex: 3 x-methodName: listBillingEntities security: @@ -4889,7 +4794,6 @@ paths: \ have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Payment methods read\n" operationId: get-merchants-merchantId-paymentMethodSettings - x-groupName: Payment methods - merchant level x-sortIndex: 2 x-methodName: getAllPaymentMethods security: @@ -4980,7 +4884,6 @@ paths: \ have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Payment methods read and write\n" operationId: post-merchants-merchantId-paymentMethodSettings - x-groupName: Payment methods - merchant level x-sortIndex: 1 x-methodName: requestPaymentMethod security: @@ -5058,7 +4961,6 @@ paths: \ have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Payment methods read\n" operationId: get-merchants-merchantId-paymentMethodSettings-paymentMethodId - x-groupName: Payment methods - merchant level x-sortIndex: 3 x-methodName: getPaymentMethodDetails security: @@ -5126,7 +5028,6 @@ paths: \ credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Payment methods read and write\n" operationId: patch-merchants-merchantId-paymentMethodSettings-paymentMethodId - x-groupName: Payment methods - merchant level x-sortIndex: 4 x-methodName: updatePaymentMethod security: @@ -5201,7 +5102,6 @@ paths: \nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Payment methods read and write\n" operationId: post-merchants-merchantId-paymentMethodSettings-paymentMethodId-addApplePayDomains - x-groupName: Payment methods - merchant level x-sortIndex: 5 x-methodName: addApplePayDomain security: @@ -5273,7 +5173,6 @@ paths: \nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Payment methods read\n" operationId: get-merchants-merchantId-paymentMethodSettings-paymentMethodId-getApplePayDomains - x-groupName: Payment methods - merchant level x-sortIndex: 6 x-methodName: getApplePayDomains security: @@ -5343,7 +5242,6 @@ paths: \nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Payout account settings read" operationId: get-merchants-merchantId-payoutSettings - x-groupName: Payout settings - merchant level x-sortIndex: 3 x-methodName: listPayoutSettings security: @@ -5412,7 +5310,6 @@ paths: \ [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ \n* Management API\u2014Payout account settings read and write" operationId: post-merchants-merchantId-payoutSettings - x-groupName: Payout settings - merchant level x-sortIndex: 1 x-methodName: addPayoutSetting security: @@ -5481,7 +5378,6 @@ paths: \ API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ \n* Management API\u2014Payout account settings read and write" operationId: delete-merchants-merchantId-payoutSettings-payoutSettingsId - x-groupName: Payout settings - merchant level x-sortIndex: 5 x-methodName: deletePayoutSetting security: @@ -5544,7 +5440,6 @@ paths: \ API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Payout account settings read" operationId: get-merchants-merchantId-payoutSettings-payoutSettingsId - x-groupName: Payout settings - merchant level x-sortIndex: 4 x-methodName: getPayoutSetting security: @@ -5614,7 +5509,6 @@ paths: \ the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ \n* Management API\u2014Payout account settings read and write" operationId: patch-merchants-merchantId-payoutSettings-payoutSettingsId - x-groupName: Payout settings - merchant level x-sortIndex: 2 x-methodName: updatePayoutSetting security: @@ -5691,7 +5585,6 @@ paths: * Management API\u2014Terminal ordering read\n* Management API\u2014Terminal\ \ ordering read and write" operationId: get-merchants-merchantId-shippingLocations - x-groupName: Terminal orders - merchant level x-sortIndex: 4 x-methodName: listShippingLocations security: @@ -5777,7 +5670,6 @@ paths: \ following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal ordering read and write" operationId: post-merchants-merchantId-shippingLocations - x-groupName: Terminal orders - merchant level x-sortIndex: 5 x-methodName: createShippingLocation security: @@ -5853,7 +5745,6 @@ paths: * Management API - SplitConfiguration read and write' operationId: get-merchants-merchantId-splitConfigurations - x-groupName: Split configuration - merchant level x-sortIndex: 3 x-methodName: listSplitConfigurations security: @@ -5921,7 +5812,6 @@ paths: * Management API - SplitConfiguration read and write' operationId: post-merchants-merchantId-splitConfigurations - x-groupName: Split configuration - merchant level x-sortIndex: 1 x-methodName: createSplitConfiguration security: @@ -5997,7 +5887,6 @@ paths: * Management API - SplitConfiguration read and write' operationId: delete-merchants-merchantId-splitConfigurations-splitConfigurationId - x-groupName: Split configuration - merchant level x-sortIndex: 8 x-methodName: deleteSplitConfiguration security: @@ -6067,7 +5956,6 @@ paths: * Management API - SplitConfiguration read and write' operationId: get-merchants-merchantId-splitConfigurations-splitConfigurationId - x-groupName: Split configuration - merchant level x-sortIndex: 4 x-methodName: getSplitConfiguration security: @@ -6141,7 +6029,6 @@ paths: * Management API - SplitConfiguration read and write' operationId: patch-merchants-merchantId-splitConfigurations-splitConfigurationId - x-groupName: Split configuration - merchant level x-sortIndex: 5 x-methodName: updateSplitConfigurationDescription security: @@ -6222,7 +6109,6 @@ paths: * Management API - SplitConfiguration read and write' operationId: post-merchants-merchantId-splitConfigurations-splitConfigurationId - x-groupName: Split configuration - merchant level x-sortIndex: 2 x-methodName: createRule security: @@ -6304,7 +6190,6 @@ paths: * Management API - SplitConfiguration read and write' operationId: delete-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId - x-groupName: Split configuration - merchant level x-sortIndex: 9 x-methodName: deleteSplitConfigurationRule security: @@ -6380,7 +6265,6 @@ paths: * Management API - SplitConfiguration read and write' operationId: patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId - x-groupName: Split configuration - merchant level x-sortIndex: 6 x-methodName: updateSplitConditions security: @@ -6468,7 +6352,6 @@ paths: * Management API - SplitConfiguration read and write' operationId: patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId-splitLogic-splitLogicId - x-groupName: Split configuration - merchant level x-sortIndex: 7 x-methodName: updateSplitLogic security: @@ -6561,7 +6444,6 @@ paths: \ [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Stores read\n* Management API\u2014Stores read and write" operationId: get-merchants-merchantId-stores - x-groupName: Account - store level x-sortIndex: 1 x-methodName: listStoresByMerchantId security: @@ -6646,7 +6528,6 @@ paths: \nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Stores read and write" operationId: post-merchants-merchantId-stores - x-groupName: Account - store level x-sortIndex: 0 x-methodName: createStoreByMerchantId security: @@ -6724,7 +6605,6 @@ paths: * Management API\u2014Terminal settings read\n* Management API\u2014Terminal\ \ settings read and write" operationId: get-merchants-merchantId-stores-reference-terminalLogos - x-groupName: Terminal settings - store level x-sortIndex: 2 x-methodName: getTerminalLogo security: @@ -6808,7 +6688,6 @@ paths: \ make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal settings read and write" operationId: patch-merchants-merchantId-stores-reference-terminalLogos - x-groupName: Terminal settings - store level x-sortIndex: 4 x-methodName: updateTerminalLogo security: @@ -6905,7 +6784,6 @@ paths: \ your API credential must have the following role:\n* Management API\u2014\ Terminal settings Advanced read and write" operationId: get-merchants-merchantId-stores-reference-terminalSettings - x-groupName: Terminal settings - store level x-sortIndex: 1 x-methodName: getTerminalSettings security: @@ -6986,7 +6864,6 @@ paths: \ your API credential must have the following role:\n* Management API\u2014\ Terminal settings Advanced read and write" operationId: patch-merchants-merchantId-stores-reference-terminalSettings - x-groupName: Terminal settings - store level x-sortIndex: 3 x-methodName: updateTerminalSettings security: @@ -7069,7 +6946,6 @@ paths: \ make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Stores read\n* Management API\u2014Stores read and write" operationId: get-merchants-merchantId-stores-storeId - x-groupName: Account - store level x-sortIndex: 2 x-methodName: getStore security: @@ -7140,7 +7016,6 @@ paths: \ have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Stores read and write" operationId: patch-merchants-merchantId-stores-storeId - x-groupName: Account - store level x-sortIndex: 3 x-methodName: updateStore security: @@ -7229,7 +7104,6 @@ paths: * Management API\u2014Terminal settings read\n* Management API\u2014Terminal\ \ settings read and write" operationId: get-merchants-merchantId-terminalLogos - x-groupName: Terminal settings - merchant level x-sortIndex: 2 x-methodName: getTerminalLogo security: @@ -7307,7 +7181,6 @@ paths: \ this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal settings read and write" operationId: patch-merchants-merchantId-terminalLogos - x-groupName: Terminal settings - merchant level x-sortIndex: 4 x-methodName: updateTerminalLogo security: @@ -7396,7 +7269,6 @@ paths: * Management API\u2014Terminal ordering read\n* Management API\u2014Terminal\ \ ordering read and write" operationId: get-merchants-merchantId-terminalModels - x-groupName: Terminal orders - merchant level x-sortIndex: 1 x-methodName: listTerminalModels security: @@ -7463,7 +7335,6 @@ paths: * Management API\u2014Terminal ordering read\n* Management API\u2014Terminal\ \ ordering read and write" operationId: get-merchants-merchantId-terminalOrders - x-groupName: Terminal orders - merchant level x-sortIndex: 7 x-methodName: listOrders security: @@ -7557,7 +7428,6 @@ paths: \ test terminals, you need to [submit a sales order](https://docs.adyen.com/point-of-sale/managing-terminals/order-terminals/#sales-order-steps)\ \ in your Customer Area." operationId: post-merchants-merchantId-terminalOrders - x-groupName: Terminal orders - merchant level x-sortIndex: 6 x-methodName: createOrder security: @@ -7632,7 +7502,6 @@ paths: * Management API\u2014Terminal ordering read\n* Management API\u2014Terminal\ \ ordering read and write" operationId: get-merchants-merchantId-terminalOrders-orderId - x-groupName: Terminal orders - merchant level x-sortIndex: 8 x-methodName: getOrder security: @@ -7708,7 +7577,6 @@ paths: \ have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal ordering read and write" operationId: patch-merchants-merchantId-terminalOrders-orderId - x-groupName: Terminal orders - merchant level x-sortIndex: 9 x-methodName: updateOrder security: @@ -7790,7 +7658,6 @@ paths: To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal ordering read and write" operationId: post-merchants-merchantId-terminalOrders-orderId-cancel - x-groupName: Terminal orders - merchant level x-sortIndex: 10 x-methodName: cancelOrder security: @@ -7863,7 +7730,6 @@ paths: * Management API\u2014Terminal ordering read\n* Management API\u2014Terminal\ \ ordering read and write" operationId: get-merchants-merchantId-terminalProducts - x-groupName: Terminal orders - merchant level x-sortIndex: 2 x-methodName: listTerminalProducts security: @@ -7961,7 +7827,6 @@ paths: * Management API\u2014Terminal settings read\n* Management API\u2014Terminal\ \ settings read and write" operationId: get-merchants-merchantId-terminalSettings - x-groupName: Terminal settings - merchant level x-sortIndex: 1 x-methodName: getTerminalSettings security: @@ -8033,7 +7898,6 @@ paths: \ must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal settings read and write" operationId: patch-merchants-merchantId-terminalSettings - x-groupName: Terminal settings - merchant level x-sortIndex: 3 x-methodName: updateTerminalSettings security: @@ -8111,7 +7975,6 @@ paths: \ following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Users read and write\n" operationId: get-merchants-merchantId-users - x-groupName: Users - merchant level x-sortIndex: 0 x-methodName: listUsers security: @@ -8193,7 +8056,6 @@ paths: To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Users read and write\n" operationId: post-merchants-merchantId-users - x-groupName: Users - merchant level x-sortIndex: 0 x-methodName: createNewUser security: @@ -8267,7 +8129,6 @@ paths: \ following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Users read and write\n" operationId: get-merchants-merchantId-users-userId - x-groupName: Users - merchant level x-sortIndex: 0 x-methodName: getUserDetails security: @@ -8335,7 +8196,6 @@ paths: \ following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Users read and write\n" operationId: patch-merchants-merchantId-users-userId - x-groupName: Users - merchant level x-sortIndex: 0 x-methodName: updateUser security: @@ -8409,7 +8269,6 @@ paths: * Management API\u2014Webhooks read\n* Management API\u2014Webhooks read and\ \ write" operationId: get-merchants-merchantId-webhooks - x-groupName: Webhooks - merchant level x-sortIndex: 2 x-methodName: listAllWebhooks security: @@ -8490,7 +8349,6 @@ paths: \ the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Webhooks read and write" operationId: post-merchants-merchantId-webhooks - x-groupName: Webhooks - merchant level x-sortIndex: 1 x-methodName: setUpWebhook security: @@ -8563,7 +8421,6 @@ paths: \nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Webhooks read and write" operationId: delete-merchants-merchantId-webhooks-webhookId - x-groupName: Webhooks - merchant level x-sortIndex: 5 x-methodName: removeWebhook security: @@ -8626,7 +8483,6 @@ paths: * Management API\u2014Webhooks read\n* Management API\u2014Webhooks read and\ \ write" operationId: get-merchants-merchantId-webhooks-webhookId - x-groupName: Webhooks - merchant level x-sortIndex: 3 x-methodName: getWebhook security: @@ -8699,7 +8555,6 @@ paths: \ your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Webhooks read and write" operationId: patch-merchants-merchantId-webhooks-webhookId - x-groupName: Webhooks - merchant level x-sortIndex: 4 x-methodName: updateWebhook security: @@ -8782,7 +8637,6 @@ paths: \nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Webhooks read and write" operationId: post-merchants-merchantId-webhooks-webhookId-generateHmac - x-groupName: Webhooks - merchant level x-sortIndex: 6 x-methodName: generateHmacKey security: @@ -8859,7 +8713,6 @@ paths: \ [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Webhooks read and write" operationId: post-merchants-merchantId-webhooks-webhookId-test - x-groupName: Webhooks - merchant level x-sortIndex: 7 x-methodName: testWebhook security: @@ -8939,7 +8792,6 @@ paths: \ have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Stores read\n* Management API\u2014Stores read and write" operationId: get-stores - x-groupName: Account - store level x-sortIndex: 4 x-methodName: listStores security: @@ -9021,7 +8873,6 @@ paths: \nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Stores read and write" operationId: post-stores - x-groupName: Account - store level x-sortIndex: 5 x-methodName: createStore security: @@ -9084,7 +8935,6 @@ paths: \ make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Stores read\n* Management API\u2014Stores read and write" operationId: get-stores-storeId - x-groupName: Account - store level x-sortIndex: 6 x-methodName: getStoreById security: @@ -9146,7 +8996,6 @@ paths: \ have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Stores read and write" operationId: patch-stores-storeId - x-groupName: Account - store level x-sortIndex: 7 x-methodName: updateStoreById security: @@ -9223,7 +9072,6 @@ paths: * Management API\u2014Terminal settings read\n* Management API\u2014Terminal\ \ settings read and write" operationId: get-stores-storeId-terminalLogos - x-groupName: Terminal settings - store level x-sortIndex: 2 x-methodName: getTerminalLogoByStoreId security: @@ -9298,7 +9146,6 @@ paths: \ make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal settings read and write" operationId: patch-stores-storeId-terminalLogos - x-groupName: Terminal settings - store level x-sortIndex: 4 x-methodName: updateTerminalLogoByStoreId security: @@ -9386,7 +9233,6 @@ paths: \ your API credential must have the following role:\n* Management API\u2014\ Terminal settings Advanced read and write" operationId: get-stores-storeId-terminalSettings - x-groupName: Terminal settings - store level x-sortIndex: 1 x-methodName: getTerminalSettingsByStoreId security: @@ -9458,7 +9304,6 @@ paths: \ your API credential must have the following role:\n* Management API\u2014\ Terminal settings Advanced read and write" operationId: patch-stores-storeId-terminalSettings - x-groupName: Terminal settings - store level x-sortIndex: 3 x-methodName: updateTerminalSettingsByStoreId security: @@ -9533,7 +9378,6 @@ paths: \ credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API \u2014 Terminal actions read" operationId: get-terminals - x-groupName: Terminals - terminal level x-sortIndex: 1 x-methodName: listTerminals security: @@ -9655,7 +9499,6 @@ paths: To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal actions read and write" operationId: post-terminals-scheduleActions - x-groupName: Terminal actions - terminal level x-sortIndex: 1 x-methodName: createTerminalAction security: @@ -9729,7 +9572,6 @@ paths: * Management API\u2014Assign Terminal" x-addedInVersion: '3' operationId: post-terminals-terminalId-reassign - x-groupName: Terminals - terminal level x-sortIndex: 2 x-methodName: reassignTerminal security: @@ -9793,7 +9635,6 @@ paths: * Management API\u2014Terminal settings read\n* Management API\u2014Terminal\ \ settings read and write" operationId: get-terminals-terminalId-terminalLogos - x-groupName: Terminal settings - terminal level x-sortIndex: 4 x-methodName: getTerminalLogo security: @@ -9857,7 +9698,6 @@ paths: \ your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ * Management API\u2014Terminal settings read and write" operationId: patch-terminals-terminalId-terminalLogos - x-groupName: Terminal settings - terminal level x-sortIndex: 6 x-methodName: updateLogo security: @@ -9935,7 +9775,6 @@ paths: \ your API credential must have the following role:\n* Management API\u2014\ Terminal settings Advanced read and write" operationId: get-terminals-terminalId-terminalSettings - x-groupName: Terminal settings - terminal level x-sortIndex: 3 x-methodName: getTerminalSettings security: @@ -10005,7 +9844,6 @@ paths: \ your API credential must have the following role:\n* Management API\u2014\ Terminal settings Advanced read and write" operationId: patch-terminals-terminalId-terminalSettings - x-groupName: Terminal settings - terminal level x-sortIndex: 5 x-methodName: updateTerminalSettings security: @@ -13835,6 +13673,13 @@ components: required: - swishNumber type: object + TapToPay: + properties: + merchantDisplayName: + description: Platform merchants can customize the text that appears on the + TapToPay screen during a transaction + type: string + type: object Terminal: properties: assignment: @@ -14205,6 +14050,9 @@ components: description: Settings for payment [surcharge](https://docs.adyen.com/point-of-sale/surcharge) features. $ref: '#/components/schemas/Surcharge' + tapToPay: + description: Settings for apple tap to pay. + $ref: '#/components/schemas/TapToPay' timeouts: description: Settings for device [time-outs](https://docs.adyen.com/point-of-sale/pos-timeouts#device-time-out). $ref: '#/components/schemas/Timeouts'