jlengrand/adyen-postman
1
0
Fork 0
mirror of https://github.com/gcatanese/adyen-postman.git synced 2026-03-10 08:01:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
b9aec08a9282829382e0e53a73ae21307ab8d7c4
adyen-postman/postman/ManagementService-v3.json
AdyenAutomationBot b9aec08a92 Update latest definitions files
2023-10-18 14:04:15 +00:00

8242 lines
563 KiB
JSON
Raw Blame History

{
"info": {
"name": "Management API (v3)",
"description": {
"content": "Configure and manage your Adyen company and merchant accounts, stores, and payment terminals.\n## Authentication\nEach request to the Management API must be signed with an API key. [Generate your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) in the Customer Area and then set this key to the `X-API-Key` header value.\n\nTo access the live endpoints, you need to generate a new API key in your live Customer Area.\n## Versioning\n\nManagement API handles versioning as part of the endpoint URL. For example, to send a request to this version of the `/companies/{companyId}/webhooks` endpoint, use:\n\n```text\nhttps://management-test.adyen.com/v3/companies/{companyId}/webhooks\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area. Use this API key to make requests to:\n\n```text\nhttps://management-live.adyen.com/v3\n```",
"type": "text/markdown"
},
"version": "3",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "API key - merchant level",
"item": [
{
"name": "/merchants/:merchantId/apiCredentials/:apiCredentialId/generateApiKey",
"description": "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write",
"item": [
{
"name": "Generate new API key",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/generateApiKey",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"apiCredentials",
":apiCredentialId",
"generateApiKey"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "apiCredentialId",
"value": "",
"description": "Unique identifier of the API credential."
}
],
"query": [
]
},
"description": "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write"
}
}
]
}
]
},
{
"name": "Account - merchant level",
"item": [
{
"name": "/merchants",
"description": "Returns the list of merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read",
"item": [
{
"name": "Get a list of merchant accounts",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants"
],
"variable": [
],
"query": [
{
"key": "pageNumber",
"value": "56"
},
{
"key": "pageSize",
"value": "56"
}
]
},
"description": "Returns the list of merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read"
}
}
]
},
{
"name": "/merchants/:merchantId",
"description": "Returns the merchant account specified in the path. Your API credential must have access to the merchant account. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read",
"item": [
{
"name": "Get a merchant account",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
]
},
"description": "Returns the merchant account specified in the path. Your API credential must have access to the merchant account. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read"
}
}
]
},
{
"name": "/merchants",
"description": "Creates a merchant account for the company account specified in the request. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Accounts read and write",
"item": [
{
"name": "Create a merchant account for an Adyen for Platforms Manage integration",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"companyId\" : \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"legalEntityId\" : \"YOUR_LEGAL_ENTITY_ID\",\n \"businessLineId\" : \"YOUR_BUSINESS_LINE_ID\",\n \"description\" : \"YOUR_DESCRIPTION\",\n \"reference\" : \"YOUR_OWN_REFERENCE\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants"
],
"variable": [
],
"query": [
]
},
"description": "Creates a merchant account for the company account specified in the request. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Accounts read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/activate",
"description": "Sends a request to activate the merchant account identified in the path. You get the result of the activation asynchronously through a [`merchant.updated`](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.updated) webhook. Once the merchant account is activated, you can start using it to accept payments and payouts. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Accounts read and write",
"item": [
{
"name": "Request to activate a merchant account",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/activate",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"activate"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
]
},
"description": "Sends a request to activate the merchant account identified in the path. You get the result of the activation asynchronously through a [`merchant.updated`](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.updated) webhook. Once the merchant account is activated, you can start using it to accept payments and payouts. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Accounts read and write"
}
}
]
}
]
},
{
"name": "Split configuration - merchant level",
"item": [
{
"name": "/merchants/:merchantId/splitConfigurations/:splitConfigurationId",
"description": "Deletes the split configuration specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write",
"item": [
{
"name": "Delete a split configuration",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"splitConfigurations",
":splitConfigurationId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "splitConfigurationId",
"value": "",
"description": "The unique identifier of the split configuration."
}
],
"query": [
]
},
"description": "Deletes the split configuration specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId",
"description": "Deletes the split configuration rule specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write",
"item": [
{
"name": "Delete a split configuration rule",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"splitConfigurations",
":splitConfigurationId",
"rules",
":ruleId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "splitConfigurationId",
"value": "",
"description": "The unique identifier of the split configuration."
},
{
"key": "ruleId",
"value": "",
"description": ""
}
],
"query": [
]
},
"description": "Deletes the split configuration rule specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/splitConfigurations",
"description": "Returns the list of split configurations for the merchant account. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write",
"item": [
{
"name": "Get a list of split configurations",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"splitConfigurations"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
]
},
"description": "Returns the list of split configurations for the merchant account. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/splitConfigurations/:splitConfigurationId",
"description": "Returns the split configuration specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write",
"item": [
{
"name": "Get a split configuration",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"splitConfigurations",
":splitConfigurationId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "splitConfigurationId",
"value": "",
"description": "The unique identifier of the split configuration."
}
],
"query": [
]
},
"description": "Returns the split configuration specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/splitConfigurations/:splitConfigurationId",
"description": "Changes the description of the split configuration specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write",
"item": [
{
"name": "Update split configuration description",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\" : \"Updated description for the split configuration\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"splitConfigurations",
":splitConfigurationId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "splitConfigurationId",
"value": "",
"description": "The unique identifier of the split configuration."
}
],
"query": [
]
},
"description": "Changes the description of the split configuration specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId",
"description": "Changes the conditions of the split configuration rule specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write",
"item": [
{
"name": "Update the conditions in split configuration rule",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"currency\" : \"EUR\",\n \"fundingSource\" : \"ANY\",\n \"paymentMethod\" : \"visa\",\n \"shopperInteraction\" : \"ANY\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"splitConfigurations",
":splitConfigurationId",
"rules",
":ruleId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "splitConfigurationId",
"value": "",
"description": "The identifier of the split configuration."
},
{
"key": "ruleId",
"value": "",
"description": "The unique identifier of the split configuration rule."
}
],
"query": [
]
},
"description": "Changes the conditions of the split configuration rule specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId/splitLogic/:splitLogicId",
"description": "Changes the split logic specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write",
"item": [
{
"name": "Update the split logic",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"additionalCommission\" : {\n \"fixedAmount\" : 100,\n \"variablePercentage\" : 0,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n },\n \"chargeback\" : \"deductFromLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 100,\n \"variablePercentage\" : 100\n },\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"remainder\" : \"addToLiableAccount\",\n \"tip\" : \"addToLiableAccount\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId/splitLogic/:splitLogicId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"splitConfigurations",
":splitConfigurationId",
"rules",
":ruleId",
"splitLogic",
":splitLogicId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "splitConfigurationId",
"value": "",
"description": "The unique identifier of the split configuration."
},
{
"key": "ruleId",
"value": "",
"description": "The unique identifier of the split configuration rule."
},
{
"key": "splitLogicId",
"value": "",
"description": "The unique identifier of the split configuration split."
}
],
"query": [
]
},
"description": "Changes the split logic specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/splitConfigurations",
"description": "Creates a split configuration for the merchant account specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write",
"item": [
{
"name": "Create a split configuration",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\" : \"Your description for the split configuration\",\n \"rules\" : [ {\n \"paymentMethod\" : \"ANY\",\n \"shopperInteraction\" : \"ANY\",\n \"fundingSource\" : \"ANY\",\n \"currency\" : \"ANY\",\n \"splitLogic\" : {\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"chargeback\" : \"deductFromLiableAccount\",\n \"tip\" : \"addToOneBalanceAccount\",\n \"remainder\" : \"addToOneBalanceAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n }\n }\n } ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"splitConfigurations"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
]
},
"description": "Creates a split configuration for the merchant account specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/splitConfigurations/:splitConfigurationId",
"description": "Creates a rule in the split configuration specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write",
"item": [
{
"name": "Add rule to a split configuration",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"paymentMethod\" : \"visa\",\n \"shopperInteraction\" : \"POS\",\n \"fundingSource\" : \"ANY\",\n \"currency\" : \"USD\",\n \"splitLogic\" : {\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"chargeback\" : \"deductFromLiableAccount\",\n \"tip\" : \"addToOneBalanceAccount\",\n \"remainder\" : \"addToLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"splitConfigurations",
":splitConfigurationId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "splitConfigurationId",
"value": "",
"description": "The unique identifier of the split configuration."
}
],
"query": [
]
},
"description": "Creates a rule in the split configuration specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write"
}
}
]
}
]
},
{
"name": "Allowed origins - company level",
"item": [
{
"name": "/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins/:originId",
"description": "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. As soon as an allowed origin is removed, we no longer accept client-side requests from that domain. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write",
"item": [
{
"name": "Delete an allowed origin",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins/:originId",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"apiCredentials",
":apiCredentialId",
"allowedOrigins",
":originId"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
},
{
"key": "apiCredentialId",
"value": "",
"description": "Unique identifier of the API credential."
},
{
"key": "originId",
"value": "",
"description": "Unique identifier of the allowed origin."
}
],
"query": [
]
},
"description": "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. As soon as an allowed origin is removed, we no longer accept client-side requests from that domain. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write"
}
}
]
},
{
"name": "/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins",
"description": "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write",
"item": [
{
"name": "Get a list of allowed origins",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"apiCredentials",
":apiCredentialId",
"allowedOrigins"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
},
{
"key": "apiCredentialId",
"value": "",
"description": "Unique identifier of the API credential."
}
],
"query": [
]
},
"description": "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write"
}
}
]
},
{
"name": "/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins/:originId",
"description": "Returns the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write",
"item": [
{
"name": "Get an allowed origin",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins/:originId",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"apiCredentials",
":apiCredentialId",
"allowedOrigins",
":originId"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
},
{
"key": "apiCredentialId",
"value": "",
"description": "Unique identifier of the API credential."
},
{
"key": "originId",
"value": "",
"description": "Unique identifier of the allowed origin."
}
],
"query": [
]
},
"description": "Returns the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write"
}
}
]
},
{
"name": "/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins",
"description": "Adds a new [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) to the API credential's list of allowed origins. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write",
"item": [
{
"name": "Add an allowed origin for the API credential",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"domain\" : \"https://www.eu.mystore.com\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"apiCredentials",
":apiCredentialId",
"allowedOrigins"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
},
{
"key": "apiCredentialId",
"value": "",
"description": "Unique identifier of the API credential."
}
],
"query": [
]
},
"description": "Adds a new [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) to the API credential's list of allowed origins. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write"
}
}
]
}
]
},
{
"name": "API key - company level",
"item": [
{
"name": "/companies/:companyId/apiCredentials/:apiCredentialId/generateApiKey",
"description": "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write",
"item": [
{
"name": "Generate new API key",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/generateApiKey",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"apiCredentials",
":apiCredentialId",
"generateApiKey"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
},
{
"key": "apiCredentialId",
"value": "",
"description": "Unique identifier of the API credential."
}
],
"query": [
]
},
"description": "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write"
}
}
]
}
]
},
{
"name": "Client key - company level",
"item": [
{
"name": "/companies/:companyId/apiCredentials/:apiCredentialId/generateClientKey",
"description": "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write",
"item": [
{
"name": "Generate new client key",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/generateClientKey",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"apiCredentials",
":apiCredentialId",
"generateClientKey"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
},
{
"key": "apiCredentialId",
"value": "",
"description": "Unique identifier of the API credential."
}
],
"query": [
]
},
"description": "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write"
}
}
]
}
]
},
{
"name": "Users - company level",
"item": [
{
"name": "/companies/:companyId/users",
"description": "Returns the list of users for the `companyId` identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ",
"item": [
{
"name": "Get a list of users",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/users",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"users"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
}
],
"query": [
{
"key": "pageNumber",
"value": "56"
},
{
"key": "pageSize",
"value": "56"
},
{
"key": "username",
"value": "username_example"
}
]
},
"description": "Returns the list of users for the `companyId` identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write "
}
}
]
},
{
"name": "/companies/:companyId/users/:userId",
"description": "Returns user details for the `userId` and the `companyId` identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ",
"item": [
{
"name": "Get user details",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/users/:userId",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"users",
":userId"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
},
{
"key": "userId",
"value": "",
"description": "The unique identifier of the user."
}
],
"query": [
]
},
"description": "Returns user details for the `userId` and the `companyId` identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write "
}
}
]
},
{
"name": "/companies/:companyId/users/:userId",
"description": "Updates user details for the `userId` and the `companyId` identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ",
"item": [
{
"name": "Update user details",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"accountGroups\": \"<string>\",\n \"active\": \"<string>\",\n \"associatedMerchantAccounts\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"roles\": \"<string>\",\n \"timeZoneCode\": \"<string>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/users/:userId",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"users",
":userId"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
},
{
"key": "userId",
"value": "",
"description": "The unique identifier of the user."
}
],
"query": [
]
},
"description": "Updates user details for the `userId` and the `companyId` identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write "
}
}
]
},
{
"name": "/companies/:companyId/users",
"description": "Creates the user for the `companyId` identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ",
"item": [
{
"name": "Create a user",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"username\" : \"johnsmith\",\n \"email\" : \"john.smith@example.com\",\n \"timeZoneCode\" : \"Europe/Amsterdam\",\n \"roles\" : [ \"Merchant standard role\", \"Merchant admin\" ],\n \"associatedMerchantAccounts\" : [ \"{{YOUR_MERCHANT_ACCOUNT}}\" ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/users",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"users"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
}
],
"query": [
]
},
"description": "Creates the user for the `companyId` identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write "
}
}
]
}
]
},
{
"name": "Terminal actions - terminal level",
"item": [
{
"name": "/terminals/scheduleActions",
"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. The following restrictions apply: * 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. * 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. * 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. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal actions read and write",
"item": [
{
"name": "Schedule installing an Android app",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"terminalIds\" : [ \"S1E-000150183300032\", \"S1E-000150183300033\", \"S1F2-000150183300034\" ],\n \"storeId\" : \"\",\n \"scheduledAt\" : \"2021-12-12T20:21:22-0100\",\n \"actionDetails\" : {\n \"type\" : \"InstallAndroidApp\",\n \"appId\" : \"ANDA422LZ223223K5F694GCCF732K8\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/terminals/scheduleActions",
"host": [
"{{baseUrl}}"
],
"path": [
"terminals",
"scheduleActions"
],
"variable": [
],
"query": [
]
},
"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. The following restrictions apply: * 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. * 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. * 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. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal actions read and write"
}
},
{
"name": "Schedule uninstalling an Android certificate",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"terminalIds\" : [ \"S1E-000150183300032\", \"S1E-000150183300033\", \"S1F2-000150183300034\" ],\n \"storeId\" : \"\",\n \"scheduledAt\" : \"2021-12-12T20:21:22-0100\",\n \"actionDetails\" : {\n \"type\" : \"UninstallAndroidCertificate\",\n \"certificateId\" : \"ANDC422LZ223223K5F78NVN9SL4VPH\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/terminals/scheduleActions",
"host": [
"{{baseUrl}}"
],
"path": [
"terminals",
"scheduleActions"
],
"variable": [
],
"query": [
]
},
"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. The following restrictions apply: * 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. * 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. * 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. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal actions read and write"
}
},
{
"name": "Invalid terminal ID in the request",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"terminalIds\" : [ \"S1E-000150183300032\", \"S1E-000150183300033\", \"S1F2-000150183300034\" ],\n \"storeId\" : \"\",\n \"scheduledAt\" : \"2021-12-11T20:21:22-0100\",\n \"actionDetails\" : {\n \"type\" : \"InstallAndroidApp\",\n \"appId\" : \"ANDA422LZ223223K5F694GCCF621J7\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/terminals/scheduleActions",
"host": [
"{{baseUrl}}"
],
"path": [
"terminals",
"scheduleActions"
],
"variable": [
],
"query": [
]
},
"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. The following restrictions apply: * 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. * 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. * 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. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal actions read and write"
}
}
]
}
]
},
{
"name": "Terminal settings - terminal level",
"item": [
{
"name": "/terminals/:terminalId/terminalLogos",
"description": "Returns the logo that is configured for the payment terminal identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write",
"item": [
{
"name": "Get the terminal logo",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/terminals/:terminalId/terminalLogos",
"host": [
"{{baseUrl}}"
],
"path": [
"terminals",
":terminalId",
"terminalLogos"
],
"variable": [
{
"key": "terminalId",
"value": "",
"description": "The unique identifier of the payment terminal."
}
],
"query": [
]
},
"description": "Returns the logo that is configured for the payment terminal identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write"
}
}
]
},
{
"name": "/terminals/:terminalId/terminalSettings",
"description": "Returns the settings that are configured for the payment terminal identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write",
"item": [
{
"name": "Get terminal settings",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/terminals/:terminalId/terminalSettings",
"host": [
"{{baseUrl}}"
],
"path": [
"terminals",
":terminalId",
"terminalSettings"
],
"variable": [
{
"key": "terminalId",
"value": "",
"description": "The unique identifier of the payment terminal."
}
],
"query": [
]
},
"description": "Returns the settings that are configured for the payment terminal identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write"
}
}
]
},
{
"name": "/terminals/:terminalId/terminalLogos",
"description": "Updates the logo for the payment terminal identified in the path. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (store, merchant account, or company account), specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write",
"item": [
{
"name": "Remove logo to restore the logo from a higher level",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\" : \"\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/terminals/:terminalId/terminalLogos",
"host": [
"{{baseUrl}}"
],
"path": [
"terminals",
":terminalId",
"terminalLogos"
],
"variable": [
{
"key": "terminalId",
"value": "",
"description": "The unique identifier of the payment terminal."
}
],
"query": [
]
},
"description": "Updates the logo for the payment terminal identified in the path. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (store, merchant account, or company account), specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write"
}
},
{
"name": "Upload terminal logo",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/terminals/:terminalId/terminalLogos",
"host": [
"{{baseUrl}}"
],
"path": [
"terminals",
":terminalId",
"terminalLogos"
],
"variable": [
{
"key": "terminalId",
"value": "",
"description": "The unique identifier of the payment terminal."
}
],
"query": [
]
},
"description": "Updates the logo for the payment terminal identified in the path. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (store, merchant account, or company account), specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write"
}
}
]
},
{
"name": "/terminals/:terminalId/terminalSettings",
"description": "Updates the settings that are configured for the payment terminal identified in the path. * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write",
"item": [
{
"name": "Add EAP-PEAP and PSK Wi-Fi profiles",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/terminals/:terminalId/terminalSettings",
"host": [
"{{baseUrl}}"
],
"path": [
"terminals",
":terminalId",
"terminalSettings"
],
"variable": [
{
"key": "terminalId",
"value": "",
"description": "The unique identifier of the payment terminal."
}
],
"query": [
]
},
"description": "Updates the settings that are configured for the payment terminal identified in the path. * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write"
}
},
{
"name": "Add EAP-TLS Wi-Fi profile",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/terminals/:terminalId/terminalSettings",
"host": [
"{{baseUrl}}"
],
"path": [
"terminals",
":terminalId",
"terminalSettings"
],
"variable": [
{
"key": "terminalId",
"value": "",
"description": "The unique identifier of the payment terminal."
}
],
"query": [
]
},
"description": "Updates the settings that are configured for the payment terminal identified in the path. * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write"
}
}
]
}
]
},
{
"name": "Payout settings - merchant level",
"item": [
{
"name": "/merchants/:merchantId/payoutSettings/:payoutSettingsId",
"description": "Deletes the payout setting identified in the path. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read and write",
"item": [
{
"name": "Delete a payout setting",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/payoutSettings/:payoutSettingsId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"payoutSettings",
":payoutSettingsId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "payoutSettingsId",
"value": "",
"description": "The unique identifier of the payout setting."
}
],
"query": [
]
},
"description": "Deletes the payout setting identified in the path. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/payoutSettings",
"description": "Returns the list of payout settings for the merchant account identified in the path. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read",
"item": [
{
"name": "Get a list of payout settings",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/payoutSettings",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"payoutSettings"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
]
},
"description": "Returns the list of payout settings for the merchant account identified in the path. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read"
}
}
]
},
{
"name": "/merchants/:merchantId/payoutSettings/:payoutSettingsId",
"description": "Returns the payout setting identified in the path. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read",
"item": [
{
"name": "Get a payout setting",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/payoutSettings/:payoutSettingsId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"payoutSettings",
":payoutSettingsId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "payoutSettingsId",
"value": "",
"description": "The unique identifier of the payout setting."
}
],
"query": [
]
},
"description": "Returns the payout setting identified in the path. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read"
}
}
]
},
{
"name": "/merchants/:merchantId/payoutSettings/:payoutSettingsId",
"description": "Updates the payout setting identified in the path. You can enable or disable the payout setting. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read and write",
"item": [
{
"name": "Update a payout setting",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"enabled\": \"<string>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/payoutSettings/:payoutSettingsId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"payoutSettings",
":payoutSettingsId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "payoutSettingsId",
"value": "",
"description": "The unique identifier of the payout setting."
}
],
"query": [
]
},
"description": "Updates the payout setting identified in the path. You can enable or disable the payout setting. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/payoutSettings",
"description": "Sends a request to add a payout setting for the merchant account specified in the path. A payout setting links the merchant account to the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the payout bank account. Adyen verifies the bank account before allowing and enabling the payout setting. If you're accepting payments in multiple currencies, you may add multiple payout settings for the merchant account. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read and write",
"item": [
{
"name": "Add a payout setting",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"enabled\": \"<string>\",\n \"enabledFromDate\": \"<string>\",\n \"transferInstrumentId\": \"<string>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/payoutSettings",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"payoutSettings"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
]
},
"description": "Sends a request to add a payout setting for the merchant account specified in the path. A payout setting links the merchant account to the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the payout bank account. Adyen verifies the bank account before allowing and enabling the payout setting. If you're accepting payments in multiple currencies, you may add multiple payout settings for the merchant account. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read and write"
}
}
]
}
]
},
{
"name": "Webhooks - merchant level",
"item": [
{
"name": "/merchants/:merchantId/webhooks/:webhookId",
"description": "Remove the configuration for the webhook identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write",
"item": [
{
"name": "Remove a webhook",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"webhooks",
":webhookId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "webhookId",
"value": "",
"description": "Unique identifier of the webhook configuration."
}
],
"query": [
]
},
"description": "Remove the configuration for the webhook identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/webhooks",
"description": "Lists all webhook configurations for the merchant account. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read * Management API—Webhooks read and write",
"item": [
{
"name": "List all webhooks",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/webhooks",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"webhooks"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
{
"key": "pageNumber",
"value": "56"
},
{
"key": "pageSize",
"value": "56"
}
]
},
"description": "Lists all webhook configurations for the merchant account. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read * Management API—Webhooks read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/webhooks/:webhookId",
"description": "Returns the configuration for the webhook identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read * Management API—Webhooks read and write",
"item": [
{
"name": "Get a webhook",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"webhooks",
":webhookId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "webhookId",
"value": "",
"description": "Unique identifier of the webhook configuration."
}
],
"query": [
]
},
"description": "Returns the configuration for the webhook identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read * Management API—Webhooks read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/webhooks/:webhookId",
"description": "Make changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration. The response contains the full configuration for the webhook, which includes the new values from the request. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write",
"item": [
{
"name": "Activate the webhook",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"active\" : true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"webhooks",
":webhookId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "webhookId",
"value": "",
"description": "Unique identifier of the webhook configuration."
}
],
"query": [
]
},
"description": "Make changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration. The response contains the full configuration for the webhook, which includes the new values from the request. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/webhooks",
"description": "Subscribe to receive webhook notifications about events related to your merchant account. You can add basic authentication to make sure the data is secure. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write",
"item": [
{
"name": "Add a webhook configuration",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\" : \"standard\",\n \"url\" : \"YOUR_WEBHOOK_URL\",\n \"username\" : \"YOUR_USER\",\n \"password\" : \"YOUR_PASSWORD\",\n \"active\" : true,\n \"sslVersion\" : \"TLSv1.2\",\n \"communicationFormat\" : \"json\",\n \"acceptsExpiredCertificate\" : false,\n \"acceptsSelfSignedCertificate\" : true,\n \"acceptsUntrustedRootCertificate\" : true,\n \"populateSoapActionHeader\" : false\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/webhooks",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"webhooks"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
]
},
"description": "Subscribe to receive webhook notifications about events related to your merchant account. You can add basic authentication to make sure the data is secure. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/webhooks/:webhookId/generateHmac",
"description": "Returns an [HMAC key](https://en.wikipedia.org/wiki/HMAC) for the webhook identified in the path. This key allows you to check the integrity and the origin of the notifications you receive.By creating an HMAC key, you start receiving [HMAC-signed notifications](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures#enable-hmac-signatures) from Adyen. Find out more about how to [verify HMAC signatures](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures). To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write",
"item": [
{
"name": "Generate an HMAC key",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId/generateHmac",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"webhooks",
":webhookId",
"generateHmac"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "webhookId",
"value": "",
"description": ""
}
],
"query": [
]
},
"description": "Returns an [HMAC key](https://en.wikipedia.org/wiki/HMAC) for the webhook identified in the path. This key allows you to check the integrity and the origin of the notifications you receive.By creating an HMAC key, you start receiving [HMAC-signed notifications](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures#enable-hmac-signatures) from Adyen. Find out more about how to [verify HMAC signatures](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures). To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/webhooks/:webhookId/test",
"description": "Sends sample notifications to test if the webhook is set up correctly. We send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP, regardless of the currencies configured in the merchant accounts. For custom notifications, we only send the specified custom notification. The response describes the result of the test. The `status` field tells you if the test was successful or not. You can use the other fields to troubleshoot unsuccessful tests. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write",
"item": [
{
"name": "Test a webhook notification",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"notification\" : {\n \"paymentMethod\" : \"visa\",\n \"eventCode\" : \"AUTHORISATION\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reason\" : \"Authorize visa payment\",\n \"success\" : true\n },\n \"types\" : [ \"CUSTOM\" ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId/test",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"webhooks",
":webhookId",
"test"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "webhookId",
"value": "",
"description": "Unique identifier of the webhook configuration."
}
],
"query": [
]
},
"description": "Sends sample notifications to test if the webhook is set up correctly. We send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP, regardless of the currencies configured in the merchant accounts. For custom notifications, we only send the specified custom notification. The response describes the result of the test. The `status` field tells you if the test was successful or not. You can use the other fields to troubleshoot unsuccessful tests. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write"
}
}
]
}
]
},
{
"name": "Client key - merchant level",
"item": [
{
"name": "/merchants/:merchantId/apiCredentials/:apiCredentialId/generateClientKey",
"description": "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write",
"item": [
{
"name": "Generate new client key",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/generateClientKey",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"apiCredentials",
":apiCredentialId",
"generateClientKey"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "apiCredentialId",
"value": "",
"description": "Unique identifier of the API credential."
}
],
"query": [
]
},
"description": "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write"
}
}
]
}
]
},
{
"name": "Allowed origins - merchant level",
"item": [
{
"name": "/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins/:originId",
"description": "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. As soon as an allowed origin is removed, we no longer accept client-side requests from that domain. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write",
"item": [
{
"name": "Delete an allowed origin",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins/:originId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"apiCredentials",
":apiCredentialId",
"allowedOrigins",
":originId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "apiCredentialId",
"value": "",
"description": "Unique identifier of the API credential."
},
{
"key": "originId",
"value": "",
"description": "Unique identifier of the allowed origin."
}
],
"query": [
]
},
"description": "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. As soon as an allowed origin is removed, we no longer accept client-side requests from that domain. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins",
"description": "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write",
"item": [
{
"name": "Get a list of allowed origins",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"apiCredentials",
":apiCredentialId",
"allowedOrigins"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "apiCredentialId",
"value": "",
"description": "Unique identifier of the API credential."
}
],
"query": [
]
},
"description": "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins/:originId",
"description": "Returns the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write",
"item": [
{
"name": "Get an allowed origin",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins/:originId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"apiCredentials",
":apiCredentialId",
"allowedOrigins",
":originId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "apiCredentialId",
"value": "",
"description": "Unique identifier of the API credential."
},
{
"key": "originId",
"value": "",
"description": "Unique identifier of the allowed origin."
}
],
"query": [
]
},
"description": "Returns the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins",
"description": "Adds a new [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) to the API credential's list of allowed origins. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write",
"item": [
{
"name": "Add an allowed origin for the API credential",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"domain\" : \"https://www.eu.mystore.com\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"apiCredentials",
":apiCredentialId",
"allowedOrigins"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "apiCredentialId",
"value": "",
"description": "Unique identifier of the API credential."
}
],
"query": [
]
},
"description": "Adds a new [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) to the API credential's list of allowed origins. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write"
}
}
]
}
]
},
{
"name": "Terminal orders - company level",
"item": [
{
"name": "/companies/:companyId/billingEntities",
"description": "Returns the billing entities of the company identified in the path and all merchant accounts belonging to the company. A billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write",
"item": [
{
"name": "Get a list of billing entities",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/billingEntities",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"billingEntities"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
}
],
"query": [
{
"key": "name",
"value": "name_example"
}
]
},
"description": "Returns the billing entities of the company identified in the path and all merchant accounts belonging to the company. A billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write"
}
}
]
},
{
"name": "/companies/:companyId/shippingLocations",
"description": "Returns the shipping locations for the company identified in the path and all merchant accounts belonging to the company. A shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write",
"item": [
{
"name": "Get a list of shipping locations",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/shippingLocations",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"shippingLocations"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
}
],
"query": [
{
"key": "name",
"value": "name_example"
},
{
"key": "offset",
"value": "56"
},
{
"key": "limit",
"value": "56"
}
]
},
"description": "Returns the shipping locations for the company identified in the path and all merchant accounts belonging to the company. A shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write"
}
}
]
},
{
"name": "/companies/:companyId/terminalModels",
"description": "Returns a list of payment terminal models that the company 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. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write",
"item": [
{
"name": "Get a list of terminal models",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/terminalModels",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"terminalModels"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
}
],
"query": [
]
},
"description": "Returns a list of payment terminal models that the company 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. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write"
}
}
]
},
{
"name": "/companies/:companyId/terminalOrders",
"description": "Returns a lists of terminal products orders for the company identified in the path. To filter the list, use one or more of the query parameters. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write",
"item": [
{
"name": "Get a list of orders",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/terminalOrders",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"terminalOrders"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
}
],
"query": [
{
"key": "customerOrderReference",
"value": "customerOrderReference_example"
},
{
"key": "status",
"value": "status_example"
},
{
"key": "offset",
"value": "56"
},
{
"key": "limit",
"value": "56"
}
]
},
"description": "Returns a lists of terminal products orders for the company identified in the path. To filter the list, use one or more of the query parameters. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write"
}
}
]
},
{
"name": "/companies/:companyId/terminalOrders/:orderId",
"description": "Returns the details of the terminal products order identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write",
"item": [
{
"name": "Get an order",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/terminalOrders/:orderId",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"terminalOrders",
":orderId"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
},
{
"key": "orderId",
"value": "",
"description": "The unique identifier of the order."
}
],
"query": [
]
},
"description": "Returns the details of the terminal products order identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write"
}
}
]
},
{
"name": "/companies/:companyId/terminalProducts",
"description": "Returns a country-specific list of payment terminal packages and parts that the company identified in the path has access to. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write",
"item": [
{
"name": "Get a list of terminal products",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/terminalProducts",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"terminalProducts"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
}
],
"query": [
{
"key": "country",
"value": "country_example"
},
{
"key": "terminalModelId",
"value": "terminalModelId_example"
},
{
"key": "offset",
"value": "56"
},
{
"key": "limit",
"value": "56"
}
]
},
"description": "Returns a country-specific list of payment terminal packages and parts that the company identified in the path has access to. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write"
}
}
]
},
{
"name": "/companies/:companyId/terminalOrders/:orderId",
"description": "Updates the terminal products order identified in the path. Updating is only possible while the order has the status **Placed**. The request body only needs to contain what you want to change. However, to update the products in the `items` array, you must provide the entire array. For example, if the array has three items: To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write",
"item": [
{
"name": "Update a terminal order",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"shippingLocation\" : \"S2-7973536B20662642215526704F302044452F714622375D476169\",\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-175746-EU\",\n \"name\" : \"Adyen Test Card\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 5\n } ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/terminalOrders/:orderId",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"terminalOrders",
":orderId"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
},
{
"key": "orderId",
"value": "",
"description": "The unique identifier of the order."
}
],
"query": [
]
},
"description": "Updates the terminal products order identified in the path. Updating is only possible while the order has the status **Placed**. The request body only needs to contain what you want to change. However, to update the products in the `items` array, you must provide the entire array. For example, if the array has three items: To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write"
}
}
]
},
{
"name": "/companies/:companyId/shippingLocations",
"description": "Creates a shipping location for the company identified in the path. A shipping location defines an address where orders can be delivered. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write",
"item": [
{
"name": "Create a shipping location",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\" : \"YOUR_COMPANY Rokin depot\",\n \"address\" : {\n \"companyName\" : \"YOUR_COMPANY\",\n \"streetAddress\" : \"Rokin 21\",\n \"postalCode\" : \"1012 KS\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"\",\n \"country\" : \"NL\"\n },\n \"contact\" : {\n \"firstName\" : \"Paul\",\n \"lastName\" : \"Green\",\n \"phoneNumber\" : \"+31 020 1234567\",\n \"email\" : \"Paul.Green@company.com\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/shippingLocations",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"shippingLocations"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
}
],
"query": [
]
},
"description": "Creates a shipping location for the company identified in the path. A shipping location defines an address where orders can be delivered. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write"
}
}
]
},
{
"name": "/companies/:companyId/terminalOrders",
"description": "Creates an order for payment terminal products for the company identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write",
"item": [
{
"name": "Create an order",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"customerOrderReference\" : \"{{$guid}}\",\n \"shippingLocationId\" : \"S2-6A6C2E3432747D4F2F2C3455485E3836457D\",\n \"billingEntityId\" : \"Company.YOUR_COMPANY\",\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-175746-EU\",\n \"name\" : \"Adyen Test Card\",\n \"quantity\" : 1\n } ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/terminalOrders",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"terminalOrders"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
}
],
"query": [
]
},
"description": "Creates an order for payment terminal products for the company identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write"
}
}
]
},
{
"name": "/companies/:companyId/terminalOrders/:orderId/cancel",
"description": "Cancels the terminal products order identified in the path. Cancelling is only possible while the order has the status **Placed**. To 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**. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write",
"item": [
{
"name": "Cancel an order",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/terminalOrders/:orderId/cancel",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"terminalOrders",
":orderId",
"cancel"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
},
{
"key": "orderId",
"value": "",
"description": "The unique identifier of the order."
}
],
"query": [
]
},
"description": "Cancels the terminal products order identified in the path. Cancelling is only possible while the order has the status **Placed**. To 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**. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write"
}
}
]
}
]
},
{
"name": "API credentials - merchant level",
"item": [
{
"name": "/merchants/:merchantId/apiCredentials",
"description": "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the merchant account. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write",
"item": [
{
"name": "Get a list of API credentials",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"apiCredentials"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
{
"key": "pageNumber",
"value": "56"
},
{
"key": "pageSize",
"value": "56"
}
]
},
"description": "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the merchant account. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/apiCredentials/:apiCredentialId",
"description": "Returns the [API credential](https://docs.adyen.com/development-resources/api-credentials) identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write",
"item": [
{
"name": "Get an API credential",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"apiCredentials",
":apiCredentialId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "apiCredentialId",
"value": "",
"description": "Unique identifier of the API credential."
}
],
"query": [
]
},
"description": "Returns the [API credential](https://docs.adyen.com/development-resources/api-credentials) identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/apiCredentials/:apiCredentialId",
"description": "Changes the API credential's roles, or allowed origins. The request has the new values for the fields you want to change. The response contains the full updated API credential, including the new values from the request. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write",
"item": [
{
"name": "Activate an API credential",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"active\" : true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"apiCredentials",
":apiCredentialId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "apiCredentialId",
"value": "",
"description": "Unique identifier of the API credential."
}
],
"query": [
]
},
"description": "Changes the API credential's roles, or allowed origins. The request has the new values for the fields you want to change. The response contains the full updated API credential, including the new values from the request. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/apiCredentials",
"description": "Creates an [API credential](https://docs.adyen.com/development-resources/api-credentials) for the company account identified in the path. In the request, you can specify the roles and allowed origins for the new API credential. The response includes the: * [API key](https://docs.adyen.com/development-resources/api-authentication#api-key-authentication): used for API request authentication. * [Client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works): public key used for client-side authentication. * [Username and password](https://docs.adyen.com/development-resources/api-authentication#using-basic-authentication): used for basic authentication. > Make sure you store the API key securely in your system. You won't be able to retrieve it later. If your API key is lost or compromised, you need to [generate a new API key](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateApiKey). To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write",
"item": [
{
"name": "Add an API credential",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"roles\" : [ \"Checkout webservice role\" ],\n \"allowedOrigins\" : [ \"https://www.mystore.com\" ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"apiCredentials"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
]
},
"description": "Creates an [API credential](https://docs.adyen.com/development-resources/api-credentials) for the company account identified in the path. In the request, you can specify the roles and allowed origins for the new API credential. The response includes the: * [API key](https://docs.adyen.com/development-resources/api-authentication#api-key-authentication): used for API request authentication. * [Client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works): public key used for client-side authentication. * [Username and password](https://docs.adyen.com/development-resources/api-authentication#using-basic-authentication): used for basic authentication. > Make sure you store the API key securely in your system. You won't be able to retrieve it later. If your API key is lost or compromised, you need to [generate a new API key](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateApiKey). To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write"
}
}
]
}
]
},
{
"name": "Users - merchant level",
"item": [
{
"name": "/merchants/:merchantId/users",
"description": "Returns a list of users associated with the `merchantId` specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ",
"item": [
{
"name": "Get a list of users",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/users",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"users"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "Unique identifier of the merchant."
}
],
"query": [
{
"key": "pageNumber",
"value": "56"
},
{
"key": "pageSize",
"value": "56"
},
{
"key": "username",
"value": "username_example"
}
]
},
"description": "Returns a list of users associated with the `merchantId` specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write "
}
}
]
},
{
"name": "/merchants/:merchantId/users/:userId",
"description": "Returns user details for the `userId` and the `merchantId` specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ",
"item": [
{
"name": "Get user details",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/users/:userId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"users",
":userId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "Unique identifier of the merchant."
},
{
"key": "userId",
"value": "",
"description": "Unique identifier of the user."
}
],
"query": [
]
},
"description": "Returns user details for the `userId` and the `merchantId` specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write "
}
}
]
},
{
"name": "/merchants/:merchantId/users/:userId",
"description": "Updates user details for the `userId` and the `merchantId` specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ",
"item": [
{
"name": "Update a user",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"accountGroups\": \"<string>\",\n \"active\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"roles\": \"<string>\",\n \"timeZoneCode\": \"<string>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/users/:userId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"users",
":userId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "Unique identifier of the merchant."
},
{
"key": "userId",
"value": "",
"description": "Unique identifier of the user."
}
],
"query": [
]
},
"description": "Updates user details for the `userId` and the `merchantId` specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write "
}
}
]
},
{
"name": "/merchants/:merchantId/users",
"description": "Creates a user for the `merchantId` specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ",
"item": [
{
"name": "Create a user",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"username\" : \"johnsmith\",\n \"email\" : \"john.smith@example.com\",\n \"timeZoneCode\" : \"Europe/Amsterdam\",\n \"roles\" : [ \"Merchant standard role\" ],\n \"associatedMerchantAccounts\" : [ \"{{YOUR_MERCHANT_ACCOUNT}}\" ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/users",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"users"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "Unique identifier of the merchant."
}
],
"query": [
]
},
"description": "Creates a user for the `merchantId` specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write "
}
}
]
}
]
},
{
"name": "Terminal actions - company level",
"item": [
{
"name": "/companies/:companyId/terminalActions",
"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. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal actions read * Management API—Terminal actions read and write",
"item": [
{
"name": "Get a list of terminal actions",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/terminalActions",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"terminalActions"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
}
],
"query": [
{
"key": "pageNumber",
"value": "56"
},
{
"key": "pageSize",
"value": "56"
},
{
"key": "status",
"value": "status_example"
},
{
"key": "type",
"value": "type_example"
}
]
},
"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. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal actions read * Management API—Terminal actions read and write"
}
}
]
},
{
"name": "/companies/:companyId/terminalActions/:actionId",
"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. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal actions read * Management API—Terminal actions read and write",
"item": [
{
"name": "Get terminal action",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/terminalActions/:actionId",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"terminalActions",
":actionId"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
},
{
"key": "actionId",
"value": "",
"description": "The unique identifier of the terminal action."
}
],
"query": [
]
},
"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. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal actions read * Management API—Terminal actions read and write"
}
}
]
}
]
},
{
"name": "Payment methods - merchant level",
"item": [
{
"name": "/merchants/:merchantId/paymentMethodSettings",
"description": "Returns details for all payment methods of the merchant account identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read ",
"item": [
{
"name": "Get all payment methods",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"paymentMethodSettings"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
{
"key": "storeId",
"value": "storeId_example"
},
{
"key": "businessLineId",
"value": "businessLineId_example"
},
{
"key": "pageSize",
"value": "56"
},
{
"key": "pageNumber",
"value": "56"
}
]
},
"description": "Returns details for all payment methods of the merchant account identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read "
}
}
]
},
{
"name": "/merchants/:merchantId/paymentMethodSettings/:paymentMethodId",
"description": "Returns details for the merchant account and the payment method identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read ",
"item": [
{
"name": "Get payment method details",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings/:paymentMethodId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"paymentMethodSettings",
":paymentMethodId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "paymentMethodId",
"value": "",
"description": "The unique identifier of the payment method."
}
],
"query": [
]
},
"description": "Returns details for the merchant account and the payment method identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read "
}
}
]
},
{
"name": "/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/getApplePayDomains",
"description": "Returns all Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/enable-apple-pay#register-merchant-domain). To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read ",
"item": [
{
"name": "Get Apple Pay domains",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/getApplePayDomains",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"paymentMethodSettings",
":paymentMethodId",
"getApplePayDomains"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "paymentMethodId",
"value": "",
"description": "The unique identifier of the payment method."
}
],
"query": [
]
},
"description": "Returns all Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/enable-apple-pay#register-merchant-domain). To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read "
}
}
]
},
{
"name": "/merchants/:merchantId/paymentMethodSettings/:paymentMethodId",
"description": "Updates payment method details for the merchant account and the payment method identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read and write ",
"item": [
{
"name": "Update a payment method",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"bcmc\": \"<string>\",\n \"cartesBancaires\": \"<string>\",\n \"countries\": \"<string>\",\n \"cup\": \"<string>\",\n \"currencies\": \"<string>\",\n \"diners\": \"<string>\",\n \"discover\": \"<string>\",\n \"eftpos_australia\": \"<string>\",\n \"enabled\": \"<string>\",\n \"girocard\": \"<string>\",\n \"ideal\": \"<string>\",\n \"interac_card\": \"<string>\",\n \"jcb\": \"<string>\",\n \"maestro\": \"<string>\",\n \"mc\": \"<string>\",\n \"storeIds\": \"<string>\",\n \"visa\": \"<string>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings/:paymentMethodId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"paymentMethodSettings",
":paymentMethodId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "paymentMethodId",
"value": "",
"description": "The unique identifier of the payment method."
}
],
"query": [
]
},
"description": "Updates payment method details for the merchant account and the payment method identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read and write "
}
}
]
},
{
"name": "/merchants/:merchantId/paymentMethodSettings",
"description": "Sends a request to add a new payment method to the merchant account identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read and write ",
"item": [
{
"name": "Request to add Swish",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"businessLineId\" : \"BL322KV223222D5F8H2J4BQ6C\",\n \"storeIds\" : [ \"ST322LJ223223K5F4SQNR9XL5\" ],\n \"type\" : \"swish\",\n \"swish\" : {\n \"swishNumber\" : \"1231111111\"\n },\n \"currencies\" : [ \"SEK\" ],\n \"countries\" : [ \"SE\" ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"paymentMethodSettings"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
]
},
"description": "Sends a request to add a new payment method to the merchant account identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read and write "
}
}
]
},
{
"name": "/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/addApplePayDomains",
"description": "Adds the new domain to the list of Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/enable-apple-pay#register-merchant-domain). To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read and write ",
"item": [
{
"name": "Add an Apple Pay domain",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"domains\" : [ \"https://example.com\" ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/addApplePayDomains",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"paymentMethodSettings",
":paymentMethodId",
"addApplePayDomains"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "paymentMethodId",
"value": "",
"description": "The unique identifier of the payment method."
}
],
"query": [
]
},
"description": "Adds the new domain to the list of Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/enable-apple-pay#register-merchant-domain). To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read and write "
}
}
]
}
]
},
{
"name": "My API credential",
"item": [
{
"name": "/me/allowedOrigins/:originId",
"description": "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) specified in the path. The API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials). You can make this request with any of the Management API roles.",
"item": [
{
"name": "Remove allowed origin",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/me/allowedOrigins/:originId",
"host": [
"{{baseUrl}}"
],
"path": [
"me",
"allowedOrigins",
":originId"
],
"variable": [
{
"key": "originId",
"value": "",
"description": "Unique identifier of the allowed origin."
}
],
"query": [
]
},
"description": "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) specified in the path. The API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials). You can make this request with any of the Management API roles."
}
}
]
},
{
"name": "/me",
"description": "Returns your [API credential](https://docs.adyen.com/development-resources/api-credentials) details based on the API Key you used in the request. You can make this request with any of the Management API roles.",
"item": [
{
"name": "Get API credential details",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/me",
"host": [
"{{baseUrl}}"
],
"path": [
"me"
],
"variable": [
],
"query": [
]
},
"description": "Returns your [API credential](https://docs.adyen.com/development-resources/api-credentials) details based on the API Key you used in the request. You can make this request with any of the Management API roles."
}
}
]
},
{
"name": "/me/allowedOrigins",
"description": "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) of your [API credential](https://docs.adyen.com/development-resources/api-credentials) based on the API key you used in the request. You can make this request with any of the Management API roles.",
"item": [
{
"name": "Get allowed origins",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/me/allowedOrigins",
"host": [
"{{baseUrl}}"
],
"path": [
"me",
"allowedOrigins"
],
"variable": [
],
"query": [
]
},
"description": "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) of your [API credential](https://docs.adyen.com/development-resources/api-credentials) based on the API key you used in the request. You can make this request with any of the Management API roles."
}
}
]
},
{
"name": "/me/allowedOrigins/:originId",
"description": "Returns the details of the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) specified in the path. The API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials). You can make this request with any of the Management API roles.",
"item": [
{
"name": "Get allowed origin details",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/me/allowedOrigins/:originId",
"host": [
"{{baseUrl}}"
],
"path": [
"me",
"allowedOrigins",
":originId"
],
"variable": [
{
"key": "originId",
"value": "",
"description": "Unique identifier of the allowed origin."
}
],
"query": [
]
},
"description": "Returns the details of the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) specified in the path. The API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials). You can make this request with any of the Management API roles."
}
}
]
},
{
"name": "/me/allowedOrigins",
"description": "Adds an allowed origin to the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) of your API credential. The API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials). You can make this request with any of the Management API roles.",
"item": [
{
"name": "Add allowed origin",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"_links\": \"<string>\",\n \"domain\": \"<string>\",\n \"id\": \"<string>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/me/allowedOrigins",
"host": [
"{{baseUrl}}"
],
"path": [
"me",
"allowedOrigins"
],
"variable": [
],
"query": [
]
},
"description": "Adds an allowed origin to the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) of your API credential. The API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials). You can make this request with any of the Management API roles."
}
}
]
}
]
},
{
"name": "Terminal settings - merchant level",
"item": [
{
"name": "/merchants/:merchantId/terminalLogos",
"description": "Returns the logo that is configured for a specific payment terminal model at the merchant account identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. This 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). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write",
"item": [
{
"name": "Get the terminal logo",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/terminalLogos",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"terminalLogos"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
{
"key": "model",
"value": "model_example"
}
]
},
"description": "Returns the logo that is configured for a specific payment terminal model at the merchant account identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. This 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). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/terminalSettings",
"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). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write",
"item": [
{
"name": "Get terminal settings",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/terminalSettings",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"terminalSettings"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
]
},
"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). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/terminalLogos",
"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. This 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). * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from the company account, specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write",
"item": [
{
"name": "Remove logo to restore the logo from a higher level",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\" : \"\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/terminalLogos",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"terminalLogos"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
{
"key": "model",
"value": "model_example"
}
]
},
"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. This 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). * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from the company account, specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write"
}
},
{
"name": "Upload terminal logo",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/terminalLogos",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"terminalLogos"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
{
"key": "model",
"value": "model_example"
}
]
},
"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. This 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). * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from the company account, specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/terminalSettings",
"description": "Updates payment terminal settings 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). * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write",
"item": [
{
"name": "Add EAP-PEAP and PSK Wi-Fi profiles",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/terminalSettings",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"terminalSettings"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
]
},
"description": "Updates payment terminal settings 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). * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write"
}
},
{
"name": "Add EAP-TLS Wi-Fi profile",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/terminalSettings",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"terminalSettings"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
]
},
"description": "Updates payment terminal settings 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). * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write"
}
}
]
}
]
},
{
"name": "Terminals - terminal level",
"item": [
{
"name": "/terminals",
"description": "Returns the payment terminals that the API credential has access to and that match the query parameters. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API — Terminal actions read",
"item": [
{
"name": "Get a list of terminals",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/terminals",
"host": [
"{{baseUrl}}"
],
"path": [
"terminals"
],
"variable": [
],
"query": [
{
"key": "searchQuery",
"value": "searchQuery_example"
},
{
"key": "otpQuery",
"value": "otpQuery_example"
},
{
"key": "countries",
"value": "countries_example"
},
{
"key": "merchantIds",
"value": "merchantIds_example"
},
{
"key": "storeIds",
"value": "storeIds_example"
},
{
"key": "brandModels",
"value": "brandModels_example"
},
{
"key": "pageNumber",
"value": "56"
},
{
"key": "pageSize",
"value": "56"
}
]
},
"description": "Returns the payment terminals that the API credential has access to and that match the query parameters. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API — Terminal actions read"
}
}
]
},
{
"name": "/terminals/:terminalId/reassign",
"description": "Reassigns a payment terminal to a company account, merchant account, merchant account inventory, or a store. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Assign Terminal",
"item": [
{
"name": "Reassign a terminal",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"companyId\": \"<string>\",\n \"inventory\": \"<string>\",\n \"merchantId\": \"<string>\",\n \"storeId\": \"<string>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/terminals/:terminalId/reassign",
"host": [
"{{baseUrl}}"
],
"path": [
"terminals",
":terminalId",
"reassign"
],
"variable": [
{
"key": "terminalId",
"value": "",
"description": "The unique identifier of the payment terminal."
}
],
"query": [
]
},
"description": "Reassigns a payment terminal to a company account, merchant account, merchant account inventory, or a store. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Assign Terminal"
}
}
]
}
]
},
{
"name": "Webhooks - company level",
"item": [
{
"name": "/companies/:companyId/webhooks/:webhookId",
"description": "Remove the configuration for the webhook identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write",
"item": [
{
"name": "Remove a webhook",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"webhooks",
":webhookId"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
},
{
"key": "webhookId",
"value": "",
"description": "Unique identifier of the webhook configuration."
}
],
"query": [
]
},
"description": "Remove the configuration for the webhook identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write"
}
}
]
},
{
"name": "/companies/:companyId/webhooks",
"description": "Lists all webhook configurations for the company account. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read * Management API—Webhooks read and write",
"item": [
{
"name": "List all webhooks",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/webhooks",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"webhooks"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account)."
}
],
"query": [
{
"key": "pageNumber",
"value": "56"
},
{
"key": "pageSize",
"value": "56"
}
]
},
"description": "Lists all webhook configurations for the company account. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read * Management API—Webhooks read and write"
}
}
]
},
{
"name": "/companies/:companyId/webhooks/:webhookId",
"description": "Returns the configuration for the webhook identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read * Management API—Webhooks read and write",
"item": [
{
"name": "Get a webhook",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"webhooks",
":webhookId"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account)."
},
{
"key": "webhookId",
"value": "",
"description": "Unique identifier of the webhook configuration."
}
],
"query": [
]
},
"description": "Returns the configuration for the webhook identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read * Management API—Webhooks read and write"
}
}
]
},
{
"name": "/companies/:companyId/webhooks/:webhookId",
"description": "Make changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration. The response contains the full configuration for the webhook, which includes the new values from the request. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write",
"item": [
{
"name": "Activate the webhook",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"active\" : true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"webhooks",
":webhookId"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
},
{
"key": "webhookId",
"value": "",
"description": "Unique identifier of the webhook configuration."
}
],
"query": [
]
},
"description": "Make changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration. The response contains the full configuration for the webhook, which includes the new values from the request. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write"
}
}
]
},
{
"name": "/companies/:companyId/webhooks",
"description": "Subscribe to receive webhook notifications about events related to your company account. You can add basic authentication to make sure the data is secure. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write",
"item": [
{
"name": "Add a webhook configuration",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\" : \"standard\",\n \"url\" : \"YOUR_WEBHOOK_URL\",\n \"username\" : \"YOUR_USER\",\n \"password\" : \"YOUR_PASSWORD\",\n \"active\" : true,\n \"sslVersion\" : \"TLSv1.2\",\n \"communicationFormat\" : \"soap\",\n \"acceptsExpiredCertificate\" : false,\n \"acceptsSelfSignedCertificate\" : true,\n \"acceptsUntrustedRootCertificate\" : true,\n \"populateSoapActionHeader\" : false,\n \"filterMerchantAccountType\" : \"includeAccounts\",\n \"filterMerchantAccounts\" : [ \"{{YOUR_MERCHANT_ACCOUNT}}\" ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/webhooks",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"webhooks"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account)."
}
],
"query": [
]
},
"description": "Subscribe to receive webhook notifications about events related to your company account. You can add basic authentication to make sure the data is secure. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write"
}
}
]
},
{
"name": "/companies/:companyId/webhooks/:webhookId/generateHmac",
"description": "Returns an [HMAC key](https://en.wikipedia.org/wiki/HMAC) for the webhook identified in the path. This key allows you to check the integrity and the origin of the notifications you receive.By creating an HMAC key, you start receiving [HMAC-signed notifications](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures#enable-hmac-signatures) from Adyen. Find out more about how to [verify HMAC signatures](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures). To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write",
"item": [
{
"name": "Generate an HMAC key",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId/generateHmac",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"webhooks",
":webhookId",
"generateHmac"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
},
{
"key": "webhookId",
"value": "",
"description": "Unique identifier of the webhook configuration."
}
],
"query": [
]
},
"description": "Returns an [HMAC key](https://en.wikipedia.org/wiki/HMAC) for the webhook identified in the path. This key allows you to check the integrity and the origin of the notifications you receive.By creating an HMAC key, you start receiving [HMAC-signed notifications](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures#enable-hmac-signatures) from Adyen. Find out more about how to [verify HMAC signatures](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures). To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write"
}
}
]
},
{
"name": "/companies/:companyId/webhooks/:webhookId/test",
"description": "Sends sample notifications to test if the webhook is set up correctly. We send sample notifications for maximum 20 of the merchant accounts that the webhook is configured for. If the webhook is configured for more than 20 merchant accounts, use the `merchantIds` array to specify a subset of the merchant accounts for which to send test notifications. We send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP, regardless of the currencies configured in the merchant accounts. For custom notifications, we only send the specified custom notification. The response describes the result of the test. The `status` field tells you if the test was successful or not. You can use the other response fields to troubleshoot unsuccessful tests. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write",
"item": [
{
"name": "Test a webhook notification",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"notification\" : {\n \"paymentMethod\" : \"visa\",\n \"eventCode\" : \"AUTHORISATION\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2000\n },\n \"reason\" : \"Authorize visa payment\",\n \"success\" : true\n },\n \"types\" : [ \"CUSTOM\" ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId/test",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"webhooks",
":webhookId",
"test"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
},
{
"key": "webhookId",
"value": "",
"description": "Unique identifier of the webhook configuration."
}
],
"query": [
]
},
"description": "Sends sample notifications to test if the webhook is set up correctly. We send sample notifications for maximum 20 of the merchant accounts that the webhook is configured for. If the webhook is configured for more than 20 merchant accounts, use the `merchantIds` array to specify a subset of the merchant accounts for which to send test notifications. We send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP, regardless of the currencies configured in the merchant accounts. For custom notifications, we only send the specified custom notification. The response describes the result of the test. The `status` field tells you if the test was successful or not. You can use the other response fields to troubleshoot unsuccessful tests. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write"
}
}
]
}
]
},
{
"name": "Account - store level",
"item": [
{
"name": "/merchants/:merchantId/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. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read * Management API—Stores read and write",
"item": [
{
"name": "Get a list of stores",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/stores",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"stores"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
{
"key": "pageNumber",
"value": "56"
},
{
"key": "pageSize",
"value": "56"
},
{
"key": "reference",
"value": "reference_example"
}
]
},
"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. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read * Management API—Stores read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/stores/:storeId",
"description": "Returns the details of the store identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read * Management API—Stores read and write",
"item": [
{
"name": "Get a store",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"stores",
":storeId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "storeId",
"value": "",
"description": "The unique identifier of the store."
}
],
"query": [
]
},
"description": "Returns the details of the store identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read * Management API—Stores read and write"
}
}
]
},
{
"name": "/stores",
"description": "Returns a list of stores. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read * Management API—Stores read and write",
"item": [
{
"name": "Get a list of stores",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/stores",
"host": [
"{{baseUrl}}"
],
"path": [
"stores"
],
"variable": [
],
"query": [
{
"key": "pageNumber",
"value": "56"
},
{
"key": "pageSize",
"value": "56"
},
{
"key": "reference",
"value": "reference_example"
},
{
"key": "merchantId",
"value": "merchantId_example"
}
]
},
"description": "Returns a list of stores. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read * Management API—Stores read and write"
}
}
]
},
{
"name": "/stores/:storeId",
"description": "Returns the details of the store identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read * Management API—Stores read and write",
"item": [
{
"name": "Get a store",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/stores/:storeId",
"host": [
"{{baseUrl}}"
],
"path": [
"stores",
":storeId"
],
"variable": [
{
"key": "storeId",
"value": "",
"description": "The unique identifier of the store."
}
],
"query": [
]
},
"description": "Returns the details of the store identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read * Management API—Stores read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/stores/:storeId",
"description": "Updates the store identified in the path. You can only update some store parameters. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write",
"item": [
{
"name": "Update store address.",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"address\" : {\n \"line1\" : \"1776 West Pinewood Avenue\",\n \"line2\" : \"Heartland Building\",\n \"line3\" : \"\",\n \"postalCode\" : \"20251\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"stores",
":storeId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "storeId",
"value": "",
"description": "The unique identifier of the store."
}
],
"query": [
]
},
"description": "Updates the store identified in the path. You can only update some store parameters. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write"
}
},
{
"name": "Add split configuration to store",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"splitConfiguration\" : {\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\",\n \"splitConfigurationId\" : \"SCNF4224P22322585HPCX384JV6JGX\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"stores",
":storeId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "storeId",
"value": "",
"description": "The unique identifier of the store."
}
],
"query": [
]
},
"description": "Updates the store identified in the path. You can only update some store parameters. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write"
}
}
]
},
{
"name": "/stores/:storeId",
"description": "Updates the store identified in the path. You can only update some store parameters. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write",
"item": [
{
"name": "Update store address.",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"address\" : {\n \"line1\" : \"1776 West Pinewood Avenue\",\n \"line2\" : \"Heartland Building\",\n \"line3\" : \"\",\n \"postalCode\" : \"20251\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/stores/:storeId",
"host": [
"{{baseUrl}}"
],
"path": [
"stores",
":storeId"
],
"variable": [
{
"key": "storeId",
"value": "",
"description": "The unique identifier of the store."
}
],
"query": [
]
},
"description": "Updates the store identified in the path. You can only update some store parameters. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write"
}
},
{
"name": "Add split configuration to store",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"splitConfiguration\" : {\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\",\n \"splitConfigurationId\" : \"SCNF4224P22322585HPCX384JV6JGX\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/stores/:storeId",
"host": [
"{{baseUrl}}"
],
"path": [
"stores",
":storeId"
],
"variable": [
{
"key": "storeId",
"value": "",
"description": "The unique identifier of the store."
}
],
"query": [
]
},
"description": "Updates the store identified in the path. You can only update some store parameters. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/stores",
"description": "Creates a store for the merchant account identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write",
"item": [
{
"name": "Create a store under the merchant account specified in the path.",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\" : \"City centre store\",\n \"shopperStatement\" : \"Springfield Shop\",\n \"phoneNumber\" : \"1813702551707653\",\n \"reference\" : \"Spring_store_2\",\n \"address\" : {\n \"country\" : \"US\",\n \"line1\" : \"200 Main Street\",\n \"line2\" : \"Building 5A\",\n \"line3\" : \"Suite 3\",\n \"city\" : \"Springfield\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"20250\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/stores",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"stores"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
]
},
"description": "Creates a store for the merchant account identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write"
}
}
]
},
{
"name": "/stores",
"description": "Creates a store for the merchant account specified in the request. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write",
"item": [
{
"name": "Create a store",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"merchantId\" : \"{{YOUR_MERCHANT_ACCOUNT}}_ID\",\n \"description\" : \"City centre store\",\n \"shopperStatement\" : \"Springfield Shop\",\n \"phoneNumber\" : \"+1813702551707653\",\n \"reference\" : \"Spring_store_2\",\n \"address\" : {\n \"country\" : \"US\",\n \"line1\" : \"200 Main Street\",\n \"line2\" : \"Building 5A\",\n \"line3\" : \"Suite 3\",\n \"city\" : \"Springfield\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"20250\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/stores",
"host": [
"{{baseUrl}}"
],
"path": [
"stores"
],
"variable": [
],
"query": [
]
},
"description": "Creates a store for the merchant account specified in the request. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write"
}
}
]
}
]
},
{
"name": "Android files - company level",
"item": [
{
"name": "/companies/:companyId/androidApps",
"description": "Returns a list of the Android apps that are available for the company identified in the path. These 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). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Android files read * Management API—Android files read and write * Management API—Terminal actions read * Management API—Terminal actions read and write",
"item": [
{
"name": "Get a list of Android apps",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/androidApps",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"androidApps"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
}
],
"query": [
{
"key": "pageNumber",
"value": "56"
},
{
"key": "pageSize",
"value": "56"
},
{
"key": "packageName",
"value": "packageName_example"
},
{
"key": "versionCode",
"value": "56"
}
]
},
"description": "Returns a list of the Android apps that are available for the company identified in the path. These 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). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Android files read * Management API—Android files read and write * Management API—Terminal actions read * Management API—Terminal actions read and write"
}
}
]
},
{
"name": "/companies/:companyId/androidApps/:id",
"description": "Returns the details of the Android app identified in the path. These 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). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Android files read * Management API—Android files read and write",
"item": [
{
"name": "Get Android app",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/androidApps/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"androidApps",
":id"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
},
{
"key": "id",
"value": "",
"description": "The unique identifier of the app."
}
],
"query": [
]
},
"description": "Returns the details of the Android app identified in the path. These 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). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Android files read * Management API—Android files read and write"
}
}
]
},
{
"name": "/companies/:companyId/androidCertificates",
"description": "Returns a list of the Android certificates that are available for the company identified in the path. Typically, these certificates enable running apps on Android payment terminals. The certifcates in the list have been uploaded to Adyen and can be installed or uninstalled on Android terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Android files read * Management API—Android files read and write * Management API—Terminal actions read * Management API—Terminal actions read and write",
"item": [
{
"name": "Get a list of Android certificates",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/androidCertificates",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"androidCertificates"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
}
],
"query": [
{
"key": "pageNumber",
"value": "56"
},
{
"key": "pageSize",
"value": "56"
},
{
"key": "certificateName",
"value": "certificateName_example"
}
]
},
"description": "Returns a list of the Android certificates that are available for the company identified in the path. Typically, these certificates enable running apps on Android payment terminals. The certifcates in the list have been uploaded to Adyen and can be installed or uninstalled on Android terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Android files read * Management API—Android files read and write * Management API—Terminal actions read * Management API—Terminal actions read and write"
}
}
]
},
{
"name": "/companies/:companyId/androidApps",
"description": "Uploads an Android APK file to Adyen. The maximum APK file size is 200 MB. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Android files read and write >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.",
"item": [
{
"name": "Upload Android App",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/androidApps",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"androidApps"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
}
],
"query": [
]
},
"description": "Uploads an Android APK file to Adyen. The maximum APK file size is 200 MB. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Android files read and write >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."
}
}
]
}
]
},
{
"name": "Terminal settings - company level",
"item": [
{
"name": "/companies/:companyId/terminalLogos",
"description": "Returns the logo that is configured for a specific payment terminal model at the company identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. This 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). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write",
"item": [
{
"name": "Get the terminal logo",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/terminalLogos",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"terminalLogos"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
}
],
"query": [
{
"key": "model",
"value": "model_example"
}
]
},
"description": "Returns the logo that is configured for a specific payment terminal model at the company identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. This 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). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write"
}
}
]
},
{
"name": "/companies/:companyId/terminalSettings",
"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). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write",
"item": [
{
"name": "Get terminal settings",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/terminalSettings",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"terminalSettings"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
}
],
"query": [
]
},
"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). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write"
}
}
]
},
{
"name": "/companies/:companyId/terminalLogos",
"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. This 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). * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from the Adyen PSP level, specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write",
"item": [
{
"name": "Remove logo to restore the logo from a higher level",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\" : \"\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/terminalLogos",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"terminalLogos"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
}
],
"query": [
{
"key": "model",
"value": "model_example"
}
]
},
"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. This 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). * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from the Adyen PSP level, specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write"
}
},
{
"name": "Upload terminal logo",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/terminalLogos",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"terminalLogos"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
}
],
"query": [
{
"key": "model",
"value": "model_example"
}
]
},
"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. This 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). * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from the Adyen PSP level, specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write"
}
}
]
},
{
"name": "/companies/:companyId/terminalSettings",
"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). * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from the Adyen PSP level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write",
"item": [
{
"name": "Add EAP-PEAP and PSK Wi-Fi profiles",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/terminalSettings",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"terminalSettings"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
}
],
"query": [
]
},
"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). * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from the Adyen PSP level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write"
}
},
{
"name": "Add EAP-TLS Wi-Fi profile",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/terminalSettings",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"terminalSettings"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
}
],
"query": [
]
},
"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). * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from the Adyen PSP level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write"
}
}
]
}
]
},
{
"name": "API credentials - company level",
"item": [
{
"name": "/companies/:companyId/apiCredentials",
"description": "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the company account. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write",
"item": [
{
"name": "Get a list of API credentials",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/apiCredentials",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"apiCredentials"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
}
],
"query": [
{
"key": "pageNumber",
"value": "56"
},
{
"key": "pageSize",
"value": "56"
}
]
},
"description": "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the company account. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write"
}
}
]
},
{
"name": "/companies/:companyId/apiCredentials/:apiCredentialId",
"description": "Returns the [API credential](https://docs.adyen.com/development-resources/api-credentials) identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write",
"item": [
{
"name": "Get an API credential",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"apiCredentials",
":apiCredentialId"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
},
{
"key": "apiCredentialId",
"value": "",
"description": "Unique identifier of the API credential."
}
],
"query": [
]
},
"description": "Returns the [API credential](https://docs.adyen.com/development-resources/api-credentials) identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write"
}
}
]
},
{
"name": "/companies/:companyId/apiCredentials/:apiCredentialId",
"description": "Changes the API credential's roles, merchant account access, or allowed origins. The request has the new values for the fields you want to change. The response contains the full updated API credential, including the new values from the request. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write",
"item": [
{
"name": "Activate an API credential",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"active\" : true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"apiCredentials",
":apiCredentialId"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
},
{
"key": "apiCredentialId",
"value": "",
"description": "Unique identifier of the API credential."
}
],
"query": [
]
},
"description": "Changes the API credential's roles, merchant account access, or allowed origins. The request has the new values for the fields you want to change. The response contains the full updated API credential, including the new values from the request. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write"
}
}
]
},
{
"name": "/companies/:companyId/apiCredentials",
"description": "Creates an [API credential](https://docs.adyen.com/development-resources/api-credentials) for the company account identified in the path. In the request, you can specify which merchant accounts the new API credential will have access to, as well as its roles and allowed origins. The response includes several types of authentication details: * [API key](https://docs.adyen.com/development-resources/api-authentication#api-key-authentication): used for API request authentication. * [Client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works): public key used for client-side authentication. * [Username and password](https://docs.adyen.com/development-resources/api-authentication#using-basic-authentication): used for basic authentication. > Make sure you store the API key securely in your system. You won't be able to retrieve it later. If your API key is lost or compromised, you need to [generate a new API key](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/apiCredentials/{apiCredentialId}/generateApiKey). To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write",
"item": [
{
"name": "Add an API credential",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"roles\" : [ \"Checkout webservice role\" ],\n \"allowedOrigins\" : [ \"https://www.mystore.com\" ],\n \"associatedMerchantAccounts\" : [ \"{{YOUR_MERCHANT_ACCOUNT}}_AU\", \"{{YOUR_MERCHANT_ACCOUNT}}_EU\", \"{{YOUR_MERCHANT_ACCOUNT}}_US\" ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/apiCredentials",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"apiCredentials"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
}
],
"query": [
]
},
"description": "Creates an [API credential](https://docs.adyen.com/development-resources/api-credentials) for the company account identified in the path. In the request, you can specify which merchant accounts the new API credential will have access to, as well as its roles and allowed origins. The response includes several types of authentication details: * [API key](https://docs.adyen.com/development-resources/api-authentication#api-key-authentication): used for API request authentication. * [Client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works): public key used for client-side authentication. * [Username and password](https://docs.adyen.com/development-resources/api-authentication#using-basic-authentication): used for basic authentication. > Make sure you store the API key securely in your system. You won't be able to retrieve it later. If your API key is lost or compromised, you need to [generate a new API key](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/apiCredentials/{apiCredentialId}/generateApiKey). To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write"
}
}
]
}
]
},
{
"name": "Terminal orders - merchant level",
"item": [
{
"name": "/merchants/:merchantId/billingEntities",
"description": "Returns the billing entities of the merchant account identified in the path. A billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write",
"item": [
{
"name": "Get a list of billing entities",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/billingEntities",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"billingEntities"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
{
"key": "name",
"value": "name_example"
}
]
},
"description": "Returns the billing entities of the merchant account identified in the path. A billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/shippingLocations",
"description": "Returns the shipping locations for the merchant account identified in the path. A shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write",
"item": [
{
"name": "Get a list of shipping locations",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/shippingLocations",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"shippingLocations"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
{
"key": "name",
"value": "name_example"
},
{
"key": "offset",
"value": "56"
},
{
"key": "limit",
"value": "56"
}
]
},
"description": "Returns the shipping locations for the merchant account identified in the path. A shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/terminalModels",
"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. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write",
"item": [
{
"name": "Get a list of terminal models",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/terminalModels",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"terminalModels"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
]
},
"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. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/terminalOrders",
"description": "Returns a list of terminal products orders for the merchant account identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write",
"item": [
{
"name": "Get a list of orders",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"terminalOrders"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": ""
}
],
"query": [
{
"key": "customerOrderReference",
"value": "customerOrderReference_example"
},
{
"key": "status",
"value": "status_example"
},
{
"key": "offset",
"value": "56"
},
{
"key": "limit",
"value": "56"
}
]
},
"description": "Returns a list of terminal products orders for the merchant account identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/terminalOrders/:orderId",
"description": "Returns the details of the terminal products order identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write",
"item": [
{
"name": "Get an order",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders/:orderId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"terminalOrders",
":orderId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "orderId",
"value": "",
"description": "The unique identifier of the order."
}
],
"query": [
]
},
"description": "Returns the details of the terminal products order identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/terminalProducts",
"description": "Returns a country-specific list of payment terminal packages and parts that the merchant account identified in the path has access to. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write",
"item": [
{
"name": "Get a list of terminal products",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/terminalProducts",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"terminalProducts"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
{
"key": "country",
"value": "country_example"
},
{
"key": "terminalModelId",
"value": "terminalModelId_example"
},
{
"key": "offset",
"value": "56"
},
{
"key": "limit",
"value": "56"
}
]
},
"description": "Returns a country-specific list of payment terminal packages and parts that the merchant account identified in the path has access to. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/terminalOrders/:orderId",
"description": "Updates the terminal products order identified in the path. Updating is only possible while the order has the status **Placed**. The request body only needs to contain what you want to change. However, to update the products in the `items` array, you must provice the entire array. For example, if the array has three items: To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write",
"item": [
{
"name": "Update a terminal order",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"shippingLocation\" : \"S2-73536B20665526704F30792642212044452F714622375D477270\",\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-287001-EU\",\n \"name\" : \"Bluetooth Charging Base - V400m\",\n \"quantity\" : 2\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 20\n } ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders/:orderId",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"terminalOrders",
":orderId"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "orderId",
"value": "",
"description": "The unique identifier of the order."
}
],
"query": [
]
},
"description": "Updates the terminal products order identified in the path. Updating is only possible while the order has the status **Placed**. The request body only needs to contain what you want to change. However, to update the products in the `items` array, you must provice the entire array. For example, if the array has three items: To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/shippingLocations",
"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. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write",
"item": [
{
"name": "Create a shipping location",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\" : \"{{YOUR_MERCHANT_ACCOUNT}} Barcelona depot\",\n \"address\" : {\n \"companyName\" : \"YOUR_COMPANY\",\n \"streetAddress\" : \"El quinto pino 42\",\n \"postalCode\" : \"08012\",\n \"city\" : \"Barcelona\",\n \"stateOrProvince\" : \"\",\n \"country\" : \"ES\"\n },\n \"contact\" : {\n \"firstName\" : \"Rita\",\n \"lastName\" : \"Perengano\",\n \"phoneNumber\" : \"+34 93 1234567\",\n \"email\" : \"Rita.Perengano@company.com\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/shippingLocations",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"shippingLocations"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
]
},
"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. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/terminalOrders",
"description": "Creates an order for payment terminal products for the merchant account identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write",
"item": [
{
"name": "Create an order",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"customerOrderReference\" : \"{{$guid}}\",\n \"shippingLocationId\" : \"S2-6A6C2E3432747D4F2F2C3455485E3836457D\",\n \"billingEntityId\" : \"MerchantAccount.{{YOUR_MERCHANT_ACCOUNT}}\",\n \"items\" : [ {\n \"id\" : \"PART-287001-EU\",\n \"name\" : \"Bluetooth Charging Base - V400m\",\n \"quantity\" : 2\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 20\n } ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"terminalOrders"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
}
],
"query": [
]
},
"description": "Creates an order for payment terminal products for the merchant account identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/terminalOrders/:orderId/cancel",
"description": "Cancels the terminal products order identified in the path. Cancelling is only possible while the order has the status **Placed**. To 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**. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write",
"item": [
{
"name": "Cancel an order",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders/:orderId/cancel",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"terminalOrders",
":orderId",
"cancel"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "orderId",
"value": "",
"description": "The unique identifier of the order."
}
],
"query": [
]
},
"description": "Cancels the terminal products order identified in the path. Cancelling is only possible while the order has the status **Placed**. To 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**. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write"
}
}
]
}
]
},
{
"name": "Account - company level",
"item": [
{
"name": "/companies",
"description": "Returns the list of company accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read",
"item": [
{
"name": "Get a list of company accounts",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies",
"host": [
"{{baseUrl}}"
],
"path": [
"companies"
],
"variable": [
],
"query": [
{
"key": "pageNumber",
"value": "56"
},
{
"key": "pageSize",
"value": "56"
}
]
},
"description": "Returns the list of company accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read"
}
}
]
},
{
"name": "/companies/:companyId",
"description": "Returns the company account specified in the path. Your API credential must have access to the company account. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read",
"item": [
{
"name": "Get a company account",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
}
],
"query": [
]
},
"description": "Returns the company account specified in the path. Your API credential must have access to the company account. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read"
}
}
]
},
{
"name": "/companies/:companyId/merchants",
"description": "Returns the list of merchant accounts under the company account specified in the path. The list only includes merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read",
"item": [
{
"name": "Get a list of merchant accounts",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/companies/:companyId/merchants",
"host": [
"{{baseUrl}}"
],
"path": [
"companies",
":companyId",
"merchants"
],
"variable": [
{
"key": "companyId",
"value": "",
"description": "The unique identifier of the company account."
}
],
"query": [
{
"key": "pageNumber",
"value": "56"
},
{
"key": "pageSize",
"value": "56"
}
]
},
"description": "Returns the list of merchant accounts under the company account specified in the path. The list only includes merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read"
}
}
]
}
]
},
{
"name": "Terminal settings - store level",
"item": [
{
"name": "/merchants/:merchantId/stores/:reference/terminalLogos",
"description": "Returns the logo that is configured for a specific payment terminal model at the store identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write",
"item": [
{
"name": "Get the terminal logo",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalLogos",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"stores",
":reference",
"terminalLogos"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "reference",
"value": "",
"description": "The reference that identifies the store."
}
],
"query": [
{
"key": "model",
"value": "model_example"
}
]
},
"description": "Returns the logo that is configured for a specific payment terminal model at the store identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/stores/:reference/terminalSettings",
"description": "Returns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless different values are configured for an individual terminal. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write",
"item": [
{
"name": "Get terminal settings",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalSettings",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"stores",
":reference",
"terminalSettings"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "reference",
"value": "",
"description": "The reference that identifies the store."
}
],
"query": [
]
},
"description": "Returns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless different values are configured for an individual terminal. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write"
}
}
]
},
{
"name": "/stores/:storeId/terminalLogos",
"description": "Returns the logo that is configured for a specific payment terminal model at the store identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. This logo applies to all terminals of that model under the store unless a different logo is configured for an individual terminal. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write",
"item": [
{
"name": "Get the terminal logo",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/stores/:storeId/terminalLogos",
"host": [
"{{baseUrl}}"
],
"path": [
"stores",
":storeId",
"terminalLogos"
],
"variable": [
{
"key": "storeId",
"value": "",
"description": "The unique identifier of the store."
}
],
"query": [
{
"key": "model",
"value": "model_example"
}
]
},
"description": "Returns the logo that is configured for a specific payment terminal model at the store identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. This logo applies to all terminals of that model under the store unless a different logo is configured for an individual terminal. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write"
}
}
]
},
{
"name": "/stores/:storeId/terminalSettings",
"description": "Returns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless different values are configured for an individual terminal. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write",
"item": [
{
"name": "Get terminal settings",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/stores/:storeId/terminalSettings",
"host": [
"{{baseUrl}}"
],
"path": [
"stores",
":storeId",
"terminalSettings"
],
"variable": [
{
"key": "storeId",
"value": "",
"description": "The unique identifier of the store."
}
],
"query": [
]
},
"description": "Returns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless different values are configured for an individual terminal. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/stores/:reference/terminalLogos",
"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. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write",
"item": [
{
"name": "Remove logo to restore the logo from a higher level",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\" : \"\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalLogos",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"stores",
":reference",
"terminalLogos"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "reference",
"value": "",
"description": "The reference that identifies the store."
}
],
"query": [
{
"key": "model",
"value": "model_example"
}
]
},
"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. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write"
}
},
{
"name": "Upload terminal logo",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalLogos",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"stores",
":reference",
"terminalLogos"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "reference",
"value": "",
"description": "The reference that identifies the store."
}
],
"query": [
{
"key": "model",
"value": "model_example"
}
]
},
"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. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write"
}
}
]
},
{
"name": "/merchants/:merchantId/stores/:reference/terminalSettings",
"description": "Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal. * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write",
"item": [
{
"name": "Add EAP-PEAP and PSK Wi-Fi profiles",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalSettings",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"stores",
":reference",
"terminalSettings"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "reference",
"value": "",
"description": "The reference that identifies the store."
}
],
"query": [
]
},
"description": "Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal. * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write"
}
},
{
"name": "Add EAP-TLS Wi-Fi profile",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalSettings",
"host": [
"{{baseUrl}}"
],
"path": [
"merchants",
":merchantId",
"stores",
":reference",
"terminalSettings"
],
"variable": [
{
"key": "merchantId",
"value": "",
"description": "The unique identifier of the merchant account."
},
{
"key": "reference",
"value": "",
"description": "The reference that identifies the store."
}
],
"query": [
]
},
"description": "Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal. * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write"
}
}
]
},
{
"name": "/stores/:storeId/terminalLogos",
"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. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write",
"item": [
{
"name": "Remove logo to restore the logo from a higher level",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\" : \"\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/stores/:storeId/terminalLogos",
"host": [
"{{baseUrl}}"
],
"path": [
"stores",
":storeId",
"terminalLogos"
],
"variable": [
{
"key": "storeId",
"value": "",
"description": "The unique identifier of the store."
}
],
"query": [
{
"key": "model",
"value": "model_example"
}
]
},
"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. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write"
}
},
{
"name": "Upload terminal logo",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/stores/:storeId/terminalLogos",
"host": [
"{{baseUrl}}"
],
"path": [
"stores",
":storeId",
"terminalLogos"
],
"variable": [
{
"key": "storeId",
"value": "",
"description": "The unique identifier of the store."
}
],
"query": [
{
"key": "model",
"value": "model_example"
}
]
},
"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. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write"
}
}
]
},
{
"name": "/stores/:storeId/terminalSettings",
"description": "Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal. * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write",
"item": [
{
"name": "Add EAP-PEAP and PSK Wi-Fi profiles",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/stores/:storeId/terminalSettings",
"host": [
"{{baseUrl}}"
],
"path": [
"stores",
":storeId",
"terminalSettings"
],
"variable": [
{
"key": "storeId",
"value": "",
"description": "The unique identifier of the store."
}
],
"query": [
]
},
"description": "Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal. * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write"
}
},
{
"name": "Add EAP-TLS Wi-Fi profile",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/stores/:storeId/terminalSettings",
"host": [
"{{baseUrl}}"
],
"path": [
"stores",
":storeId",
"terminalSettings"
],
"variable": [
{
"key": "storeId",
"value": "",
"description": "The unique identifier of the store."
}
],
"query": [
]
},
"description": "Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal. * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write"
}
}
]
}
]
}
],
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{X-API-Key}}",
"type": "string"
},
{
"key": "key",
"value": "X-API-Key",
"type": "string"
}
]
},
"variable": [
{
"key": "baseUrl",
"value": "https://management-test.adyen.com/v3",
"type": "string"
},
{
"key": "X-API-Key",
"value": "",
"type": "string"
},
{
"key": "YOUR_COMPANY_ACCOUNT",
"value": "",
"type": "string"
},
{
"key": "YOUR_MERCHANT_ACCOUNT",
"value": "",
"type": "string"
}
]
}
Reference in New Issue View Git Blame Copy Permalink