{ "opencollection": "1.0.0", "info": { "name": "Adyen Account acceptDispute Companies API", "version": "6" }, "items": [ { "info": { "name": "Companies", "type": "folder" }, "items": [ { "info": { "name": "Adyen Get a List of Company Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "The number of the page to fetch." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the list of company accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\n* Management API—Account read" }, { "info": { "name": "Adyen Get a Company Account", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the company account specified in the path. Your API credential must have access to the company account. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Account read" }, { "info": { "name": "Adyen Get a List of Android Apps", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/androidApps", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The number of the page to fetch." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to have on a page, maximum 100. The default is 20 items on a page." }, { "name": "packageName", "value": "", "type": "query", "description": "The package name that uniquely identifies the Android app." }, { "name": "versionCode", "value": "", "type": "query", "description": "The version number of the app." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a list of the Android apps that are available for the company identified in the path. \nThese apps have been uploaded to Adyen and can be installed or uninstalled on Android payment terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Andro" }, { "info": { "name": "Adyen Upload Android App", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/androidApps", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Uploads an Android APK file to Adyen.\nThe maximum APK file size is 200 MB.\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Android files read and write\n\n>By choosing to upload, install, or run any third-party applications on an Adyen payment terminal, you accept full responsibility and liability for any consequences of uploading, installing, or running any such applications." }, { "info": { "name": "Adyen Get Android App", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/androidApps/:id", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "id", "value": "", "type": "path", "description": "The unique identifier of the app." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the details of the Android app identified in the path. \nThese apps have been uploaded to Adyen and can be installed or uninstalled on Android payment terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Android files read\n* Management API—" }, { "info": { "name": "Adyen Get a List of Android Certificates", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/androidCertificates", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The number of the page to fetch." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to have on a page, maximum 100. The default is 20 items on a page." }, { "name": "certificateName", "value": "", "type": "query", "description": "The name of the certificate." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a list of the Android certificates that are available for the company identified in the path.\nTypically, these certificates enable running apps on Android payment terminals. The certifcates in the list have been uploaded to Adyen and can be installed or uninstalled on Android terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\nTo make this request, your API credential must have one of the following [roles](https" }, { "info": { "name": "Adyen Get a List of API Credentials", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/apiCredentials", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The number of the page to fetch." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the company account. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write" }, { "info": { "name": "Adyen Create an API Credential.", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/apiCredentials", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Creates an [API credential](https://docs.adyen.com/development-resources/api-credentials) for the company account identified in the path. In the request, you can specify which merchant accounts the new API credential will have access to, as well as its roles and allowed origins.\n\nThe response includes several types of authentication details:\n* [API key](https://docs.adyen.com/development-resources/api-authentication#api-key-authentication): used for API request authentication.\n* [Client key](htt" }, { "info": { "name": "Adyen Get an API Credential", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/apiCredentials/:apiCredentialId", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "apiCredentialId", "value": "", "type": "path", "description": "Unique identifier of the API credential." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the [API credential](https://docs.adyen.com/development-resources/api-credentials) identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write" }, { "info": { "name": "Adyen Update an API Credential.", "type": "http" }, "http": { "method": "PATCH", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/apiCredentials/:apiCredentialId", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "apiCredentialId", "value": "", "type": "path", "description": "Unique identifier of the API credential." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Changes the API credential's roles, merchant account access, or allowed origins. The request has the new values for the fields you want to change. The response contains the full updated API credential, including the new values from the request. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write" }, { "info": { "name": "Adyen Get a List of Allowed Origins", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "apiCredentialId", "value": "", "type": "path", "description": "Unique identifier of the API credential." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write" }, { "info": { "name": "Adyen Create an Allowed Origin", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "apiCredentialId", "value": "", "type": "path", "description": "Unique identifier of the API credential." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Adds a new [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) to the API credential's list of allowed origins.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write" }, { "info": { "name": "Adyen Get an Allowed Origin", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "apiCredentialId", "value": "", "type": "path", "description": "Unique identifier of the API credential." }, { "name": "originId", "value": "", "type": "path", "description": "Unique identifier of the allowed origin." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write" }, { "info": { "name": "Adyen Delete an Allowed Origin", "type": "http" }, "http": { "method": "DELETE", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "apiCredentialId", "value": "", "type": "path", "description": "Unique identifier of the API credential." }, { "name": "originId", "value": "", "type": "path", "description": "Unique identifier of the allowed origin." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. As soon as an allowed origin is removed, we no longer accept client-side requests from that domain.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write" }, { "info": { "name": "Adyen Generate New API Key", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/apiCredentials/:apiCredentialId/generateApiKey", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "apiCredentialId", "value": "", "type": "path", "description": "Unique identifier of the API credential." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write" }, { "info": { "name": "Adyen Generate New Client Key", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/apiCredentials/:apiCredentialId/generateClientKey", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "apiCredentialId", "value": "", "type": "path", "description": "Unique identifier of the API credential." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write" }, { "info": { "name": "Adyen Get a List of Billing Entities", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/billingEntities", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "name", "value": "", "type": "query", "description": "The name of the billing entity." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the billing entities of the company identified in the path and all merchant accounts belonging to the company.\nA billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and wr" }, { "info": { "name": "Adyen Get a List of Merchant Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/merchants", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The number of the page to fetch." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the list of merchant accounts under the company account specified in the path. The list only includes merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Account read" }, { "info": { "name": "Adyen Get a List of Shipping Locations", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/shippingLocations", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "name", "value": "", "type": "query", "description": "The name of the shipping location." }, { "name": "offset", "value": "", "type": "query", "description": "The number of locations to skip." }, { "name": "limit", "value": "", "type": "query", "description": "The number of locations to return." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the shipping locations for the company identified in the path and all merchant accounts belonging to the company.\nA shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering r" }, { "info": { "name": "Adyen Create a Shipping Location", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/shippingLocations", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Creates a shipping location for the company identified in the path. A shipping location defines an address where orders can be delivered.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write" }, { "info": { "name": "Adyen Get a List of Terminal Actions", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/terminalActions", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The number of the page to fetch." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to have on a page, maximum 100. The default is 20 items on a page." }, { "name": "status", "value": "", "type": "query", "description": "Returns terminal actions with the specified status. \nAllowed values: **pending**, **successful**, **failed**, **cancelled**, **tryLater**." }, { "name": "type", "value": "", "type": "query", "description": "Returns terminal actions of the specified type. \nAllowed values: **InstallAndroidApp**, **UninstallAndroidApp**, **InstallAndroidCertificate**, **UninstallAndroidCertificate**." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) that have been scheduled for the company identified in the path.The response doesn't include actions that are scheduled by Adyen.\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write" }, { "info": { "name": "Adyen Get Terminal Action", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/terminalActions/:actionId", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "actionId", "value": "", "type": "path", "description": "The unique identifier of the terminal action." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the details of the [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) identified in the path.\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write" }, { "info": { "name": "Adyen Get the Terminal Logo", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/terminalLogos", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "model", "value": "", "type": "query", "description": "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the logo that is configured for a specific payment terminal model at the company identified in the path. \n\nThe logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. \nThis logo applies to all terminals of the specified model under the company, unless a different logo is configured at a lower level (merchant account, store, or individual terminal).\n\nTo make this request, your API credential must have one of the following [roles](htt" }, { "info": { "name": "Adyen Update the Terminal Logo", "type": "http" }, "http": { "method": "PATCH", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/terminalLogos", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "model", "value": "", "type": "query", "description": "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Updates the logo that is configured for a specific payment terminal model at the company identified in the path. You can update the logo for only one terminal model at a time.\nThis logo applies to all terminals of the specified model under the company, unless a different logo is configured at a lower level (merchant account, store, or individual terminal). \n* To change the logo, specify the image file as a Base64-encoded string.\n* To restore the logo inherited from the Adyen PSP level, specify a" }, { "info": { "name": "Adyen Get a List of Terminal Models", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/terminalModels", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a list of payment terminal models that the company identified in the path has access to.\nThe response includes the terminal model ID, which can be used as a query parameter when getting a list of terminals or a list of products for ordering.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write" }, { "info": { "name": "Adyen Get a List of Orders", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/terminalOrders", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "customerOrderReference", "value": "", "type": "query", "description": "Your purchase order number." }, { "name": "status", "value": "", "type": "query", "description": "The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered." }, { "name": "offset", "value": "", "type": "query", "description": "The number of orders to skip." }, { "name": "limit", "value": "", "type": "query", "description": "The number of orders to return." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a lists of terminal products orders for the company identified in the path.\nTo filter the list, use one or more of the query parameters.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write" }, { "info": { "name": "Adyen Create an Order", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/terminalOrders", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Creates an order for payment terminal products for the company identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write\n>Requests to the Management API test endpoint do not create actual orders for test terminals. To order test terminals, you need to [submit a sales order](https://docs.adyen.com/point-of-sale/managing-terminals/" }, { "info": { "name": "Adyen Get an Order", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/terminalOrders/:orderId", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "orderId", "value": "", "type": "path", "description": "The unique identifier of the order." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the details of the terminal products order identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write" }, { "info": { "name": "Adyen Update an Order", "type": "http" }, "http": { "method": "PATCH", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/terminalOrders/:orderId", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "orderId", "value": "", "type": "path", "description": "The unique identifier of the order." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Updates the terminal products order identified in the path.\nUpdating is only possible while the order has the status **Placed**.\n\nThe request body only needs to contain what you want to change. \nHowever, to update the products in the `items` array, you must provide the entire array. For example, if the array has three items:\n To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items.\n\nTo make this request, your API credential mu" }, { "info": { "name": "Adyen Cancel an Order", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/terminalOrders/:orderId/cancel", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "orderId", "value": "", "type": "path", "description": "The unique identifier of the order." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Cancels the terminal products order identified in the path.\nCancelling is only possible while the order has the status **Placed**.\nTo cancel an order, make a POST call without a request body. The response returns the full order details, but with the status changed to **Cancelled**.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write" }, { "info": { "name": "Adyen Get a List of Terminal Products", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/terminalProducts", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "country", "value": "", "type": "query", "description": "The country to return products for, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US**" }, { "name": "terminalModelId", "value": "", "type": "query", "description": "The terminal model to return products for. Use the ID returned in the [GET `/terminalModels`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/companies/{companyId}/terminalModels) response. For example, **Verifone.M400**" }, { "name": "offset", "value": "", "type": "query", "description": "The number of products to skip." }, { "name": "limit", "value": "", "type": "query", "description": "The number of products to return." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a country-specific list of payment terminal packages and parts that the company identified in the path has access to.\n \nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write" }, { "info": { "name": "Adyen Get Terminal Settings", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/terminalSettings", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the payment terminal settings that are configured for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level (merchant account, store, or individual terminal).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings re" }, { "info": { "name": "Adyen Update Terminal Settings", "type": "http" }, "http": { "method": "PATCH", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/terminalSettings", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Updates payment terminal settings for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level (merchant account, store, or individual terminal).\n\n* To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.\n* To restore a parameter value inherited from the Adyen PSP level, include the full object that contains the param" }, { "info": { "name": "Adyen Get a List of Users", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/users", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The number of the page to return." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to have on a page. Maximum value is **100**. The default is **10** items on a page." }, { "name": "username", "value": "", "type": "query", "description": "The partial or complete username to select all users that match." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the list of users for the `companyId` identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n" }, { "info": { "name": "Adyen Create a New User", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/users", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Creates the user for the `companyId` identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n" }, { "info": { "name": "Adyen Get User Details", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/users/:userId", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "userId", "value": "", "type": "path", "description": "The unique identifier of the user." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns user details for the `userId` and the `companyId` identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n" }, { "info": { "name": "Adyen Update User Details", "type": "http" }, "http": { "method": "PATCH", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/users/:userId", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "userId", "value": "", "type": "path", "description": "The unique identifier of the user." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Updates user details for the `userId` and the `companyId` identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n" }, { "info": { "name": "Adyen List All Webhooks", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/webhooks", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account)." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The number of the page to fetch." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Lists all webhook configurations for the company account.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read\n* Management API—Webhooks read and write" }, { "info": { "name": "Adyen Set Up a Webhook", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/webhooks", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account)." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Subscribe to receive webhook notifications about events related to your company account. You can add basic authentication to make sure the data is secure.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write" }, { "info": { "name": "Adyen Get a Webhook", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/webhooks/:webhookId", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account)." }, { "name": "webhookId", "value": "", "type": "path", "description": "Unique identifier of the webhook configuration." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the configuration for the webhook identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read\n* Management API—Webhooks read and write" }, { "info": { "name": "Adyen Update a Webhook", "type": "http" }, "http": { "method": "PATCH", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/webhooks/:webhookId", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "webhookId", "value": "", "type": "path", "description": "Unique identifier of the webhook configuration." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Make changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration. The response contains the full configuration for the webhook, which includes the new values from the request.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write" }, { "info": { "name": "Adyen Remove a Webhook", "type": "http" }, "http": { "method": "DELETE", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/webhooks/:webhookId", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "webhookId", "value": "", "type": "path", "description": "Unique identifier of the webhook configuration." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Remove the configuration for the webhook identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write" }, { "info": { "name": "Adyen Generate an HMAC Key", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/webhooks/:webhookId/generateHmac", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "webhookId", "value": "", "type": "path", "description": "Unique identifier of the webhook configuration." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "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-signatu" }, { "info": { "name": "Adyen Test a Webhook", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/companies/:companyId/webhooks/:webhookId/test", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier of the company account." }, { "name": "webhookId", "value": "", "type": "path", "description": "Unique identifier of the webhook configuration." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Sends sample notifications to test if the webhook is set up correctly.\n\nWe send sample notifications for maximum 20 of the merchant accounts that the webhook is configured for. If the webhook is configured for more than 20 merchant accounts, use the `merchantIds` array to specify a subset of the merchant accounts for which to send test notifications.\n\nWe send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP" } ] } ], "bundled": true }