openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 655 kB
JSON
{"openapi":"3.1.0","servers":[{"url":"https://management-test.adyen.com/v1"}],"info":{"contact":{"name":"Adyen Developer Experience team","url":"https://github.com/Adyen/adyen-openapi","x-twitter":"Adyen"},"description":"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/v1/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/v1\n```\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/release-notes/management-api) to find out what changed in this version!","termsOfService":"https://www.adyen.com/legal/terms-and-conditions","title":"Management API","version":"1","x-apisguru-categories":["payment"],"x-logo":{"url":"https://twitter.com/Adyen/profile_image?size=original"},"x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/Adyen/adyen-openapi/main/json/ManagementService-v1.json","version":"3.1"}],"x-providerName":"adyen.com","x-publicVersion":true,"x-serviceName":"ManagementService"},"tags":[{"name":"Account - company level"},{"name":"Account - merchant level"},{"name":"Account - store level"},{"name":"Payout settings - merchant level"},{"name":"Users - company level"},{"name":"Users - merchant level"},{"name":"My API credential"},{"name":"API credentials - company level"},{"name":"API credentials - merchant level"},{"name":"API key - company level"},{"name":"API key - merchant level"},{"name":"Client key - company level"},{"name":"Client key - merchant level"},{"name":"Allowed origins - company level"},{"name":"Allowed origins - merchant level"},{"name":"Webhooks - company level"},{"name":"Webhooks - merchant level"},{"name":"Payment methods - merchant level"},{"name":"Terminals - terminal level"},{"name":"Terminal actions - company level"},{"name":"Terminal actions - terminal level"},{"name":"Terminal orders - company level"},{"name":"Terminal orders - merchant level"},{"name":"Terminal settings - company level"},{"name":"Terminal settings - merchant level"},{"name":"Terminal settings - store level"},{"name":"Terminal settings - terminal level"},{"name":"Android files - company level"},{"name":"Split configuration - merchant level"}],"paths":{"/companies":{"get":{"description":"Returns the list of company accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\n* Management API—Account read","operationId":"get-companies","parameters":[{"description":"The number of the page to fetch.","in":"query","name":"pageNumber","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"The number of items to have on a page, maximum 100. The default is 10 items on a page.","in":"query","name":"pageSize","required":false,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-companies-success-200"}},"schema":{"$ref":"#/components/schemas/ListCompanyResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get a list of company accounts","tags":["Account - company level"],"x-methodName":"listCompanyAccounts","x-sortIndex":0}},"/companies/{companyId}":{"get":{"description":"Returns the company account specified in the path. Your API credential must have access to the company account. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Account read","operationId":"get-companies-companyId","parameters":[{"description":"The unique identifier of the company account.","in":"path","name":"companyId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-companies-companyId-success-200"}},"schema":{"$ref":"#/components/schemas/Company"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get a company account","tags":["Account - company level"],"x-methodName":"getCompanyAccount","x-sortIndex":0}},"/companies/{companyId}/androidApps":{"get":{"description":"Returns a list of the Android apps that are available for the company identified in the path. \nThese apps have been uploaded to Adyen and can be installed or uninstalled on Android payment terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Android files read\n* Management API—Android files read and write\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write","operationId":"get-companies-companyId-androidApps","parameters":[{"description":"The unique identifier of the company account.","in":"path","name":"companyId","required":true,"schema":{"type":"string"}},{"description":"The number of the page to fetch.","in":"query","name":"pageNumber","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"The number of items to have on a page, maximum 100. The default is 20 items on a page.","in":"query","name":"pageSize","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"The package name that uniquely identifies the Android app.","in":"query","name":"packageName","required":false,"schema":{"type":"string"}},{"description":"The version number of the app.","in":"query","name":"versionCode","required":false,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-companies-companyId-androidApps-success-200"}},"schema":{"$ref":"#/components/schemas/AndroidAppsResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get a list of Android apps","tags":["Android files - company level"],"x-methodName":"listAndroidApps","x-sortIndex":1}},"/companies/{companyId}/androidApps/{id}":{"get":{"description":"Returns the details of the Android app identified in the path. \nThese apps have been uploaded to Adyen and can be installed or uninstalled on Android payment terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Android files read\n* Management API—Android files read and write","operationId":"get-companies-companyId-androidApps-id","parameters":[{"description":"The unique identifier of the company account.","in":"path","name":"companyId","required":true,"schema":{"type":"string"}},{"description":"The unique identifier of the app.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AndroidApp"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get Android app","tags":["Android files - company level"],"x-methodName":"getAndroidApp","x-sortIndex":3}},"/companies/{companyId}/androidCertificates":{"get":{"description":"Returns a list of the Android certificates that are available for the company identified in the path.\nTypically, these certificates enable running apps on Android payment terminals. The certifcates in the list have been uploaded to Adyen and can be installed or uninstalled on Android terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Android files read\n* Management API—Android files read and write\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write","operationId":"get-companies-companyId-androidCertificates","parameters":[{"description":"The unique identifier of the company account.","in":"path","name":"companyId","required":true,"schema":{"type":"string"}},{"description":"The number of the page to fetch.","in":"query","name":"pageNumber","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"The number of items to have on a page, maximum 100. The default is 20 items on a page.","in":"query","name":"pageSize","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"The name of the certificate.","in":"query","name":"certificateName","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-companies-companyId-androidCertificates-success-200"}},"schema":{"$ref":"#/components/schemas/AndroidCertificatesResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get a list of Android certificates","tags":["Android files - company level"],"x-methodName":"listAndroidCertificates","x-sortIndex":2}},"/companies/{companyId}/apiCredentials":{"get":{"description":"Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the company account. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write","operationId":"get-companies-companyId-apiCredentials","parameters":[{"description":"The unique identifier of the company account.","in":"path","name":"companyId","required":true,"schema":{"type":"string"}},{"description":"The number of the page to fetch.","in":"query","name":"pageNumber","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"The number of items to have on a page, maximum 100. The default is 10 items on a page.","in":"query","name":"pageSize","required":false,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-companies-companyId-apiCredentials-success-200"}},"schema":{"$ref":"#/components/schemas/ListCompanyApiCredentialsResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get a list of API credentials","tags":["API credentials - company level"],"x-methodName":"listApiCredentials","x-sortIndex":0},"post":{"description":"Creates an [API credential](https://docs.adyen.com/development-resources/api-credentials) for the company account identified in the path. In the request, you can specify which merchant accounts the new API credential will have access to, as well as its roles and allowed origins.\n\nThe response includes several types of authentication details:\n* [API key](https://docs.adyen.com/development-resources/api-authentication#api-key-authentication): used for API request authentication.\n* [Client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works): public key used for client-side authentication.\n* [Username and password](https://docs.adyen.com/development-resources/api-authentication#using-basic-authentication): used for basic authentication.\n\n> Make sure you store the API key securely in your system. You won't be able to retrieve it later.\n\nIf your API key is lost or compromised, you need to [generate a new API key](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/apiCredentials/{apiCredentialId}/generateApiKey).\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write","operationId":"post-companies-companyId-apiCredentials","parameters":[{"description":"The unique identifier of the company account.","in":"path","name":"companyId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"post-company-credential":{"$ref":"#/components/examples/post-companies-companyId-apiCredentials-post-company-credential"}},"schema":{"$ref":"#/components/schemas/CreateCompanyApiCredentialRequest"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"post-company-credential":{"$ref":"#/components/examples/post-companies-companyId-apiCredentials-post-company-credential-200"}},"schema":{"$ref":"#/components/schemas/CreateCompanyApiCredentialResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Create an API credential.","tags":["API credentials - company level"],"x-methodName":"createApiCredential","x-sortIndex":0}},"/companies/{companyId}/apiCredentials/{apiCredentialId}":{"get":{"description":"Returns the [API credential](https://docs.adyen.com/development-resources/api-credentials) identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write","operationId":"get-companies-companyId-apiCredentials-apiCredentialId","parameters":[{"description":"The unique identifier of the company account.","in":"path","name":"companyId","required":true,"schema":{"type":"string"}},{"description":"Unique identifier of the API credential.","in":"path","name":"apiCredentialId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-companies-companyId-apiCredentials-apiCredentialId-success-200"}},"schema":{"$ref":"#/components/schemas/CompanyApiCredential"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get an API credential","tags":["API credentials - company level"],"x-methodName":"getApiCredential","x-sortIndex":0},"patch":{"description":"Changes the API credential's roles, merchant account access, or allowed origins. The request has the new values for the fields you want to change. The response contains the full updated API credential, including the new values from the request. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write","operationId":"patch-companies-companyId-apiCredentials-apiCredentialId","parameters":[{"description":"The unique identifier of the company account.","in":"path","name":"companyId","required":true,"schema":{"type":"string"}},{"description":"Unique identifier of the API credential.","in":"path","name":"apiCredentialId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"patch-company-credential":{"$ref":"#/components/examples/patch-companies-companyId-apiCredentials-apiCredentialId-patch-company-credential"}},"schema":{"$ref":"#/components/schemas/UpdateCompanyApiCredentialRequest"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"patch-company-credential":{"$ref":"#/components/examples/patch-companies-companyId-apiCredentials-apiCredentialId-patch-company-credential-200"}},"schema":{"$ref":"#/components/schemas/CompanyApiCredential"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Update an API credential.","tags":["API credentials - company level"],"x-methodName":"updateApiCredential","x-sortIndex":0}},"/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins":{"get":{"description":"Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write","operationId":"get-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins","parameters":[{"description":"The unique identifier of the company account.","in":"path","name":"companyId","required":true,"schema":{"type":"string"}},{"description":"Unique identifier of the API credential.","in":"path","name":"apiCredentialId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"get-allowed-origins":{"$ref":"#/components/examples/get-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-get-allowed-origins-200"}},"schema":{"$ref":"#/components/schemas/AllowedOriginsResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get a list of allowed origins","tags":["Allowed origins - company level"],"x-methodName":"listAllowedOrigins","x-sortIndex":0},"post":{"description":"Adds a new [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) to the API credential's list of allowed origins.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write","operationId":"post-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins","parameters":[{"description":"The unique identifier of the company account.","in":"path","name":"companyId","required":true,"schema":{"type":"string"}},{"description":"Unique identifier of the API credential.","in":"path","name":"apiCredentialId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"add-allowed-origin":{"$ref":"#/components/examples/post-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-add-allowed-origin"}},"schema":{"$ref":"#/components/schemas/AllowedOrigin"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"add-allowed-origin":{"$ref":"#/components/examples/post-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-add-allowed-origin-200"}},"schema":{"$ref":"#/components/schemas/AllowedOriginsResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Create an allowed origin","tags":["Allowed origins - company level"],"x-methodName":"createAllowedOrigin","x-sortIndex":0}},"/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}":{"delete":{"description":"Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. As soon as an allowed origin is removed, we no longer accept client-side requests from that domain.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write","operationId":"delete-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-originId","parameters":[{"description":"The unique identifier of the company account.","in":"path","name":"companyId","required":true,"schema":{"type":"string"}},{"description":"Unique identifier of the API credential.","in":"path","name":"apiCredentialId","required":true,"schema":{"type":"string"}},{"description":"Unique identifier of the allowed origin.","in":"path","name":"originId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content - look at the actual response code for the status of the request. "},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Delete an allowed origin","tags":["Allowed origins - company level"],"x-methodName":"deleteAllowedOrigin","x-sortIndex":0},"get":{"description":"Returns the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write","operationId":"get-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-originId","parameters":[{"description":"The unique identifier of the company account.","in":"path","name":"companyId","required":true,"schema":{"type":"string"}},{"description":"Unique identifier of the API credential.","in":"path","name":"apiCredentialId","required":true,"schema":{"type":"string"}},{"description":"Unique identifier of the allowed origin.","in":"path","name":"originId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"get-allowed-origin":{"$ref":"#/components/examples/get-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-originId-get-allowed-origin-200"}},"schema":{"$ref":"#/components/schemas/AllowedOrigin"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get an allowed origin","tags":["Allowed origins - company level"],"x-methodName":"getAllowedOrigin","x-sortIndex":0}},"/companies/{companyId}/apiCredentials/{apiCredentialId}/generateApiKey":{"post":{"description":"Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write","operationId":"post-companies-companyId-apiCredentials-apiCredentialId-generateApiKey","parameters":[{"description":"The unique identifier of the company account.","in":"path","name":"companyId","required":true,"schema":{"type":"string"}},{"description":"Unique identifier of the API credential.","in":"path","name":"apiCredentialId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateApiKeyResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Generate new API key","tags":["API key - company level"],"x-methodName":"generateNewApiKey","x-sortIndex":0}},"/companies/{companyId}/apiCredentials/{apiCredentialId}/generateClientKey":{"post":{"description":"Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write","operationId":"post-companies-companyId-apiCredentials-apiCredentialId-generateClientKey","parameters":[{"description":"The unique identifier of the company account.","in":"path","name":"companyId","required":true,"schema":{"type":"string"}},{"description":"Unique identifier of the API credential.","in":"path","name":"apiCredentialId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateClientKeyResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Generate new client key","tags":["Client key - company level"],"x-methodName":"generateNewClientKey","x-sortIndex":0}},"/companies/{companyId}/billingEntities":{"get":{"description":"Returns the billing entities of the company identified in the path and all merchant accounts belonging to the company.\nA billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write","operationId":"get-companies-companyId-billingEntities","parameters":[{"description":"The unique identifier of the company account.","in":"path","name":"companyId","required":true,"schema":{"type":"string"}},{"description":"The name of the billing entity.","in":"query","name":"name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-companies-companyId-billingEntities-success-200"}},"schema":{"$ref":"#/components/schemas/BillingEntitiesResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get a list of billing entities","tags":["Terminal orders - company level"],"x-methodName":"listBillingEntities","x-sortIndex":3}},"/companies/{companyId}/merchants":{"get":{"description":"Returns the list of merchant accounts under the company account specified in the path. The list only includes merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Account read","operationId":"get-companies-companyId-merchants","parameters":[{"description":"The unique identifier of the company account.","in":"path","name":"companyId","required":true,"schema":{"type":"string"}},{"description":"The number of the page to fetch.","in":"query","name":"pageNumber","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"The number of items to have on a page, maximum 100. The default is 10 items on a page.","in":"query","name":"pageSize","required":false,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-companies-companyId-merchants-success-200"}},"schema":{"$ref":"#/components/schemas/ListMerchantResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get a list of merchant accounts","tags":["Account - company level"],"x-methodName":"listMerchantAccounts","x-sortIndex":0}},"/companies/{companyId}/shippingLocations":{"get":{"description":"Returns the shipping locations for the company identified in the path and all merchant accounts belonging to the company.\nA shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write","operationId":"get-companies-companyId-shippingLocations","parameters":[{"description":"The unique identifier of the company account.","in":"path","name":"companyId","required":true,"schema":{"type":"string"}},{"description":"The name of the shipping location.","in":"query","name":"name","required":false,"schema":{"type":"string"}},{"description":"The number of locations to skip.","in":"query","name":"offset","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"The number of locations to return.","in":"query","name":"limit","required":false,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-companies-companyId-shippingLocations-success-200"}},"schema":{"$ref":"#/components/schemas/ShippingLocationsResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get a list of shipping locations","tags":["Terminal orders - company level"],"x-methodName":"listShippingLocations","x-sortIndex":4},"post":{"description":"Creates a shipping location for the company identified in the path. A shipping location defines an address where orders can be delivered.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write","operationId":"post-companies-companyId-shippingLocations","parameters":[{"description":"The unique identifier of the company account.","in":"path","name":"companyId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"create-shipping-location":{"$ref":"#/components/examples/post-companies-companyId-shippingLocations-create-shipping-location"}},"schema":{"$ref":"#/components/schemas/ShippingLocation"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"create-shipping-location":{"$ref":"#/components/examples/post-companies-companyId-shippingLocations-create-shipping-location-200"}},"schema":{"$ref":"#/components/schemas/ShippingLocation"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Create a shipping location","tags":["Terminal orders - company level"],"x-methodName":"createShippingLocation","x-sortIndex":5}},"/companies/{companyId}/terminalActions":{"get":{"description":"Returns the [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) that have been scheduled for the company identified in the path.The response doesn't include actions that are scheduled by Adyen.\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write","operationId":"get-companies-companyId-terminalActions","parameters":[{"description":"The unique identifier of the company account.","in":"path","name":"companyId","required":true,"schema":{"type":"string"}},{"description":"The number of the page to fetch.","in":"query","name":"pageNumber","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"The number of items to have on a page, maximum 100. The default is 20 items on a page.","in":"query","name":"pageSize","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"Returns terminal actions with the specified status. \nAllowed values: **pending**, **successful**, **failed**, **cancelled**, **tryLater**.","in":"query","name":"status","required":false,"schema":{"type":"string"}},{"description":"Returns terminal actions of the specified type. \nAllowed values: **InstallAndroidApp**, **UninstallAndroidApp**, **InstallAndroidCertificate**, **UninstallAndroidCertificate**.","in":"query","name":"type","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-companies-companyId-terminalActions-success-200"}},"schema":{"$ref":"#/components/schemas/ListExternalTerminalActionsResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could n