jlengrand/adyen-openapi
1
0
Fork 0
mirror of https://github.com/gcatanese/adyen-openapi.git synced 2026-03-10 08:01:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

spec release

Browse Source
This commit is contained in:
Adyen Automation
2024-11-25 17:07:23 +01:00
parent db47f83fbb
commit 35338ffc9f
8 changed files with 814 additions and 328 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
json/ManagementNotificationService-v1.json
View File

@@ -167,7 +167,7 @@
"Terminal management"
],
"summary" : "Result of terminal boarding",
"description" : "The boarding of a payment terminal succeeded or failed.",
"description" : "The boarding of a payment terminal succeeded.",
"x-addedInVersion" : "1",
"operationId" : "post-terminalBoarding.triggered",
"x-sortIndex" : 2,

2
json/ManagementNotificationService-v3.json
View File

@@ -257,7 +257,7 @@
"Terminal management"
],
"summary" : "Result of terminal boarding",
"description" : "The boarding of a payment terminal succeeded or failed.",
"description" : "The boarding of a payment terminal succeeded.",
"x-addedInVersion" : "1",
"operationId" : "post-terminalBoarding.triggered",
"x-sortIndex" : 2,

221
json/ManagementService-v1.json
View File

@@ -323,7 +323,7 @@
"Android files - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-androidApps",
"x-sortIndex" : 1,
"x-methodName" : "listAndroidApps",
@@ -462,7 +462,7 @@
"Android files - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-androidApps-id",
"x-sortIndex" : 3,
"x-methodName" : "getAndroidApp",
@@ -566,7 +566,7 @@
"Android files - company level"
],
"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 certificates 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",
"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 certificates 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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-androidCertificates",
"x-sortIndex" : 2,
"x-methodName" : "listAndroidCertificates",
@@ -1817,7 +1817,7 @@
"Terminal orders - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-billingEntities",
"x-sortIndex" : 3,
"x-methodName" : "listBillingEntities",
@@ -2046,7 +2046,7 @@
"Terminal orders - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-shippingLocations",
"x-sortIndex" : 4,
"x-methodName" : "listShippingLocations",
@@ -2173,7 +2173,7 @@
"Terminal orders - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "post-companies-companyId-shippingLocations",
"x-sortIndex" : 5,
"x-methodName" : "createShippingLocation",
@@ -2287,7 +2287,7 @@
"Terminal actions - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-terminalActions",
"x-sortIndex" : 1,
"x-methodName" : "listTerminalActions",
@@ -2425,7 +2425,7 @@
"Terminal actions - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-terminalActions-actionId",
"x-sortIndex" : 2,
"x-methodName" : "getTerminalAction",
@@ -2534,7 +2534,7 @@
"Terminal settings - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-terminalLogos",
"x-sortIndex" : 2,
"x-methodName" : "getTerminalLogo",
@@ -2641,7 +2641,7 @@
"Terminal settings - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-companies-companyId-terminalLogos",
"x-sortIndex" : 4,
"x-methodName" : "updateTerminalLogo",
@@ -2770,7 +2770,7 @@
"Terminal orders - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-terminalModels",
"x-sortIndex" : 1,
"x-methodName" : "listTerminalModels",
@@ -2870,7 +2870,7 @@
"Terminal orders - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-terminalOrders",
"x-sortIndex" : 7,
"x-methodName" : "listOrders",
@@ -3006,7 +3006,7 @@
"Terminal orders - company level"
],
"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.",
"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.\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "post-companies-companyId-terminalOrders",
"x-sortIndex" : 6,
"x-methodName" : "createOrder",
@@ -3120,7 +3120,7 @@
"Terminal orders - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-terminalOrders-orderId",
"x-sortIndex" : 8,
"x-methodName" : "getOrder",
@@ -3227,7 +3227,7 @@
"Terminal orders - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-companies-companyId-terminalOrders-orderId",
"x-sortIndex" : 9,
"x-methodName" : "updateOrder",
@@ -3350,7 +3350,7 @@
"Terminal orders - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "post-companies-companyId-terminalOrders-orderId-cancel",
"x-sortIndex" : 10,
"x-methodName" : "cancelOrder",
@@ -3459,7 +3459,7 @@
"Terminal orders - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-terminalProducts",
"x-sortIndex" : 2,
"x-methodName" : "listTerminalProducts",
@@ -3597,7 +3597,7 @@
"Terminal settings - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-terminalSettings",
"x-sortIndex" : 1,
"x-methodName" : "getTerminalSettings",
@@ -3695,7 +3695,7 @@
"Terminal settings - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-companies-companyId-terminalSettings",
"x-sortIndex" : 3,
"x-methodName" : "updateTerminalSettings",
@@ -7159,7 +7159,7 @@
"Terminal orders - merchant level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-merchants-merchantId-billingEntities",
"x-sortIndex" : 3,
"x-methodName" : "listBillingEntities",
@@ -7680,6 +7680,11 @@
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"update-payment-method" : {
"$ref" : "#/components/examples/patch-merchants-merchantId-paymentMethodSettings-paymentMethodId-update-payment-method"
}
},
"schema" : {
"$ref" : "#/components/schemas/UpdatePaymentMethodInfo"
}
@@ -7710,6 +7715,11 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"update-payment-method" : {
"$ref" : "#/components/examples/patch-merchants-merchantId-paymentMethodSettings-paymentMethodId-update-payment-method-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/PaymentMethod"
}
@@ -8536,7 +8546,7 @@
"Terminal orders - merchant level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-merchants-merchantId-shippingLocations",
"x-sortIndex" : 4,
"x-methodName" : "listShippingLocations",
@@ -8666,7 +8676,7 @@
"Terminal orders - merchant level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "post-merchants-merchantId-shippingLocations",
"x-sortIndex" : 5,
"x-methodName" : "createShippingLocation",
@@ -9858,7 +9868,7 @@
"Account - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-merchants-merchantId-stores",
"x-sortIndex" : 1,
"x-methodName" : "listStoresByMerchantId",
@@ -9988,7 +9998,7 @@
"Account - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "post-merchants-merchantId-stores",
"x-sortIndex" : 0,
"x-methodName" : "createStoreByMerchantId",
@@ -10105,7 +10115,7 @@
"Terminal settings - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-merchants-merchantId-stores-reference-terminalLogos",
"x-sortIndex" : 2,
"x-methodName" : "getTerminalLogo",
@@ -10224,7 +10234,7 @@
"Terminal settings - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-merchants-merchantId-stores-reference-terminalLogos",
"x-sortIndex" : 4,
"x-methodName" : "updateTerminalLogo",
@@ -10365,7 +10375,7 @@
"Terminal settings - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-merchants-merchantId-stores-reference-terminalSettings",
"x-sortIndex" : 1,
"x-methodName" : "getTerminalSettings",
@@ -10475,7 +10485,7 @@
"Terminal settings - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-merchants-merchantId-stores-reference-terminalSettings",
"x-sortIndex" : 3,
"x-methodName" : "updateTerminalSettings",
@@ -10607,7 +10617,7 @@
"Account - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-merchants-merchantId-stores-storeId",
"x-sortIndex" : 2,
"x-methodName" : "getStore",
@@ -10717,7 +10727,7 @@
"Account - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-merchants-merchantId-stores-storeId",
"x-sortIndex" : 3,
"x-methodName" : "updateStore",
@@ -10849,7 +10859,7 @@
"Terminal settings - merchant level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-merchants-merchantId-terminalLogos",
"x-sortIndex" : 2,
"x-methodName" : "getTerminalLogo",
@@ -10959,7 +10969,7 @@
"Terminal settings - merchant level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-merchants-merchantId-terminalLogos",
"x-sortIndex" : 4,
"x-methodName" : "updateTerminalLogo",
@@ -11091,7 +11101,7 @@
"Terminal orders - merchant level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-merchants-merchantId-terminalModels",
"x-sortIndex" : 1,
"x-methodName" : "listTerminalModels",
@@ -11194,7 +11204,7 @@
"Terminal orders - merchant level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-merchants-merchantId-terminalOrders",
"x-sortIndex" : 7,
"x-methodName" : "listOrders",
@@ -11332,7 +11342,7 @@
"Terminal orders - merchant level"
],
"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.",
"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.\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "post-merchants-merchantId-terminalOrders",
"x-sortIndex" : 6,
"x-methodName" : "createOrder",
@@ -11449,7 +11459,7 @@
"Terminal orders - merchant level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-merchants-merchantId-terminalOrders-orderId",
"x-sortIndex" : 8,
"x-methodName" : "getOrder",
@@ -11559,7 +11569,7 @@
"Terminal orders - merchant level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-merchants-merchantId-terminalOrders-orderId",
"x-sortIndex" : 9,
"x-methodName" : "updateOrder",
@@ -11685,7 +11695,7 @@
"Terminal orders - merchant level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "post-merchants-merchantId-terminalOrders-orderId-cancel",
"x-sortIndex" : 10,
"x-methodName" : "cancelOrder",
@@ -11797,7 +11807,7 @@
"Terminal orders - merchant level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-merchants-merchantId-terminalProducts",
"x-sortIndex" : 2,
"x-methodName" : "listTerminalProducts",
@@ -11938,7 +11948,7 @@
"Terminal settings - merchant level"
],
"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",
"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\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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-merchants-merchantId-terminalSettings",
"x-sortIndex" : 1,
"x-methodName" : "getTerminalSettings",
@@ -12039,7 +12049,7 @@
"Terminal settings - merchant level"
],
"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",
"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\n\n\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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-merchants-merchantId-terminalSettings",
"x-sortIndex" : 3,
"x-methodName" : "updateTerminalSettings",
@@ -13443,7 +13453,7 @@
"Account - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-stores",
"x-sortIndex" : 4,
"x-methodName" : "listStores",
@@ -13570,7 +13580,7 @@
"Account - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "post-stores",
"x-sortIndex" : 5,
"x-methodName" : "createStore",
@@ -13673,7 +13683,7 @@
"Account - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-stores-storeId",
"x-sortIndex" : 6,
"x-methodName" : "getStoreById",
@@ -13771,7 +13781,7 @@
"Account - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-stores-storeId",
"x-sortIndex" : 7,
"x-methodName" : "updateStoreById",
@@ -13888,7 +13898,7 @@
"Terminal settings - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-stores-storeId-terminalLogos",
"x-sortIndex" : 2,
"x-methodName" : "getTerminalLogoByStoreId",
@@ -13995,7 +14005,7 @@
"Terminal settings - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-stores-storeId-terminalLogos",
"x-sortIndex" : 4,
"x-methodName" : "updateTerminalLogoByStoreId",
@@ -14124,7 +14134,7 @@
"Terminal settings - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-stores-storeId-terminalSettings",
"x-sortIndex" : 1,
"x-methodName" : "getTerminalSettingsByStoreId",
@@ -14222,7 +14232,7 @@
"Terminal settings - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-stores-storeId-terminalSettings",
"x-sortIndex" : 3,
"x-methodName" : "updateTerminalSettingsByStoreId",
@@ -14342,7 +14352,7 @@
"Terminals - terminal level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-terminals",
"x-sortIndex" : 1,
"x-methodName" : "listTerminals",
@@ -14507,7 +14517,7 @@
"Terminal actions - terminal level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "post-terminals-scheduleActions",
"x-sortIndex" : 1,
"x-methodName" : "createTerminalAction",
@@ -14624,7 +14634,7 @@
"Terminal settings - terminal level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-terminals-terminalId-terminalLogos",
"x-sortIndex" : 4,
"x-methodName" : "getTerminalLogo",
@@ -14722,7 +14732,7 @@
"Terminal settings - terminal level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-terminals-terminalId-terminalLogos",
"x-sortIndex" : 6,
"x-methodName" : "updateLogo",
@@ -14842,7 +14852,7 @@
"Terminal settings - terminal level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-terminals-terminalId-terminalSettings",
"x-sortIndex" : 3,
"x-methodName" : "getTerminalSettings",
@@ -14940,7 +14950,7 @@
"Terminal settings - terminal level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-terminals-terminalId-terminalSettings",
"x-sortIndex" : 5,
"x-methodName" : "updateTerminalSettings",
@@ -15232,16 +15242,17 @@
"additionalProperties" : false,
"properties" : {
"midNumber" : {
"description" : "MID (Merchant ID) number. Format: 10 numeric characters.\n Must be provided only when requesting `gatewayContract` or `paymentDesignatorContract` service levels.",
"description" : "Merchant ID (MID) number. Format: 10 numeric characters.\n You must provide this field when you request `gatewayContract` or `paymentDesignatorContract` service levels.",
"maxLength" : 10,
"type" : "string"
},
"reuseMidNumber" : {
"default" : false,
"description" : "Indicates whether the Amex Merchant ID is reused from a previously setup Amex payment method. \nThis is only applicable for `gatewayContract` and `paymentDesignatorContract` service levels. \nThe default value is `false`.",
"description" : "Indicates whether the Amex Merchant ID is reused from a previously setup Amex payment method. \nThis is only applicable for `gatewayContract` and `paymentDesignatorContract` service levels. \nThe default value is **false**.",
"type" : "boolean"
},
"serviceLevel" : {
"description" : "Specifies the service level (settlement type) of this payment method. Possible values:\n* **noContract** — Adyen holds the contract with American Express.\n* **gatewayContract** — American Express receives the settlement and handles disputes. They then pay out to the merchant directly.\n* **paymentDesignatorContract** — Adyen receives the settlement and handles disputes. Adyen then pays out to the merchant.",
"description" : "Specifies the service level (settlement type) of this payment method. Possible values:\n* **noContract**: Adyen holds the contract with American Express.\n* **gatewayContract**: American Express receives the settlement and handles disputes, then pays out to you or your sub-merchant directly.\n* **paymentDesignatorContract**: Adyen receives the settlement, and handles disputes and payouts.",
"enum" : [
"noContract",
"gatewayContract",
@@ -16686,6 +16697,37 @@
},
"type" : "object"
},
"DinersInfo" : {
"additionalProperties" : false,
"properties" : {
"midNumber" : {
"description" : "MID (Merchant ID) number. Required for merchants operating in Japan.\nFormat: 14 numeric characters.",
"maxLength" : 14,
"type" : "string"
},
"reuseMidNumber" : {
"default" : false,
"description" : "Indicates whether the JCB Merchant ID is reused from a previously configured JCB payment method.\nThe default value is **false**.\nFor merchants operating in Japan, this field is required and must be set to **true**.",
"type" : "boolean"
},
"serviceLevel" : {
"description" : "Specifies the service level (settlement type) of this payment method. Required for merchants operating in Japan. Possible values:\n * **noContract**: Adyen holds the contract with JCB.\n * **gatewayContract**: JCB receives the settlement and handles disputes, then pays out to you or your sub-merchant directly.",
"enum" : [
"noContract",
"gatewayContract"
],
"type" : "string"
},
"transactionDescription" : {
"description" : "Information regarding the transaction description.\n> You cannot configure the transaction description in the test environment.",
"$ref" : "#/components/schemas/TransactionDescriptionInfo"
}
},
"required" : [
"reuseMidNumber"
],
"type" : "object"
},
"EventUrl" : {
"additionalProperties" : false,
"properties" : {
@@ -16975,16 +17017,17 @@
"additionalProperties" : false,
"properties" : {
"midNumber" : {
"description" : "MID (Merchant ID) number. Format: 10 numeric characters.\n Must be provided for both `noContract` and `gatewayContract` service levels.",
"description" : "MID (Merchant ID) number. Required for merchants operating in Japan.Format: 14 numeric characters.",
"maxLength" : 14,
"type" : "string"
},
"reuseMidNumber" : {
"default" : false,
"description" : "Indicates whether the JCB Merchant ID is reused from a previously setup JCB payment method. \nThis is applicable for both `noContract` and `gatewayContract` service levels. \nThe default value is `false`.",
"description" : "Indicates whether the JCB Merchant ID is reused from a previously setup JCB payment method. \nThe default value is **false**.For merchants operating in Japan, this field is required and must be set to **true**.",
"type" : "boolean"
},
"serviceLevel" : {
"description" : "Specifies the service level (settlement type) of this payment method. Possible values:\n* **noContract** — Adyen holds the contract with JCB.\n* **gatewayContract** — JCB receives the settlement and handles disputes. They then pay out to the merchant directly.",
"description" : "Specifies the service level (settlement type) of this payment method. Required for merchants operating in Japan.\nPossible values:\n* **noContract**: Adyen holds the contract with JCB.\n* **gatewayContract**: JCB receives the settlement and handles disputes, then pays out to you or your sub-merchant directly.",
"enum" : [
"noContract",
"gatewayContract"
@@ -16996,9 +17039,6 @@
"$ref" : "#/components/schemas/TransactionDescriptionInfo"
}
},
"required" : [
"serviceLevel"
],
"type" : "object"
},
"JSONObject" : {
@@ -18023,11 +18063,11 @@
"type" : "array"
},
"diners" : {
"description" : "Diners details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
"description" : "Diners details. For merchants operating in Japan, Diners payments are processed through the JCB network. This means that you must include [JCB-specific fields](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/paymentMethodSettings/(paymentMethodId)#request-jcb) in this object.",
"$ref" : "#/components/schemas/DinersInfo"
},
"discover" : {
"description" : "Discover details.",
"description" : "Discover details. For merchants operating in Japan, request [Diners](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/paymentMethodSettings/(paymentMethodId)#request-diners) payment method instead. Discover is automatically requested, together with Diners.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"eftpos_australia" : {
@@ -18063,7 +18103,7 @@
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"jcb" : {
"description" : "JCB details.",
"description" : "JCB details.\nFor merchants operating in Japan, `midNumber`, `reuseMidNumber`, and `serviceLevel` fields are required.\nFor merchants operating outside of Japan, these fields are not required.",
"$ref" : "#/components/schemas/JCBInfo"
},
"klarna" : {
@@ -18200,6 +18240,7 @@
"items" : {
"enum" : [
"accel",
"affirm",
"afterpaytouch",
"alelo",
"alipay",
@@ -18344,11 +18385,11 @@
"type" : "array"
},
"diners" : {
"description" : "Diners details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
"description" : "Diners details. For merchants operating in Japan, Diners payments are processed through the JCB network. This means that you must include [JCB-specific fields](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/paymentMethodSettings/(paymentMethodId)#request-jcb) in this object.",
"$ref" : "#/components/schemas/DinersInfo"
},
"discover" : {
"description" : "Discover details.",
"description" : "Discover details. For merchants operating in Japan, request [Diners](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/paymentMethodSettings/(paymentMethodId)#request-diners) payment method instead. Discover is automatically requested, together with Diners.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"eftpos_australia" : {
@@ -18376,7 +18417,7 @@
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"jcb" : {
"description" : "JCB details.",
"description" : "JCB details.\nFor merchants operating in Japan, `midNumber`, `reuseMidNumber`, and `serviceLevel` fields are required.\nFor merchants operating outside of Japan, these fields are not required.",
"$ref" : "#/components/schemas/JCBInfo"
},
"klarna" : {
@@ -18458,6 +18499,7 @@
"description" : "Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api).",
"enum" : [
"accel",
"affirm",
"afterpaytouch",
"alelo",
"alipay",
@@ -25838,6 +25880,41 @@
}
}
},
"patch-merchants-merchantId-paymentMethodSettings-paymentMethodId-update-payment-method" : {
"summary" : "Update the currency and country details for a payment method",
"description" : "Update the currency and country details for a payment method",
"value" : {
"currencies" : [
"EUR"
],
"countries" : [
"NL"
]
}
},
"patch-merchants-merchantId-paymentMethodSettings-paymentMethodId-update-payment-method-200" : {
"summary" : "Currency and country details updated for the payment method",
"description" : "Currency and country details updated for the payment method",
"value" : {
"mc" : {
"transactionDescription" : {
"doingBusinessAsName" : "YOUR_BUSINESS_NAME",
"type" : "fixed"
}
},
"id" : "PM322DZ243226G5LKBTGM7FBQ",
"type" : "mc",
"enabled" : true,
"countries" : [
"NL"
],
"currencies" : [
"EUR"
],
"customRoutingFlags" : [
]
}
},
"patch-merchants-merchantId-splitConfigurations-splitConfigurationId-patch-splitConfiguration-description" : {
"summary" : "Update split configuration description",
"description" : "Example request for updating the description of a split configuration",

229
json/ManagementService-v3.json
View File

@@ -323,7 +323,7 @@
"Android files - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-androidApps",
"x-sortIndex" : 1,
"x-methodName" : "listAndroidApps",
@@ -460,7 +460,7 @@
"Android files - company level"
],
"summary" : "Upload Android App",
"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.",
"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\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).\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-sortIndex" : 4,
@@ -556,7 +556,7 @@
"Android files - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-androidApps-id",
"x-sortIndex" : 3,
"x-methodName" : "getAndroidApp",
@@ -658,7 +658,7 @@
"Android files - company level"
],
"summary" : "Reprocess Android App",
"description" : "Reuploads the Android app identified in the path. \nTo make this request, your API credential must have this [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.",
"description" : "Reuploads the Android app identified in the path. \nTo make this request, your API credential must have this [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Android files read and write\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).\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" : "patch-companies-companyId-androidApps-id",
"x-sortIndex" : 6,
@@ -763,7 +763,7 @@
"Android files - company level"
],
"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 certificates 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",
"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 certificates 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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-androidCertificates",
"x-sortIndex" : 2,
"x-methodName" : "listAndroidCertificates",
@@ -890,7 +890,7 @@
"Android files - company level"
],
"summary" : "Upload Android Certificate",
"description" : "Uploads an Android Certificate file to Adyen.\n",
"description" : "Uploads an Android Certificate file to Adyen.\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"x-addedInVersion" : "3",
"operationId" : "post-companies-companyId-androidCertificates",
"x-sortIndex" : 5,
@@ -2108,7 +2108,7 @@
"Terminal orders - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-billingEntities",
"x-sortIndex" : 3,
"x-methodName" : "listBillingEntities",
@@ -2337,7 +2337,7 @@
"Terminal orders - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-shippingLocations",
"x-sortIndex" : 4,
"x-methodName" : "listShippingLocations",
@@ -2464,7 +2464,7 @@
"Terminal orders - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "post-companies-companyId-shippingLocations",
"x-sortIndex" : 5,
"x-methodName" : "createShippingLocation",
@@ -2578,7 +2578,7 @@
"Terminal actions - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-terminalActions",
"x-sortIndex" : 1,
"x-methodName" : "listTerminalActions",
@@ -2716,7 +2716,7 @@
"Terminal actions - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-terminalActions-actionId",
"x-sortIndex" : 2,
"x-methodName" : "getTerminalAction",
@@ -2825,7 +2825,7 @@
"Terminal settings - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-terminalLogos",
"x-sortIndex" : 2,
"x-methodName" : "getTerminalLogo",
@@ -2932,7 +2932,7 @@
"Terminal settings - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-companies-companyId-terminalLogos",
"x-sortIndex" : 4,
"x-methodName" : "updateTerminalLogo",
@@ -3061,7 +3061,7 @@
"Terminal orders - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-terminalModels",
"x-sortIndex" : 1,
"x-methodName" : "listTerminalModels",
@@ -3161,7 +3161,7 @@
"Terminal orders - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-terminalOrders",
"x-sortIndex" : 7,
"x-methodName" : "listOrders",
@@ -3297,7 +3297,7 @@
"Terminal orders - company level"
],
"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.",
"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.\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "post-companies-companyId-terminalOrders",
"x-sortIndex" : 6,
"x-methodName" : "createOrder",
@@ -3411,7 +3411,7 @@
"Terminal orders - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-terminalOrders-orderId",
"x-sortIndex" : 8,
"x-methodName" : "getOrder",
@@ -3518,7 +3518,7 @@
"Terminal orders - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-companies-companyId-terminalOrders-orderId",
"x-sortIndex" : 9,
"x-methodName" : "updateOrder",
@@ -3641,7 +3641,7 @@
"Terminal orders - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "post-companies-companyId-terminalOrders-orderId-cancel",
"x-sortIndex" : 10,
"x-methodName" : "cancelOrder",
@@ -3750,7 +3750,7 @@
"Terminal orders - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-terminalProducts",
"x-sortIndex" : 2,
"x-methodName" : "listTerminalProducts",
@@ -3888,7 +3888,7 @@
"Terminal settings - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-companies-companyId-terminalSettings",
"x-sortIndex" : 1,
"x-methodName" : "getTerminalSettings",
@@ -3986,7 +3986,7 @@
"Terminal settings - company level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-companies-companyId-terminalSettings",
"x-sortIndex" : 3,
"x-methodName" : "updateTerminalSettings",
@@ -7450,7 +7450,7 @@
"Terminal orders - merchant level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-merchants-merchantId-billingEntities",
"x-sortIndex" : 3,
"x-methodName" : "listBillingEntities",
@@ -7971,6 +7971,11 @@
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"update-payment-method" : {
"$ref" : "#/components/examples/patch-merchants-merchantId-paymentMethodSettings-paymentMethodId-update-payment-method"
}
},
"schema" : {
"$ref" : "#/components/schemas/UpdatePaymentMethodInfo"
}
@@ -8001,6 +8006,11 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"update-payment-method" : {
"$ref" : "#/components/examples/patch-merchants-merchantId-paymentMethodSettings-paymentMethodId-update-payment-method-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/PaymentMethod"
}
@@ -8827,7 +8837,7 @@
"Terminal orders - merchant level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-merchants-merchantId-shippingLocations",
"x-sortIndex" : 4,
"x-methodName" : "listShippingLocations",
@@ -8957,7 +8967,7 @@
"Terminal orders - merchant level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "post-merchants-merchantId-shippingLocations",
"x-sortIndex" : 5,
"x-methodName" : "createShippingLocation",
@@ -10149,7 +10159,7 @@
"Account - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-merchants-merchantId-stores",
"x-sortIndex" : 1,
"x-methodName" : "listStoresByMerchantId",
@@ -10279,7 +10289,7 @@
"Account - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "post-merchants-merchantId-stores",
"x-sortIndex" : 0,
"x-methodName" : "createStoreByMerchantId",
@@ -10396,7 +10406,7 @@
"Terminal settings - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-merchants-merchantId-stores-reference-terminalLogos",
"x-sortIndex" : 2,
"x-methodName" : "getTerminalLogo",
@@ -10515,7 +10525,7 @@
"Terminal settings - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-merchants-merchantId-stores-reference-terminalLogos",
"x-sortIndex" : 4,
"x-methodName" : "updateTerminalLogo",
@@ -10656,7 +10666,7 @@
"Terminal settings - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-merchants-merchantId-stores-reference-terminalSettings",
"x-sortIndex" : 1,
"x-methodName" : "getTerminalSettings",
@@ -10766,7 +10776,7 @@
"Terminal settings - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-merchants-merchantId-stores-reference-terminalSettings",
"x-sortIndex" : 3,
"x-methodName" : "updateTerminalSettings",
@@ -10898,7 +10908,7 @@
"Account - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-merchants-merchantId-stores-storeId",
"x-sortIndex" : 2,
"x-methodName" : "getStore",
@@ -11008,7 +11018,7 @@
"Account - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-merchants-merchantId-stores-storeId",
"x-sortIndex" : 3,
"x-methodName" : "updateStore",
@@ -11140,7 +11150,7 @@
"Terminal settings - merchant level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-merchants-merchantId-terminalLogos",
"x-sortIndex" : 2,
"x-methodName" : "getTerminalLogo",
@@ -11250,7 +11260,7 @@
"Terminal settings - merchant level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-merchants-merchantId-terminalLogos",
"x-sortIndex" : 4,
"x-methodName" : "updateTerminalLogo",
@@ -11382,7 +11392,7 @@
"Terminal orders - merchant level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-merchants-merchantId-terminalModels",
"x-sortIndex" : 1,
"x-methodName" : "listTerminalModels",
@@ -11485,7 +11495,7 @@
"Terminal orders - merchant level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-merchants-merchantId-terminalOrders",
"x-sortIndex" : 7,
"x-methodName" : "listOrders",
@@ -11623,7 +11633,7 @@
"Terminal orders - merchant level"
],
"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.",
"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.\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "post-merchants-merchantId-terminalOrders",
"x-sortIndex" : 6,
"x-methodName" : "createOrder",
@@ -11740,7 +11750,7 @@
"Terminal orders - merchant level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-merchants-merchantId-terminalOrders-orderId",
"x-sortIndex" : 8,
"x-methodName" : "getOrder",
@@ -11850,7 +11860,7 @@
"Terminal orders - merchant level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-merchants-merchantId-terminalOrders-orderId",
"x-sortIndex" : 9,
"x-methodName" : "updateOrder",
@@ -11976,7 +11986,7 @@
"Terminal orders - merchant level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "post-merchants-merchantId-terminalOrders-orderId-cancel",
"x-sortIndex" : 10,
"x-methodName" : "cancelOrder",
@@ -12088,7 +12098,7 @@
"Terminal orders - merchant level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-merchants-merchantId-terminalProducts",
"x-sortIndex" : 2,
"x-methodName" : "listTerminalProducts",
@@ -12229,7 +12239,7 @@
"Terminal settings - merchant level"
],
"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",
"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\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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-merchants-merchantId-terminalSettings",
"x-sortIndex" : 1,
"x-methodName" : "getTerminalSettings",
@@ -12330,7 +12340,7 @@
"Terminal settings - merchant level"
],
"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",
"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\n\n\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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-merchants-merchantId-terminalSettings",
"x-sortIndex" : 3,
"x-methodName" : "updateTerminalSettings",
@@ -13734,7 +13744,7 @@
"Account - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-stores",
"x-sortIndex" : 4,
"x-methodName" : "listStores",
@@ -13861,7 +13871,7 @@
"Account - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "post-stores",
"x-sortIndex" : 5,
"x-methodName" : "createStore",
@@ -13964,7 +13974,7 @@
"Account - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-stores-storeId",
"x-sortIndex" : 6,
"x-methodName" : "getStoreById",
@@ -14062,7 +14072,7 @@
"Account - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-stores-storeId",
"x-sortIndex" : 7,
"x-methodName" : "updateStoreById",
@@ -14179,7 +14189,7 @@
"Terminal settings - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-stores-storeId-terminalLogos",
"x-sortIndex" : 2,
"x-methodName" : "getTerminalLogoByStoreId",
@@ -14286,7 +14296,7 @@
"Terminal settings - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-stores-storeId-terminalLogos",
"x-sortIndex" : 4,
"x-methodName" : "updateTerminalLogoByStoreId",
@@ -14415,7 +14425,7 @@
"Terminal settings - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-stores-storeId-terminalSettings",
"x-sortIndex" : 1,
"x-methodName" : "getTerminalSettingsByStoreId",
@@ -14513,7 +14523,7 @@
"Terminal settings - store level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-stores-storeId-terminalSettings",
"x-sortIndex" : 3,
"x-methodName" : "updateTerminalSettingsByStoreId",
@@ -14633,7 +14643,7 @@
"Terminals - terminal level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-terminals",
"x-sortIndex" : 1,
"x-methodName" : "listTerminals",
@@ -14798,7 +14808,7 @@
"Terminal actions - terminal level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "post-terminals-scheduleActions",
"x-sortIndex" : 1,
"x-methodName" : "createTerminalAction",
@@ -14915,7 +14925,7 @@
"Terminals - terminal level"
],
"summary" : "Reassign a terminal",
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"x-addedInVersion" : "3",
"operationId" : "post-terminals-terminalId-reassign",
"x-sortIndex" : 2,
@@ -15021,7 +15031,7 @@
"Terminal settings - terminal level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-terminals-terminalId-terminalLogos",
"x-sortIndex" : 4,
"x-methodName" : "getTerminalLogo",
@@ -15119,7 +15129,7 @@
"Terminal settings - terminal level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-terminals-terminalId-terminalLogos",
"x-sortIndex" : 6,
"x-methodName" : "updateLogo",
@@ -15239,7 +15249,7 @@
"Terminal settings - terminal level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "get-terminals-terminalId-terminalSettings",
"x-sortIndex" : 3,
"x-methodName" : "getTerminalSettings",
@@ -15337,7 +15347,7 @@
"Terminal settings - terminal level"
],
"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",
"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\n\nIn the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).",
"operationId" : "patch-terminals-terminalId-terminalSettings",
"x-sortIndex" : 5,
"x-methodName" : "updateTerminalSettings",
@@ -15629,16 +15639,17 @@
"additionalProperties" : false,
"properties" : {
"midNumber" : {
"description" : "MID (Merchant ID) number. Format: 10 numeric characters.\n Must be provided only when requesting `gatewayContract` or `paymentDesignatorContract` service levels.",
"description" : "Merchant ID (MID) number. Format: 10 numeric characters.\n You must provide this field when you request `gatewayContract` or `paymentDesignatorContract` service levels.",
"maxLength" : 10,
"type" : "string"
},
"reuseMidNumber" : {
"default" : false,
"description" : "Indicates whether the Amex Merchant ID is reused from a previously setup Amex payment method. \nThis is only applicable for `gatewayContract` and `paymentDesignatorContract` service levels. \nThe default value is `false`.",
"description" : "Indicates whether the Amex Merchant ID is reused from a previously setup Amex payment method. \nThis is only applicable for `gatewayContract` and `paymentDesignatorContract` service levels. \nThe default value is **false**.",
"type" : "boolean"
},
"serviceLevel" : {
"description" : "Specifies the service level (settlement type) of this payment method. Possible values:\n* **noContract** — Adyen holds the contract with American Express.\n* **gatewayContract** — American Express receives the settlement and handles disputes. They then pay out to the merchant directly.\n* **paymentDesignatorContract** — Adyen receives the settlement and handles disputes. Adyen then pays out to the merchant.",
"description" : "Specifies the service level (settlement type) of this payment method. Possible values:\n* **noContract**: Adyen holds the contract with American Express.\n* **gatewayContract**: American Express receives the settlement and handles disputes, then pays out to you or your sub-merchant directly.\n* **paymentDesignatorContract**: Adyen receives the settlement, and handles disputes and payouts.",
"enum" : [
"noContract",
"gatewayContract",
@@ -17113,6 +17124,37 @@
},
"type" : "object"
},
"DinersInfo" : {
"additionalProperties" : false,
"properties" : {
"midNumber" : {
"description" : "MID (Merchant ID) number. Required for merchants operating in Japan.\nFormat: 14 numeric characters.",
"maxLength" : 14,
"type" : "string"
},
"reuseMidNumber" : {
"default" : false,
"description" : "Indicates whether the JCB Merchant ID is reused from a previously configured JCB payment method.\nThe default value is **false**.\nFor merchants operating in Japan, this field is required and must be set to **true**.",
"type" : "boolean"
},
"serviceLevel" : {
"description" : "Specifies the service level (settlement type) of this payment method. Required for merchants operating in Japan. Possible values:\n * **noContract**: Adyen holds the contract with JCB.\n * **gatewayContract**: JCB receives the settlement and handles disputes, then pays out to you or your sub-merchant directly.",
"enum" : [
"noContract",
"gatewayContract"
],
"type" : "string"
},
"transactionDescription" : {
"description" : "Information regarding the transaction description.\n> You cannot configure the transaction description in the test environment.",
"$ref" : "#/components/schemas/TransactionDescriptionInfo"
}
},
"required" : [
"reuseMidNumber"
],
"type" : "object"
},
"EventUrl" : {
"additionalProperties" : false,
"properties" : {
@@ -17395,16 +17437,17 @@
"additionalProperties" : false,
"properties" : {
"midNumber" : {
"description" : "MID (Merchant ID) number. Format: 10 numeric characters.\n Must be provided for both `noContract` and `gatewayContract` service levels.",
"description" : "MID (Merchant ID) number. Required for merchants operating in Japan.Format: 14 numeric characters.",
"maxLength" : 14,
"type" : "string"
},
"reuseMidNumber" : {
"default" : false,
"description" : "Indicates whether the JCB Merchant ID is reused from a previously setup JCB payment method. \nThis is applicable for both `noContract` and `gatewayContract` service levels. \nThe default value is `false`.",
"description" : "Indicates whether the JCB Merchant ID is reused from a previously setup JCB payment method. \nThe default value is **false**.For merchants operating in Japan, this field is required and must be set to **true**.",
"type" : "boolean"
},
"serviceLevel" : {
"description" : "Specifies the service level (settlement type) of this payment method. Possible values:\n* **noContract** — Adyen holds the contract with JCB.\n* **gatewayContract** — JCB receives the settlement and handles disputes. They then pay out to the merchant directly.",
"description" : "Specifies the service level (settlement type) of this payment method. Required for merchants operating in Japan.\nPossible values:\n* **noContract**: Adyen holds the contract with JCB.\n* **gatewayContract**: JCB receives the settlement and handles disputes, then pays out to you or your sub-merchant directly.",
"enum" : [
"noContract",
"gatewayContract"
@@ -17416,9 +17459,6 @@
"$ref" : "#/components/schemas/TransactionDescriptionInfo"
}
},
"required" : [
"serviceLevel"
],
"type" : "object"
},
"JSONObject" : {
@@ -18443,11 +18483,11 @@
"type" : "array"
},
"diners" : {
"description" : "Diners details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
"description" : "Diners details. For merchants operating in Japan, Diners payments are processed through the JCB network. This means that you must include [JCB-specific fields](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/paymentMethodSettings/(paymentMethodId)#request-jcb) in this object.",
"$ref" : "#/components/schemas/DinersInfo"
},
"discover" : {
"description" : "Discover details.",
"description" : "Discover details. For merchants operating in Japan, request [Diners](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/paymentMethodSettings/(paymentMethodId)#request-diners) payment method instead. Discover is automatically requested, together with Diners.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"eftpos_australia" : {
@@ -18483,7 +18523,7 @@
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"jcb" : {
"description" : "JCB details.",
"description" : "JCB details.\nFor merchants operating in Japan, `midNumber`, `reuseMidNumber`, and `serviceLevel` fields are required.\nFor merchants operating outside of Japan, these fields are not required.",
"$ref" : "#/components/schemas/JCBInfo"
},
"klarna" : {
@@ -18624,6 +18664,7 @@
"items" : {
"enum" : [
"accel",
"affirm",
"afterpaytouch",
"alelo",
"alipay",
@@ -18768,11 +18809,11 @@
"type" : "array"
},
"diners" : {
"description" : "Diners details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
"description" : "Diners details. For merchants operating in Japan, Diners payments are processed through the JCB network. This means that you must include [JCB-specific fields](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/paymentMethodSettings/(paymentMethodId)#request-jcb) in this object.",
"$ref" : "#/components/schemas/DinersInfo"
},
"discover" : {
"description" : "Discover details.",
"description" : "Discover details. For merchants operating in Japan, request [Diners](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/paymentMethodSettings/(paymentMethodId)#request-diners) payment method instead. Discover is automatically requested, together with Diners.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"eftpos_australia" : {
@@ -18800,7 +18841,7 @@
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"jcb" : {
"description" : "JCB details.",
"description" : "JCB details.\nFor merchants operating in Japan, `midNumber`, `reuseMidNumber`, and `serviceLevel` fields are required.\nFor merchants operating outside of Japan, these fields are not required.",
"$ref" : "#/components/schemas/JCBInfo"
},
"klarna" : {
@@ -18886,6 +18927,7 @@
"description" : "Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api).",
"enum" : [
"accel",
"affirm",
"afterpaytouch",
"alelo",
"alipay",
@@ -26391,6 +26433,41 @@
}
}
},
"patch-merchants-merchantId-paymentMethodSettings-paymentMethodId-update-payment-method" : {
"summary" : "Update the currency and country details for a payment method",
"description" : "Update the currency and country details for a payment method",
"value" : {
"currencies" : [
"EUR"
],
"countries" : [
"NL"
]
}
},
"patch-merchants-merchantId-paymentMethodSettings-paymentMethodId-update-payment-method-200" : {
"summary" : "Currency and country details updated for the payment method",
"description" : "Currency and country details updated for the payment method",
"value" : {
"mc" : {
"transactionDescription" : {
"doingBusinessAsName" : "YOUR_BUSINESS_NAME",
"type" : "fixed"
}
},
"id" : "PM322DZ243226G5LKBTGM7FBQ",
"type" : "mc",
"enabled" : true,
"countries" : [
"NL"
],
"currencies" : [
"EUR"
],
"customRoutingFlags" : [
]
}
},
"patch-merchants-merchantId-splitConfigurations-splitConfigurationId-patch-splitConfiguration-description" : {
"summary" : "Update split configuration description",
"description" : "Example request for updating the description of a split configuration",

2
yaml/ManagementNotificationService-v1.yaml
View File

@@ -115,7 +115,7 @@ webhooks:
tags:
- Terminal management
summary: Result of terminal boarding
description: The boarding of a payment terminal succeeded or failed.
description: The boarding of a payment terminal succeeded.
x-addedInVersion: '1'
operationId: post-terminalBoarding.triggered
x-sortIndex: 2

2
yaml/ManagementNotificationService-v3.yaml
View File

@@ -172,7 +172,7 @@ webhooks:
tags:
- Terminal management
summary: Result of terminal boarding
description: The boarding of a payment terminal succeeded or failed.
description: The boarding of a payment terminal succeeded.
x-addedInVersion: '1'
operationId: post-terminalBoarding.triggered
x-sortIndex: 2

330
yaml/ManagementService-v1.yaml
View File

@@ -232,7 +232,8 @@ paths:
\ [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\
* Management API\u2014Android files read\n* Management API\u2014Android files\
\ read and write\n* Management API\u2014Terminal actions read\n* Management\
\ API\u2014Terminal actions read and write"
\ API\u2014Terminal actions read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-androidApps
x-sortIndex: 1
x-methodName: listAndroidApps
@@ -325,7 +326,8 @@ paths:
\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\u2014Android files read\n* Management API\u2014Android files\
\ read and write"
\ read and write\n\nIn the live environment, requests to this endpoint are\
\ subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-androidApps-id
x-sortIndex: 3
x-methodName: getAndroidApp
@@ -396,7 +398,8 @@ paths:
\ [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\
* Management API\u2014Android files read\n* Management API\u2014Android files\
\ read and write\n* Management API\u2014Terminal actions read\n* Management\
\ API\u2014Terminal actions read and write"
\ API\u2014Terminal actions read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-androidCertificates
x-sortIndex: 2
x-methodName: listAndroidCertificates
@@ -1200,7 +1203,8 @@ paths:
\ 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\u2014Terminal ordering read\n* Management API\u2014Terminal\
\ ordering read and write"
\ ordering read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-billingEntities
x-sortIndex: 3
x-methodName: listBillingEntities
@@ -1350,7 +1354,8 @@ paths:
\ 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\u2014Terminal ordering read\n* Management API\u2014Terminal\
\ ordering read and write"
\ ordering read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-shippingLocations
x-sortIndex: 4
x-methodName: listShippingLocations
@@ -1431,7 +1436,8 @@ paths:
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\u2014Terminal ordering read and write"
* Management API\u2014Terminal ordering read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: post-companies-companyId-shippingLocations
x-sortIndex: 5
x-methodName: createShippingLocation
@@ -1503,7 +1509,8 @@ paths:
\ 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\u2014Terminal actions read\n* Management API\u2014Terminal\
\ actions read and write"
\ actions read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-terminalActions
x-sortIndex: 1
x-methodName: listTerminalActions
@@ -1596,7 +1603,8 @@ paths:
\ 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\u2014Terminal actions read\n* Management API\u2014Terminal\
\ actions read and write"
\ actions read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-terminalActions-actionId
x-sortIndex: 2
x-methodName: getTerminalAction
@@ -1669,7 +1677,8 @@ paths:
\ 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\u2014Terminal settings read\n* Management API\u2014Terminal\
\ settings read and write"
\ settings read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-terminalLogos
x-sortIndex: 2
x-methodName: getTerminalLogo
@@ -1744,7 +1753,8 @@ paths:
* 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\u2014Terminal settings read and write"
* Management API\u2014Terminal settings read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-companies-companyId-terminalLogos
x-sortIndex: 4
x-methodName: updateTerminalLogo
@@ -1829,7 +1839,8 @@ paths:
\ 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\u2014Terminal ordering read\n* Management API\u2014Terminal\
\ ordering read and write"
\ ordering read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-terminalModels
x-sortIndex: 1
x-methodName: listTerminalModels
@@ -1893,7 +1904,8 @@ paths:
\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\u2014Terminal ordering read\n* Management API\u2014Terminal\
\ ordering read and write"
\ ordering read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-terminalOrders
x-sortIndex: 7
x-methodName: listOrders
@@ -1984,7 +1996,8 @@ paths:
* Management API\u2014Terminal 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."
\ in your Customer Area.\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: post-companies-companyId-terminalOrders
x-sortIndex: 6
x-methodName: createOrder
@@ -2055,7 +2068,8 @@ paths:
\ 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\u2014Terminal ordering read\n* Management API\u2014Terminal\
\ ordering read and write"
\ ordering read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-terminalOrders-orderId
x-sortIndex: 8
x-methodName: getOrder
@@ -2127,7 +2141,8 @@ paths:
\ 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\u2014Terminal ordering read and write"
* Management API\u2014Terminal ordering read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-companies-companyId-terminalOrders-orderId
x-sortIndex: 9
x-methodName: updateOrder
@@ -2205,7 +2220,8 @@ paths:
\ 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\n\
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"
* Management API\u2014Terminal ordering read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: post-companies-companyId-terminalOrders-orderId-cancel
x-sortIndex: 10
x-methodName: cancelOrder
@@ -2274,7 +2290,8 @@ paths:
\ 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\u2014Terminal ordering read\n* Management API\u2014Terminal\
\ ordering read and write"
\ ordering read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-terminalProducts
x-sortIndex: 2
x-methodName: listTerminalProducts
@@ -2370,7 +2387,8 @@ paths:
* Management API\u2014Terminal settings read\n* Management API\u2014Terminal\
\ 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\u2014\
Terminal settings Advanced read and write"
Terminal settings Advanced read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-terminalSettings
x-sortIndex: 1
x-methodName: getTerminalSettings
@@ -2441,7 +2459,8 @@ paths:
* Management API\u2014Terminal 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\u2014\
Terminal settings Advanced read and write"
Terminal settings Advanced read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-companies-companyId-terminalSettings
x-sortIndex: 3
x-methodName: updateTerminalSettings
@@ -4673,7 +4692,8 @@ paths:
\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\u2014Terminal ordering read\n* Management API\u2014Terminal\
\ ordering read and write"
\ ordering read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-merchants-merchantId-billingEntities
x-sortIndex: 3
x-methodName: listBillingEntities
@@ -5006,6 +5026,9 @@ paths:
requestBody:
content:
application/json:
examples:
update-payment-method:
$ref: '#/components/examples/patch-merchants-merchantId-paymentMethodSettings-paymentMethodId-update-payment-method'
schema:
$ref: '#/components/schemas/UpdatePaymentMethodInfo'
parameters:
@@ -5025,6 +5048,9 @@ paths:
'200':
content:
application/json:
examples:
update-payment-method:
$ref: '#/components/examples/patch-merchants-merchantId-paymentMethodSettings-paymentMethodId-update-payment-method-200'
schema:
$ref: '#/components/schemas/PaymentMethod'
description: OK - the request has succeeded.
@@ -5565,7 +5591,8 @@ paths:
\ 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\u2014Terminal ordering read\n* Management API\u2014Terminal\
\ ordering read and write"
\ ordering read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-merchants-merchantId-shippingLocations
x-sortIndex: 4
x-methodName: listShippingLocations
@@ -5650,7 +5677,8 @@ paths:
\ 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\u2014Terminal ordering read and write"
* Management API\u2014Terminal ordering read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: post-merchants-merchantId-shippingLocations
x-sortIndex: 5
x-methodName: createShippingLocation
@@ -6424,7 +6452,9 @@ paths:
\ 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\u2014Stores read\n* Management API\u2014Stores read and write"
* Management API\u2014Stores read\n* Management API\u2014Stores read and write\n\
\nIn the live environment, requests to this endpoint are subject to [rate\
\ limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-merchants-merchantId-stores
x-sortIndex: 1
x-methodName: listStoresByMerchantId
@@ -6508,7 +6538,8 @@ paths:
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\u2014Stores read and write"
* Management API\u2014Stores read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: post-merchants-merchantId-stores
x-sortIndex: 0
x-methodName: createStoreByMerchantId
@@ -6585,7 +6616,8 @@ paths:
\ 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\u2014Terminal settings read\n* Management API\u2014Terminal\
\ settings read and write"
\ settings read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-merchants-merchantId-stores-reference-terminalLogos
x-sortIndex: 2
x-methodName: getTerminalLogo
@@ -6668,7 +6700,8 @@ paths:
\ 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\u2014Terminal settings read and write"
* Management API\u2014Terminal settings read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-merchants-merchantId-stores-reference-terminalLogos
x-sortIndex: 4
x-methodName: updateTerminalLogo
@@ -6764,7 +6797,8 @@ paths:
* Management API\u2014Terminal settings read\n* Management API\u2014Terminal\
\ 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\u2014\
Terminal settings Advanced read and write"
Terminal settings Advanced read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-merchants-merchantId-stores-reference-terminalSettings
x-sortIndex: 1
x-methodName: getTerminalSettings
@@ -6844,7 +6878,8 @@ paths:
* Management API\u2014Terminal 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\u2014\
Terminal settings Advanced read and write"
Terminal settings Advanced read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-merchants-merchantId-stores-reference-terminalSettings
x-sortIndex: 3
x-methodName: updateTerminalSettings
@@ -6926,7 +6961,9 @@ paths:
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\u2014Stores read\n* Management API\u2014Stores read and write"
* Management API\u2014Stores read\n* Management API\u2014Stores read and write\n\
\nIn the live environment, requests to this endpoint are subject to [rate\
\ limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-merchants-merchantId-stores-storeId
x-sortIndex: 2
x-methodName: getStore
@@ -6996,7 +7033,8 @@ paths:
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\u2014Stores read and write"
* Management API\u2014Stores read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-merchants-merchantId-stores-storeId
x-sortIndex: 3
x-methodName: updateStore
@@ -7084,7 +7122,8 @@ paths:
\ 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\u2014Terminal settings read\n* Management API\u2014Terminal\
\ settings read and write"
\ settings read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-merchants-merchantId-terminalLogos
x-sortIndex: 2
x-methodName: getTerminalLogo
@@ -7161,7 +7200,8 @@ paths:
\ 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\u2014Terminal settings read and write"
* Management API\u2014Terminal settings read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-merchants-merchantId-terminalLogos
x-sortIndex: 4
x-methodName: updateTerminalLogo
@@ -7249,7 +7289,8 @@ paths:
\ 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\u2014Terminal ordering read\n* Management API\u2014Terminal\
\ ordering read and write"
\ ordering read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-merchants-merchantId-terminalModels
x-sortIndex: 1
x-methodName: listTerminalModels
@@ -7315,7 +7356,8 @@ paths:
\ 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\u2014Terminal ordering read\n* Management API\u2014Terminal\
\ ordering read and write"
\ ordering read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-merchants-merchantId-terminalOrders
x-sortIndex: 7
x-methodName: listOrders
@@ -7408,7 +7450,8 @@ paths:
* Management API\u2014Terminal 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."
\ in your Customer Area.\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: post-merchants-merchantId-terminalOrders
x-sortIndex: 6
x-methodName: createOrder
@@ -7482,7 +7525,8 @@ paths:
\ 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\u2014Terminal ordering read\n* Management API\u2014Terminal\
\ ordering read and write"
\ ordering read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-merchants-merchantId-terminalOrders-orderId
x-sortIndex: 8
x-methodName: getOrder
@@ -7557,7 +7601,8 @@ paths:
\ 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\u2014Terminal ordering read and write"
* Management API\u2014Terminal ordering read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-merchants-merchantId-terminalOrders-orderId
x-sortIndex: 9
x-methodName: updateOrder
@@ -7638,7 +7683,8 @@ paths:
\ 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\n\
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"
* Management API\u2014Terminal ordering read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: post-merchants-merchantId-terminalOrders-orderId-cancel
x-sortIndex: 10
x-methodName: cancelOrder
@@ -7710,7 +7756,8 @@ paths:
\ parts that the merchant account identified in the path has access to.\n\n\
To 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\u2014Terminal ordering read\n* Management API\u2014Terminal\
\ ordering read and write"
\ ordering read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-merchants-merchantId-terminalProducts
x-sortIndex: 2
x-methodName: listTerminalProducts
@@ -7807,7 +7854,10 @@ paths:
\ 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\u2014Terminal settings read\n* Management API\u2014Terminal\
\ settings read and write"
\ 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\u2014\
Terminal settings Advanced read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-merchants-merchantId-terminalSettings
x-sortIndex: 1
x-methodName: getTerminalSettings
@@ -7878,7 +7928,11 @@ paths:
\ 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\u2014Terminal settings read and write"
* Management API\u2014Terminal settings read and write\n\n\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\u2014\
Terminal settings Advanced read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-merchants-merchantId-terminalSettings
x-sortIndex: 3
x-methodName: updateTerminalSettings
@@ -8783,7 +8837,9 @@ paths:
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\u2014Stores read\n* Management API\u2014Stores read and write"
* Management API\u2014Stores read\n* Management API\u2014Stores read and write\n\
\nIn the live environment, requests to this endpoint are subject to [rate\
\ limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-stores
x-sortIndex: 4
x-methodName: listStores
@@ -8864,7 +8920,8 @@ paths:
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\u2014Stores read and write"
* Management API\u2014Stores read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: post-stores
x-sortIndex: 5
x-methodName: createStore
@@ -8926,7 +8983,9 @@ paths:
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\u2014Stores read\n* Management API\u2014Stores read and write"
* Management API\u2014Stores read\n* Management API\u2014Stores read and write\n\
\nIn the live environment, requests to this endpoint are subject to [rate\
\ limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-stores-storeId
x-sortIndex: 6
x-methodName: getStoreById
@@ -8987,7 +9046,8 @@ paths:
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\u2014Stores read and write"
* Management API\u2014Stores read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-stores-storeId
x-sortIndex: 7
x-methodName: updateStoreById
@@ -9063,7 +9123,8 @@ paths:
\ 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\u2014Terminal settings read\n* Management API\u2014Terminal\
\ settings read and write"
\ settings read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-stores-storeId-terminalLogos
x-sortIndex: 2
x-methodName: getTerminalLogoByStoreId
@@ -9137,7 +9198,8 @@ paths:
\ 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\u2014Terminal settings read and write"
* Management API\u2014Terminal settings read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-stores-storeId-terminalLogos
x-sortIndex: 4
x-methodName: updateTerminalLogoByStoreId
@@ -9224,7 +9286,8 @@ paths:
* Management API\u2014Terminal settings read\n* Management API\u2014Terminal\
\ 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\u2014\
Terminal settings Advanced read and write"
Terminal settings Advanced read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-stores-storeId-terminalSettings
x-sortIndex: 1
x-methodName: getTerminalSettingsByStoreId
@@ -9295,7 +9358,8 @@ paths:
* Management API\u2014Terminal 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\u2014\
Terminal settings Advanced read and write"
Terminal settings Advanced read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-stores-storeId-terminalSettings
x-sortIndex: 3
x-methodName: updateTerminalSettingsByStoreId
@@ -9369,7 +9433,8 @@ paths:
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 \u2014 Terminal actions read"
* Management API \u2014 Terminal actions read\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-terminals
x-sortIndex: 1
x-methodName: listTerminals
@@ -9490,7 +9555,8 @@ paths:
\ 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\n\
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"
* Management API\u2014Terminal actions read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: post-terminals-scheduleActions
x-sortIndex: 1
x-methodName: createTerminalAction
@@ -9564,7 +9630,8 @@ paths:
\ 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\u2014Terminal settings read\n* Management API\u2014Terminal\
\ settings read and write"
\ settings read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-terminals-terminalId-terminalLogos
x-sortIndex: 4
x-methodName: getTerminalLogo
@@ -9627,7 +9694,8 @@ paths:
* 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\u2014Terminal settings read and write"
* Management API\u2014Terminal settings read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-terminals-terminalId-terminalLogos
x-sortIndex: 6
x-methodName: updateLogo
@@ -9704,7 +9772,8 @@ paths:
* Management API\u2014Terminal settings read\n* Management API\u2014Terminal\
\ 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\u2014\
Terminal settings Advanced read and write"
Terminal settings Advanced read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-terminals-terminalId-terminalSettings
x-sortIndex: 3
x-methodName: getTerminalSettings
@@ -9773,7 +9842,8 @@ paths:
* Management API\u2014Terminal 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\u2014\
Terminal settings Advanced read and write"
Terminal settings Advanced read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-terminals-terminalId-terminalSettings
x-sortIndex: 5
x-methodName: updateTerminalSettings
@@ -9996,24 +10066,29 @@ components:
additionalProperties: false
properties:
midNumber:
description: "MID (Merchant ID) number. Format: 10 numeric characters.\n\
\ Must be provided only when requesting `gatewayContract` or `paymentDesignatorContract`\
description: "Merchant ID (MID) number. Format: 10 numeric characters.\n\
\ You must provide this field when you request `gatewayContract` or `paymentDesignatorContract`\
\ service levels."
maxLength: 10
type: string
reuseMidNumber:
default: false
description: "Indicates whether the Amex Merchant ID is reused from a previously\
\ setup Amex payment method. \nThis is only applicable for `gatewayContract`\
\ and `paymentDesignatorContract` service levels. \nThe default value\
\ is `false`."
\ is **false**."
type: boolean
serviceLevel:
description: "Specifies the service level (settlement type) of this payment\
\ method. Possible values:\n* **noContract** \u2014 Adyen holds the contract\
\ with American Express.\n* **gatewayContract** \u2014 American Express\
\ receives the settlement and handles disputes. They then pay out to the\
\ merchant directly.\n* **paymentDesignatorContract** \u2014 Adyen receives\
\ the settlement and handles disputes. Adyen then pays out to the merchant."
description: 'Specifies the service level (settlement type) of this payment
method. Possible values:
* **noContract**: Adyen holds the contract with American Express.
* **gatewayContract**: American Express receives the settlement and handles
disputes, then pays out to you or your sub-merchant directly.
* **paymentDesignatorContract**: Adyen receives the settlement, and handles
disputes and payouts.'
enum:
- noContract
- gatewayContract
@@ -11435,6 +11510,44 @@ components:
\ \n* **AU**\n* **EU**\n* **US**"
type: string
type: object
DinersInfo:
additionalProperties: false
properties:
midNumber:
description: 'MID (Merchant ID) number. Required for merchants operating
in Japan.
Format: 14 numeric characters.'
maxLength: 14
type: string
reuseMidNumber:
default: false
description: 'Indicates whether the JCB Merchant ID is reused from a previously
configured JCB payment method.
The default value is **false**.
For merchants operating in Japan, this field is required and must be set
to **true**.'
type: boolean
serviceLevel:
description: "Specifies the service level (settlement type) of this payment\
\ method. Required for merchants operating in Japan. Possible values:\n\
\ * **noContract**: Adyen holds the contract with JCB.\n * **gatewayContract**:\
\ JCB receives the settlement and handles disputes, then pays out to you\
\ or your sub-merchant directly."
enum:
- noContract
- gatewayContract
type: string
transactionDescription:
description: 'Information regarding the transaction description.
> You cannot configure the transaction description in the test environment.'
$ref: '#/components/schemas/TransactionDescriptionInfo'
required:
- reuseMidNumber
type: object
EventUrl:
additionalProperties: false
properties:
@@ -11672,21 +11785,26 @@ components:
additionalProperties: false
properties:
midNumber:
description: "MID (Merchant ID) number. Format: 10 numeric characters.\n\
\ Must be provided for both `noContract` and `gatewayContract` service\
\ levels."
description: 'MID (Merchant ID) number. Required for merchants operating
in Japan.Format: 14 numeric characters.'
maxLength: 14
type: string
reuseMidNumber:
default: false
description: "Indicates whether the JCB Merchant ID is reused from a previously\
\ setup JCB payment method. \nThis is applicable for both `noContract`\
\ and `gatewayContract` service levels. \nThe default value is `false`."
\ setup JCB payment method. \nThe default value is **false**.For merchants\
\ operating in Japan, this field is required and must be set to **true**."
type: boolean
serviceLevel:
description: "Specifies the service level (settlement type) of this payment\
\ method. Possible values:\n* **noContract** \u2014 Adyen holds the contract\
\ with JCB.\n* **gatewayContract** \u2014 JCB receives the settlement\
\ and handles disputes. They then pay out to the merchant directly."
description: 'Specifies the service level (settlement type) of this payment
method. Required for merchants operating in Japan.
Possible values:
* **noContract**: Adyen holds the contract with JCB.
* **gatewayContract**: JCB receives the settlement and handles disputes,
then pays out to you or your sub-merchant directly.'
enum:
- noContract
- gatewayContract
@@ -11696,8 +11814,6 @@ components:
> You cannot configure the transaction description in the test environment.'
$ref: '#/components/schemas/TransactionDescriptionInfo'
required:
- serviceLevel
type: object
JSONObject:
type: object
@@ -12553,10 +12669,16 @@ components:
type: string
type: array
diners:
description: Diners details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
description: Diners details. For merchants operating in Japan, Diners payments
are processed through the JCB network. This means that you must include
[JCB-specific fields](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/paymentMethodSettings/(paymentMethodId)#request-jcb)
in this object.
$ref: '#/components/schemas/DinersInfo'
discover:
description: Discover details.
description: Discover details. For merchants operating in Japan, request
[Diners](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/paymentMethodSettings/(paymentMethodId)#request-diners)
payment method instead. Discover is automatically requested, together
with Diners.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
eftpos_australia:
description: Eftpos Australia details.
@@ -12584,7 +12706,12 @@ components:
description: Interac Card details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
jcb:
description: JCB details.
description: 'JCB details.
For merchants operating in Japan, `midNumber`, `reuseMidNumber`, and `serviceLevel`
fields are required.
For merchants operating outside of Japan, these fields are not required.'
$ref: '#/components/schemas/JCBInfo'
klarna:
description: Klarna details.
@@ -12703,6 +12830,7 @@ components:
items:
enum:
- accel
- affirm
- afterpaytouch
- alelo
- alipay
@@ -12830,10 +12958,16 @@ components:
type: string
type: array
diners:
description: Diners details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
description: Diners details. For merchants operating in Japan, Diners payments
are processed through the JCB network. This means that you must include
[JCB-specific fields](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/paymentMethodSettings/(paymentMethodId)#request-jcb)
in this object.
$ref: '#/components/schemas/DinersInfo'
discover:
description: Discover details.
description: Discover details. For merchants operating in Japan, request
[Diners](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/paymentMethodSettings/(paymentMethodId)#request-diners)
payment method instead. Discover is automatically requested, together
with Diners.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
eftpos_australia:
description: Eftpos Australia details.
@@ -12854,7 +12988,12 @@ components:
description: Interac Card details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
jcb:
description: JCB details.
description: 'JCB details.
For merchants operating in Japan, `midNumber`, `reuseMidNumber`, and `serviceLevel`
fields are required.
For merchants operating outside of Japan, these fields are not required.'
$ref: '#/components/schemas/JCBInfo'
klarna:
description: Klarna details.
@@ -12929,6 +13068,7 @@ components:
description: Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api).
enum:
- accel
- affirm
- afterpaytouch
- alelo
- alipay
@@ -19064,6 +19204,30 @@ components:
href: https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateClientKey
merchant:
href: https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT
patch-merchants-merchantId-paymentMethodSettings-paymentMethodId-update-payment-method:
summary: Update the currency and country details for a payment method
description: Update the currency and country details for a payment method
value:
currencies:
- EUR
countries:
- NL
patch-merchants-merchantId-paymentMethodSettings-paymentMethodId-update-payment-method-200:
summary: Currency and country details updated for the payment method
description: Currency and country details updated for the payment method
value:
mc:
transactionDescription:
doingBusinessAsName: YOUR_BUSINESS_NAME
type: fixed
id: PM322DZ243226G5LKBTGM7FBQ
type: mc
enabled: true
countries:
- NL
currencies:
- EUR
customRoutingFlags: []
patch-merchants-merchantId-splitConfigurations-splitConfigurationId-patch-splitConfiguration-description:
summary: Update split configuration description
description: Example request for updating the description of a split configuration

354
yaml/ManagementService-v3.yaml
View File

@@ -232,7 +232,8 @@ paths:
\ [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\
* Management API\u2014Android files read\n* Management API\u2014Android files\
\ read and write\n* Management API\u2014Terminal actions read\n* Management\
\ API\u2014Terminal actions read and write"
\ API\u2014Terminal actions read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-androidApps
x-sortIndex: 1
x-methodName: listAndroidApps
@@ -321,10 +322,11 @@ paths:
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\u2014Android 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."
* Management API\u2014Android files read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).\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-sortIndex: 4
@@ -387,7 +389,8 @@ paths:
\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\u2014Android files read\n* Management API\u2014Android files\
\ read and write"
\ read and write\n\nIn the live environment, requests to this endpoint are\
\ subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-androidApps-id
x-sortIndex: 3
x-methodName: getAndroidApp
@@ -450,10 +453,11 @@ paths:
summary: Reprocess Android App
description: "Reuploads the Android app identified in the path. \nTo make this\
\ request, your API credential must have this [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\
* Management API\u2014Android 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."
* Management API\u2014Android files read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).\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: patch-companies-companyId-androidApps-id
x-sortIndex: 6
@@ -525,7 +529,8 @@ paths:
\ [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\
* Management API\u2014Android files read\n* Management API\u2014Android files\
\ read and write\n* Management API\u2014Terminal actions read\n* Management\
\ API\u2014Terminal actions read and write"
\ API\u2014Terminal actions read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-androidCertificates
x-sortIndex: 2
x-methodName: listAndroidCertificates
@@ -606,7 +611,8 @@ paths:
summary: Upload Android Certificate
description: 'Uploads an Android Certificate file to Adyen.
'
In the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).'
x-addedInVersion: '3'
operationId: post-companies-companyId-androidCertificates
x-sortIndex: 5
@@ -1387,7 +1393,8 @@ paths:
\ 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\u2014Terminal ordering read\n* Management API\u2014Terminal\
\ ordering read and write"
\ ordering read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-billingEntities
x-sortIndex: 3
x-methodName: listBillingEntities
@@ -1537,7 +1544,8 @@ paths:
\ 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\u2014Terminal ordering read\n* Management API\u2014Terminal\
\ ordering read and write"
\ ordering read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-shippingLocations
x-sortIndex: 4
x-methodName: listShippingLocations
@@ -1618,7 +1626,8 @@ paths:
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\u2014Terminal ordering read and write"
* Management API\u2014Terminal ordering read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: post-companies-companyId-shippingLocations
x-sortIndex: 5
x-methodName: createShippingLocation
@@ -1690,7 +1699,8 @@ paths:
\ 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\u2014Terminal actions read\n* Management API\u2014Terminal\
\ actions read and write"
\ actions read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-terminalActions
x-sortIndex: 1
x-methodName: listTerminalActions
@@ -1783,7 +1793,8 @@ paths:
\ 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\u2014Terminal actions read\n* Management API\u2014Terminal\
\ actions read and write"
\ actions read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-terminalActions-actionId
x-sortIndex: 2
x-methodName: getTerminalAction
@@ -1856,7 +1867,8 @@ paths:
\ 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\u2014Terminal settings read\n* Management API\u2014Terminal\
\ settings read and write"
\ settings read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-terminalLogos
x-sortIndex: 2
x-methodName: getTerminalLogo
@@ -1931,7 +1943,8 @@ paths:
* 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\u2014Terminal settings read and write"
* Management API\u2014Terminal settings read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-companies-companyId-terminalLogos
x-sortIndex: 4
x-methodName: updateTerminalLogo
@@ -2016,7 +2029,8 @@ paths:
\ 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\u2014Terminal ordering read\n* Management API\u2014Terminal\
\ ordering read and write"
\ ordering read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-terminalModels
x-sortIndex: 1
x-methodName: listTerminalModels
@@ -2080,7 +2094,8 @@ paths:
\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\u2014Terminal ordering read\n* Management API\u2014Terminal\
\ ordering read and write"
\ ordering read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-terminalOrders
x-sortIndex: 7
x-methodName: listOrders
@@ -2171,7 +2186,8 @@ paths:
* Management API\u2014Terminal 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."
\ in your Customer Area.\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: post-companies-companyId-terminalOrders
x-sortIndex: 6
x-methodName: createOrder
@@ -2242,7 +2258,8 @@ paths:
\ 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\u2014Terminal ordering read\n* Management API\u2014Terminal\
\ ordering read and write"
\ ordering read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-terminalOrders-orderId
x-sortIndex: 8
x-methodName: getOrder
@@ -2314,7 +2331,8 @@ paths:
\ 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\u2014Terminal ordering read and write"
* Management API\u2014Terminal ordering read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-companies-companyId-terminalOrders-orderId
x-sortIndex: 9
x-methodName: updateOrder
@@ -2392,7 +2410,8 @@ paths:
\ 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\n\
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"
* Management API\u2014Terminal ordering read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: post-companies-companyId-terminalOrders-orderId-cancel
x-sortIndex: 10
x-methodName: cancelOrder
@@ -2461,7 +2480,8 @@ paths:
\ 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\u2014Terminal ordering read\n* Management API\u2014Terminal\
\ ordering read and write"
\ ordering read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-terminalProducts
x-sortIndex: 2
x-methodName: listTerminalProducts
@@ -2557,7 +2577,8 @@ paths:
* Management API\u2014Terminal settings read\n* Management API\u2014Terminal\
\ 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\u2014\
Terminal settings Advanced read and write"
Terminal settings Advanced read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-companies-companyId-terminalSettings
x-sortIndex: 1
x-methodName: getTerminalSettings
@@ -2628,7 +2649,8 @@ paths:
* Management API\u2014Terminal 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\u2014\
Terminal settings Advanced read and write"
Terminal settings Advanced read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-companies-companyId-terminalSettings
x-sortIndex: 3
x-methodName: updateTerminalSettings
@@ -4860,7 +4882,8 @@ paths:
\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\u2014Terminal ordering read\n* Management API\u2014Terminal\
\ ordering read and write"
\ ordering read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-merchants-merchantId-billingEntities
x-sortIndex: 3
x-methodName: listBillingEntities
@@ -5193,6 +5216,9 @@ paths:
requestBody:
content:
application/json:
examples:
update-payment-method:
$ref: '#/components/examples/patch-merchants-merchantId-paymentMethodSettings-paymentMethodId-update-payment-method'
schema:
$ref: '#/components/schemas/UpdatePaymentMethodInfo'
parameters:
@@ -5212,6 +5238,9 @@ paths:
'200':
content:
application/json:
examples:
update-payment-method:
$ref: '#/components/examples/patch-merchants-merchantId-paymentMethodSettings-paymentMethodId-update-payment-method-200'
schema:
$ref: '#/components/schemas/PaymentMethod'
description: OK - the request has succeeded.
@@ -5752,7 +5781,8 @@ paths:
\ 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\u2014Terminal ordering read\n* Management API\u2014Terminal\
\ ordering read and write"
\ ordering read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-merchants-merchantId-shippingLocations
x-sortIndex: 4
x-methodName: listShippingLocations
@@ -5837,7 +5867,8 @@ paths:
\ 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\u2014Terminal ordering read and write"
* Management API\u2014Terminal ordering read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: post-merchants-merchantId-shippingLocations
x-sortIndex: 5
x-methodName: createShippingLocation
@@ -6611,7 +6642,9 @@ paths:
\ 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\u2014Stores read\n* Management API\u2014Stores read and write"
* Management API\u2014Stores read\n* Management API\u2014Stores read and write\n\
\nIn the live environment, requests to this endpoint are subject to [rate\
\ limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-merchants-merchantId-stores
x-sortIndex: 1
x-methodName: listStoresByMerchantId
@@ -6695,7 +6728,8 @@ paths:
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\u2014Stores read and write"
* Management API\u2014Stores read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: post-merchants-merchantId-stores
x-sortIndex: 0
x-methodName: createStoreByMerchantId
@@ -6772,7 +6806,8 @@ paths:
\ 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\u2014Terminal settings read\n* Management API\u2014Terminal\
\ settings read and write"
\ settings read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-merchants-merchantId-stores-reference-terminalLogos
x-sortIndex: 2
x-methodName: getTerminalLogo
@@ -6855,7 +6890,8 @@ paths:
\ 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\u2014Terminal settings read and write"
* Management API\u2014Terminal settings read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-merchants-merchantId-stores-reference-terminalLogos
x-sortIndex: 4
x-methodName: updateTerminalLogo
@@ -6951,7 +6987,8 @@ paths:
* Management API\u2014Terminal settings read\n* Management API\u2014Terminal\
\ 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\u2014\
Terminal settings Advanced read and write"
Terminal settings Advanced read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-merchants-merchantId-stores-reference-terminalSettings
x-sortIndex: 1
x-methodName: getTerminalSettings
@@ -7031,7 +7068,8 @@ paths:
* Management API\u2014Terminal 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\u2014\
Terminal settings Advanced read and write"
Terminal settings Advanced read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-merchants-merchantId-stores-reference-terminalSettings
x-sortIndex: 3
x-methodName: updateTerminalSettings
@@ -7113,7 +7151,9 @@ paths:
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\u2014Stores read\n* Management API\u2014Stores read and write"
* Management API\u2014Stores read\n* Management API\u2014Stores read and write\n\
\nIn the live environment, requests to this endpoint are subject to [rate\
\ limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-merchants-merchantId-stores-storeId
x-sortIndex: 2
x-methodName: getStore
@@ -7183,7 +7223,8 @@ paths:
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\u2014Stores read and write"
* Management API\u2014Stores read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-merchants-merchantId-stores-storeId
x-sortIndex: 3
x-methodName: updateStore
@@ -7271,7 +7312,8 @@ paths:
\ 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\u2014Terminal settings read\n* Management API\u2014Terminal\
\ settings read and write"
\ settings read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-merchants-merchantId-terminalLogos
x-sortIndex: 2
x-methodName: getTerminalLogo
@@ -7348,7 +7390,8 @@ paths:
\ 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\u2014Terminal settings read and write"
* Management API\u2014Terminal settings read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-merchants-merchantId-terminalLogos
x-sortIndex: 4
x-methodName: updateTerminalLogo
@@ -7436,7 +7479,8 @@ paths:
\ 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\u2014Terminal ordering read\n* Management API\u2014Terminal\
\ ordering read and write"
\ ordering read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-merchants-merchantId-terminalModels
x-sortIndex: 1
x-methodName: listTerminalModels
@@ -7502,7 +7546,8 @@ paths:
\ 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\u2014Terminal ordering read\n* Management API\u2014Terminal\
\ ordering read and write"
\ ordering read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-merchants-merchantId-terminalOrders
x-sortIndex: 7
x-methodName: listOrders
@@ -7595,7 +7640,8 @@ paths:
* Management API\u2014Terminal 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."
\ in your Customer Area.\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: post-merchants-merchantId-terminalOrders
x-sortIndex: 6
x-methodName: createOrder
@@ -7669,7 +7715,8 @@ paths:
\ 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\u2014Terminal ordering read\n* Management API\u2014Terminal\
\ ordering read and write"
\ ordering read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-merchants-merchantId-terminalOrders-orderId
x-sortIndex: 8
x-methodName: getOrder
@@ -7744,7 +7791,8 @@ paths:
\ 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\u2014Terminal ordering read and write"
* Management API\u2014Terminal ordering read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-merchants-merchantId-terminalOrders-orderId
x-sortIndex: 9
x-methodName: updateOrder
@@ -7825,7 +7873,8 @@ paths:
\ 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\n\
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"
* Management API\u2014Terminal ordering read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: post-merchants-merchantId-terminalOrders-orderId-cancel
x-sortIndex: 10
x-methodName: cancelOrder
@@ -7897,7 +7946,8 @@ paths:
\ parts that the merchant account identified in the path has access to.\n\n\
To 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\u2014Terminal ordering read\n* Management API\u2014Terminal\
\ ordering read and write"
\ ordering read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-merchants-merchantId-terminalProducts
x-sortIndex: 2
x-methodName: listTerminalProducts
@@ -7994,7 +8044,10 @@ paths:
\ 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\u2014Terminal settings read\n* Management API\u2014Terminal\
\ settings read and write"
\ 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\u2014\
Terminal settings Advanced read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-merchants-merchantId-terminalSettings
x-sortIndex: 1
x-methodName: getTerminalSettings
@@ -8065,7 +8118,11 @@ paths:
\ 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\u2014Terminal settings read and write"
* Management API\u2014Terminal settings read and write\n\n\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\u2014\
Terminal settings Advanced read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-merchants-merchantId-terminalSettings
x-sortIndex: 3
x-methodName: updateTerminalSettings
@@ -8970,7 +9027,9 @@ paths:
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\u2014Stores read\n* Management API\u2014Stores read and write"
* Management API\u2014Stores read\n* Management API\u2014Stores read and write\n\
\nIn the live environment, requests to this endpoint are subject to [rate\
\ limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-stores
x-sortIndex: 4
x-methodName: listStores
@@ -9051,7 +9110,8 @@ paths:
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\u2014Stores read and write"
* Management API\u2014Stores read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: post-stores
x-sortIndex: 5
x-methodName: createStore
@@ -9113,7 +9173,9 @@ paths:
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\u2014Stores read\n* Management API\u2014Stores read and write"
* Management API\u2014Stores read\n* Management API\u2014Stores read and write\n\
\nIn the live environment, requests to this endpoint are subject to [rate\
\ limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-stores-storeId
x-sortIndex: 6
x-methodName: getStoreById
@@ -9174,7 +9236,8 @@ paths:
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\u2014Stores read and write"
* Management API\u2014Stores read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-stores-storeId
x-sortIndex: 7
x-methodName: updateStoreById
@@ -9250,7 +9313,8 @@ paths:
\ 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\u2014Terminal settings read\n* Management API\u2014Terminal\
\ settings read and write"
\ settings read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-stores-storeId-terminalLogos
x-sortIndex: 2
x-methodName: getTerminalLogoByStoreId
@@ -9324,7 +9388,8 @@ paths:
\ 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\u2014Terminal settings read and write"
* Management API\u2014Terminal settings read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-stores-storeId-terminalLogos
x-sortIndex: 4
x-methodName: updateTerminalLogoByStoreId
@@ -9411,7 +9476,8 @@ paths:
* Management API\u2014Terminal settings read\n* Management API\u2014Terminal\
\ 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\u2014\
Terminal settings Advanced read and write"
Terminal settings Advanced read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-stores-storeId-terminalSettings
x-sortIndex: 1
x-methodName: getTerminalSettingsByStoreId
@@ -9482,7 +9548,8 @@ paths:
* Management API\u2014Terminal 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\u2014\
Terminal settings Advanced read and write"
Terminal settings Advanced read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-stores-storeId-terminalSettings
x-sortIndex: 3
x-methodName: updateTerminalSettingsByStoreId
@@ -9556,7 +9623,8 @@ paths:
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 \u2014 Terminal actions read"
* Management API \u2014 Terminal actions read\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-terminals
x-sortIndex: 1
x-methodName: listTerminals
@@ -9677,7 +9745,8 @@ paths:
\ 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\n\
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"
* Management API\u2014Terminal actions read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: post-terminals-scheduleActions
x-sortIndex: 1
x-methodName: createTerminalAction
@@ -9749,7 +9818,8 @@ paths:
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\u2014Assign Terminal"
* Management API\u2014Assign Terminal\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
x-addedInVersion: '3'
operationId: post-terminals-terminalId-reassign
x-sortIndex: 2
@@ -9818,7 +9888,8 @@ paths:
\ 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\u2014Terminal settings read\n* Management API\u2014Terminal\
\ settings read and write"
\ settings read and write\n\nIn the live environment, requests to this endpoint\
\ are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-terminals-terminalId-terminalLogos
x-sortIndex: 4
x-methodName: getTerminalLogo
@@ -9881,7 +9952,8 @@ paths:
* 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\u2014Terminal settings read and write"
* Management API\u2014Terminal settings read and write\n\nIn the live environment,\
\ requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-terminals-terminalId-terminalLogos
x-sortIndex: 6
x-methodName: updateLogo
@@ -9958,7 +10030,8 @@ paths:
* Management API\u2014Terminal settings read\n* Management API\u2014Terminal\
\ 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\u2014\
Terminal settings Advanced read and write"
Terminal settings Advanced read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: get-terminals-terminalId-terminalSettings
x-sortIndex: 3
x-methodName: getTerminalSettings
@@ -10027,7 +10100,8 @@ paths:
* Management API\u2014Terminal 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\u2014\
Terminal settings Advanced read and write"
Terminal settings Advanced read and write\n\nIn the live environment, requests\
\ to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment)."
operationId: patch-terminals-terminalId-terminalSettings
x-sortIndex: 5
x-methodName: updateTerminalSettings
@@ -10250,24 +10324,29 @@ components:
additionalProperties: false
properties:
midNumber:
description: "MID (Merchant ID) number. Format: 10 numeric characters.\n\
\ Must be provided only when requesting `gatewayContract` or `paymentDesignatorContract`\
description: "Merchant ID (MID) number. Format: 10 numeric characters.\n\
\ You must provide this field when you request `gatewayContract` or `paymentDesignatorContract`\
\ service levels."
maxLength: 10
type: string
reuseMidNumber:
default: false
description: "Indicates whether the Amex Merchant ID is reused from a previously\
\ setup Amex payment method. \nThis is only applicable for `gatewayContract`\
\ and `paymentDesignatorContract` service levels. \nThe default value\
\ is `false`."
\ is **false**."
type: boolean
serviceLevel:
description: "Specifies the service level (settlement type) of this payment\
\ method. Possible values:\n* **noContract** \u2014 Adyen holds the contract\
\ with American Express.\n* **gatewayContract** \u2014 American Express\
\ receives the settlement and handles disputes. They then pay out to the\
\ merchant directly.\n* **paymentDesignatorContract** \u2014 Adyen receives\
\ the settlement and handles disputes. Adyen then pays out to the merchant."
description: 'Specifies the service level (settlement type) of this payment
method. Possible values:
* **noContract**: Adyen holds the contract with American Express.
* **gatewayContract**: American Express receives the settlement and handles
disputes, then pays out to you or your sub-merchant directly.
* **paymentDesignatorContract**: Adyen receives the settlement, and handles
disputes and payouts.'
enum:
- noContract
- gatewayContract
@@ -11714,6 +11793,44 @@ components:
\ \n* **AU**\n* **EU**\n* **US**"
type: string
type: object
DinersInfo:
additionalProperties: false
properties:
midNumber:
description: 'MID (Merchant ID) number. Required for merchants operating
in Japan.
Format: 14 numeric characters.'
maxLength: 14
type: string
reuseMidNumber:
default: false
description: 'Indicates whether the JCB Merchant ID is reused from a previously
configured JCB payment method.
The default value is **false**.
For merchants operating in Japan, this field is required and must be set
to **true**.'
type: boolean
serviceLevel:
description: "Specifies the service level (settlement type) of this payment\
\ method. Required for merchants operating in Japan. Possible values:\n\
\ * **noContract**: Adyen holds the contract with JCB.\n * **gatewayContract**:\
\ JCB receives the settlement and handles disputes, then pays out to you\
\ or your sub-merchant directly."
enum:
- noContract
- gatewayContract
type: string
transactionDescription:
description: 'Information regarding the transaction description.
> You cannot configure the transaction description in the test environment.'
$ref: '#/components/schemas/TransactionDescriptionInfo'
required:
- reuseMidNumber
type: object
EventUrl:
additionalProperties: false
properties:
@@ -11947,21 +12064,26 @@ components:
additionalProperties: false
properties:
midNumber:
description: "MID (Merchant ID) number. Format: 10 numeric characters.\n\
\ Must be provided for both `noContract` and `gatewayContract` service\
\ levels."
description: 'MID (Merchant ID) number. Required for merchants operating
in Japan.Format: 14 numeric characters.'
maxLength: 14
type: string
reuseMidNumber:
default: false
description: "Indicates whether the JCB Merchant ID is reused from a previously\
\ setup JCB payment method. \nThis is applicable for both `noContract`\
\ and `gatewayContract` service levels. \nThe default value is `false`."
\ setup JCB payment method. \nThe default value is **false**.For merchants\
\ operating in Japan, this field is required and must be set to **true**."
type: boolean
serviceLevel:
description: "Specifies the service level (settlement type) of this payment\
\ method. Possible values:\n* **noContract** \u2014 Adyen holds the contract\
\ with JCB.\n* **gatewayContract** \u2014 JCB receives the settlement\
\ and handles disputes. They then pay out to the merchant directly."
description: 'Specifies the service level (settlement type) of this payment
method. Required for merchants operating in Japan.
Possible values:
* **noContract**: Adyen holds the contract with JCB.
* **gatewayContract**: JCB receives the settlement and handles disputes,
then pays out to you or your sub-merchant directly.'
enum:
- noContract
- gatewayContract
@@ -11971,8 +12093,6 @@ components:
> You cannot configure the transaction description in the test environment.'
$ref: '#/components/schemas/TransactionDescriptionInfo'
required:
- serviceLevel
type: object
JSONObject:
type: object
@@ -12828,10 +12948,16 @@ components:
type: string
type: array
diners:
description: Diners details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
description: Diners details. For merchants operating in Japan, Diners payments
are processed through the JCB network. This means that you must include
[JCB-specific fields](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/paymentMethodSettings/(paymentMethodId)#request-jcb)
in this object.
$ref: '#/components/schemas/DinersInfo'
discover:
description: Discover details.
description: Discover details. For merchants operating in Japan, request
[Diners](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/paymentMethodSettings/(paymentMethodId)#request-diners)
payment method instead. Discover is automatically requested, together
with Diners.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
eftpos_australia:
description: Eftpos Australia details.
@@ -12859,7 +12985,12 @@ components:
description: Interac Card details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
jcb:
description: JCB details.
description: 'JCB details.
For merchants operating in Japan, `midNumber`, `reuseMidNumber`, and `serviceLevel`
fields are required.
For merchants operating outside of Japan, these fields are not required.'
$ref: '#/components/schemas/JCBInfo'
klarna:
description: Klarna details.
@@ -12981,6 +13112,7 @@ components:
items:
enum:
- accel
- affirm
- afterpaytouch
- alelo
- alipay
@@ -13108,10 +13240,16 @@ components:
type: string
type: array
diners:
description: Diners details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
description: Diners details. For merchants operating in Japan, Diners payments
are processed through the JCB network. This means that you must include
[JCB-specific fields](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/paymentMethodSettings/(paymentMethodId)#request-jcb)
in this object.
$ref: '#/components/schemas/DinersInfo'
discover:
description: Discover details.
description: Discover details. For merchants operating in Japan, request
[Diners](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/paymentMethodSettings/(paymentMethodId)#request-diners)
payment method instead. Discover is automatically requested, together
with Diners.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
eftpos_australia:
description: Eftpos Australia details.
@@ -13132,7 +13270,12 @@ components:
description: Interac Card details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
jcb:
description: JCB details.
description: 'JCB details.
For merchants operating in Japan, `midNumber`, `reuseMidNumber`, and `serviceLevel`
fields are required.
For merchants operating outside of Japan, these fields are not required.'
$ref: '#/components/schemas/JCBInfo'
klarna:
description: Klarna details.
@@ -13210,6 +13353,7 @@ components:
description: Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api).
enum:
- accel
- affirm
- afterpaytouch
- alelo
- alipay
@@ -19516,6 +19660,30 @@ components:
href: https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateClientKey
merchant:
href: https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT
patch-merchants-merchantId-paymentMethodSettings-paymentMethodId-update-payment-method:
summary: Update the currency and country details for a payment method
description: Update the currency and country details for a payment method
value:
currencies:
- EUR
countries:
- NL
patch-merchants-merchantId-paymentMethodSettings-paymentMethodId-update-payment-method-200:
summary: Currency and country details updated for the payment method
description: Currency and country details updated for the payment method
value:
mc:
transactionDescription:
doingBusinessAsName: YOUR_BUSINESS_NAME
type: fixed
id: PM322DZ243226G5LKBTGM7FBQ
type: mc
enabled: true
countries:
- NL
currencies:
- EUR
customRoutingFlags: []
patch-merchants-merchantId-splitConfigurations-splitConfigurationId-patch-splitConfiguration-description:
summary: Update split configuration description
description: Example request for updating the description of a split configuration