Adyen Management API
Configure and manage your Adyen company and merchant accounts, stores, and payment terminals.
OpenAPI Specification
openapi: 3.1.0
servers:
- url: https://management-test.adyen.com/v3
info:
version: '3'
x-publicVersion: true
title: Adyen Management API
description: >-
Configure and manage your Adyen company and merchant accounts, stores, and
payment terminals.
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
tags:
- name: Companies
- name: Me
- name: Merchants
- name: Stores
- name: Terminals
paths:
/companies:
get:
tags:
- Companies
summary: Adyen Get a List of Company Accounts
description: >-
Returns the list of company accounts that your API credential has access
to. The list is grouped into pages as defined by the query parameters.
To make this request, your API credential must have the following
[roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):
* Management API—Account read
operationId: get-companies
x-sortIndex: 0
x-methodName: listCompanyAccounts
security:
- BasicAuth: []
- ApiKeyAuth: []
parameters:
- description: The number of the page to fetch.
name: pageNumber
in: query
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.
name: pageSize
in: query
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'
examples:
get-companies400Example:
summary: Default get-companies 400 response
x-microcks-default: true
value:
detail: example_value
errorCode: CODE123
instance: example_value
invalidFields:
- example_value
requestId: '500123'
response: example_value
status: 500
title: example_value
type: standard
description: Bad Request - a problem reading or understanding the request.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
examples:
get-companies401Example:
summary: Default get-companies 401 response
x-microcks-default: true
value:
detail: example_value
errorCode: CODE123
instance: example_value
invalidFields:
- example_value
requestId: '500123'
response: example_value
status: 500
title: example_value
type: standard
description: Unauthorized - authentication required.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
examples:
get-companies403Example:
summary: Default get-companies 403 response
x-microcks-default: true
value:
detail: example_value
errorCode: CODE123
instance: example_value
invalidFields:
- example_value
requestId: '500123'
response: example_value
status: 500
title: example_value
type: standard
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
examples:
get-companies422Example:
summary: Default get-companies 422 response
x-microcks-default: true
value:
detail: example_value
errorCode: CODE123
instance: example_value
invalidFields:
- example_value
requestId: '500123'
response: example_value
status: 500
title: example_value
type: standard
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
examples:
get-companies500Example:
summary: Default get-companies 500 response
x-microcks-default: true
value:
detail: example_value
errorCode: CODE123
instance: example_value
invalidFields:
- example_value
requestId: '500123'
response: example_value
status: 500
title: example_value
type: standard
description: Internal Server Error - the server could not process the request.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/companies/{companyId}:
get:
tags:
- Companies
summary: Adyen Get a Company Account
description: >-
Returns the company account specified in the path. Your API credential
must have access to the company account.
To make this request, your API credential must have the following
[roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):
* Management API—Account read
operationId: get-companies-companyId
x-sortIndex: 0
x-methodName: getCompanyAccount
security:
- BasicAuth: []
- ApiKeyAuth: []
parameters:
- description: The unique identifier of the company account.
name: companyId
in: path
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'
examples:
get-companies-companyId400Example:
summary: Default get-companies-companyId 400 response
x-microcks-default: true
value:
detail: example_value
errorCode: CODE123
instance: example_value
invalidFields:
- example_value
requestId: '500123'
response: example_value
status: 500
title: example_value
type: standard
description: Bad Request - a problem reading or understanding the request.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
examples:
get-companies-companyId401Example:
summary: Default get-companies-companyId 401 response
x-microcks-default: true
value:
detail: example_value
errorCode: CODE123
instance: example_value
invalidFields:
- example_value
requestId: '500123'
response: example_value
status: 500
title: example_value
type: standard
description: Unauthorized - authentication required.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
examples:
get-companies-companyId403Example:
summary: Default get-companies-companyId 403 response
x-microcks-default: true
value:
detail: example_value
errorCode: CODE123
instance: example_value
invalidFields:
- example_value
requestId: '500123'
response: example_value
status: 500
title: example_value
type: standard
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
examples:
get-companies-companyId422Example:
summary: Default get-companies-companyId 422 response
x-microcks-default: true
value:
detail: example_value
errorCode: CODE123
instance: example_value
invalidFields:
- example_value
requestId: '500123'
response: example_value
status: 500
title: example_value
type: standard
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
examples:
get-companies-companyId500Example:
summary: Default get-companies-companyId 500 response
x-microcks-default: true
value:
detail: example_value
errorCode: CODE123
instance: example_value
invalidFields:
- example_value
requestId: '500123'
response: example_value
status: 500
title: example_value
type: standard
description: Internal Server Error - the server could not process the request.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/companies/{companyId}/androidApps:
get:
tags:
- Companies
summary: Adyen Get a List of Android Apps
description: >-
Returns a list of the Android apps that are available for the company
identified in the path.
These apps have been uploaded to Adyen and can be installed or
uninstalled on Android payment terminals through [terminal
actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).
To make this request, your API credential must have one of the following
[roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):
* Management API—Android files read
* Management API—Android files read and write
* Management API—Terminal actions read
* Management API—Terminal actions read and write
operationId: get-companies-companyId-androidApps
x-sortIndex: 1
x-methodName: listAndroidApps
security:
- BasicAuth: []
- ApiKeyAuth: []
parameters:
- description: The unique identifier of the company account.
name: companyId
in: path
required: true
schema:
type: string
- description: The number of the page to fetch.
name: pageNumber
in: query
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.
name: pageSize
in: query
required: false
schema:
format: int32
type: integer
- description: The package name that uniquely identifies the Android app.
name: packageName
in: query
required: false
schema:
type: string
- description: The version number of the app.
name: versionCode
in: query
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'
examples:
get-companies-companyId-androidApps400Example:
summary: Default get-companies-companyId-androidApps 400 response
x-microcks-default: true
value:
detail: example_value
errorCode: CODE123
instance: example_value
invalidFields:
- example_value
requestId: '500123'
response: example_value
status: 500
title: example_value
type: standard
description: Bad Request - a problem reading or understanding the request.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
examples:
get-companies-companyId-androidApps401Example:
summary: Default get-companies-companyId-androidApps 401 response
x-microcks-default: true
value:
detail: example_value
errorCode: CODE123
instance: example_value
invalidFields:
- example_value
requestId: '500123'
response: example_value
status: 500
title: example_value
type: standard
description: Unauthorized - authentication required.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
examples:
get-companies-companyId-androidApps403Example:
summary: Default get-companies-companyId-androidApps 403 response
x-microcks-default: true
value:
detail: example_value
errorCode: CODE123
instance: example_value
invalidFields:
- example_value
requestId: '500123'
response: example_value
status: 500
title: example_value
type: standard
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
examples:
get-companies-companyId-androidApps422Example:
summary: Default get-companies-companyId-androidApps 422 response
x-microcks-default: true
value:
detail: example_value
errorCode: CODE123
instance: example_value
invalidFields:
- example_value
requestId: '500123'
response: example_value
status: 500
title: example_value
type: standard
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
examples:
get-companies-companyId-androidApps500Example:
summary: Default get-companies-companyId-androidApps 500 response
x-microcks-default: true
value:
detail: example_value
errorCode: CODE123
instance: example_value
invalidFields:
- example_value
requestId: '500123'
response: example_value
status: 500
title: example_value
type: standard
description: Internal Server Error - the server could not process the request.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
tags:
- Companies
summary: Adyen Upload Android App
description: >-
Uploads an Android APK file to Adyen.
The maximum APK file size is 200 MB.
To make this request, your API credential must have the following
[role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):
* Management API—Android files read and write
>By choosing to upload, install, or run any third-party applications on
an Adyen payment terminal, you accept full responsibility and liability
for any consequences of uploading, installing, or running any such
applications.
x-addedInVersion: '3'
operationId: post-companies-companyId-androidApps
x-sortIndex: 4
x-methodName: uploadAndroidApp
security:
- BasicAuth: []
- ApiKeyAuth: []
parameters:
- description: The unique identifier of the company account.
name: companyId
in: path
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UploadAndroidAppResponse'
examples:
post-companies-companyId-androidApps200Example:
summary: Default post-companies-companyId-androidApps 200 response
x-microcks-default: true
value:
id: '500123'
description: OK - the request has succeeded.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
examples:
post-companies-companyId-androidApps400Example:
summary: Default post-companies-companyId-androidApps 400 response
x-microcks-default: true
value:
detail: example_value
errorCode: CODE123
instance: example_value
invalidFields:
- example_value
requestId: '500123'
response: example_value
status: 500
title: example_value
type: standard
description: Bad Request - a problem reading or understanding the request.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
examples:
post-companies-companyId-androidApps401Example:
summary: Default post-companies-companyId-androidApps 401 response
x-microcks-default: true
value:
detail: example_value
errorCode: CODE123
instance: example_value
invalidFields:
- example_value
requestId: '500123'
response: example_value
status: 500
title: example_value
type: standard
description: Unauthorized - authentication required.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
examples:
post-companies-companyId-androidApps403Example:
summary: Default post-companies-companyId-androidApps 403 response
x-microcks-default: true
value:
detail: example_value
errorCode: CODE123
instance: example_value
invalidFields:
- example_value
requestId: '500123'
response: example_value
status: 500
title: example_value
type: standard
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
examples:
post-companies-companyId-androidApps422Example:
summary: Default post-companies-companyId-androidApps 422 response
x-microcks-default: true
value:
detail: example_value
errorCode: CODE123
instance: example_value
invalidFields:
- example_value
requestId: '500123'
response: example_value
status: 500
title: example_value
type: standard
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
examples:
post-companies-companyId-androidApps500Example:
summary: Default post-companies-companyId-androidApps 500 response
x-microcks-default: true
value:
detail: example_value
errorCode: CODE123
instance: example_value
invalidFields:
- example_value
requestId: '500123'
response: example_value
status: 500
title: example_value
type: standard
description: Internal Server Error - the server could not process the request.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/companies/{companyId}/androidApps/{id}:
get:
tags:
- Companies
summary: Adyen Get Android App
description: >-
Returns the details of the Android app identified in the path.
These apps have been uploaded to Adyen and can be installed or
uninstalled on Android payment terminals through [terminal
actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).
To make this request, your API credential must have one of the following
[roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):
* Management API—Android files read
* Management API—Android files read and write
operationId: get-companies-companyId-androidApps-id
x-sortIndex: 3
x-methodName: getAndroidApp
security:
- BasicAuth: []
- ApiKeyAuth: []
parameters:
- description: The unique identifier of the company account.
name: companyId
in: path
required: true
schema:
type: string
- description: The unique identifier of the app.
name: id
in: path
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AndroidApp'
examples:
get-companies-companyId-androidApps-id200Example:
summary: Default get-companies-companyId-androidApps-id 200 response
x-microcks-default: true
value:
description: A sample description for this resource.
errorCode: CODE123
id: '500123'
label: example_value
packageName: Example Name
status: active
versionCode: 500
versionName: Example Name
description: OK - the request has succeeded.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
examples:
get-companies-companyId-androidApps-id400Example:
summary: Default get-companies-companyId-androidApps-id 400 response
x-microcks-default: true
value:
detail: example_value
errorCode: CODE123
instance: example_value
invalidFields:
- example_value
requestId: '500123'
response: example_value
status: 500
title: example_value
type: standard
description: Bad Request - a problem reading or understanding the request.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
examples:
get-companies-companyId-androidApps-id401Example:
summary: Default get-companies-companyId-androidApps-id 401 response
x-microcks-default: true
value:
detail: example_value
errorCode: CODE123
instance: example_value
invalidFields:
- example_value
requestId: '500123'
response: example_value
status: 500
title: example_value
type: standard
description: Unauthorized - authentication required.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
examples:
get-companies-companyId-androidApps-id403Example:
summary: Default get-companies-companyId-androidApps-id 403 response
x-microcks-default: true
value:
detail: example_value
errorCode: CODE123
instance: example_value
invalidFields:
- example_value
requestId: '500123'
response: example_value
status: 500
title: example_value
type: standard
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
examples:
get-companies-companyId-androidApps-id422Example:
summary: Default get-companies-companyId-androidApps-id 422 response
x-microcks-default: true
value:
detail: example_value
errorCode: CODE123
instance: example_value
invalidFields:
- example_value
requestId: '500123'
response: example_value
status: 500
title: example_value
type: standard
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
examples:
get-companies-companyId-androidApps-id500Example:
summary: Default get-companies-companyId-androidApps-id 500 response
x-microcks-default: true
value:
detail: example_value
errorCode: CODE123
instance: example_value
invalidFields:
- example_value
requestId: '500123'
response: example_value
status: 500
title: example_value
type: standard
description: Internal Server Error - the server could not process the request.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/companies/{companyId}/androidCertificates:
get:
tags:
- Companies
summary: Adyen Get a List of Android Certificates
description: >-
Returns a list of the Android certificates that are available for the
company identified in the path.
Typically, these certificates enable running apps on Android payment
terminals. The certifcates in the list have been uploaded to Adyen and
can be installed or uninstalled on Android terminals through [terminal
actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).
To make this request, your API credential must have one of the following
[roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):
* Management API—Android files read
* Management API—Android files read and write
* Management API—Terminal actions read
* Management API—Terminal actions read and write
operationId: get-companies-companyId-androidCertificates
x-sortIndex: 2
x-methodName: listAndroidCertificates
security:
- BasicAuth: []
- ApiKeyAuth: []
parameters:
- description: The unique identifier of the company account.
name: companyId
in: path
required: true
schema:
type: string
- description: The number of the page to fetch.
name: pageNumber
in: query
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.
name: pageSize
in: query
required: false
schema:
format: int32
type: integer
- description: The name of the certificate.
name: certificateName
in: query
required: false
schema:
type: string
responses:
'200':
content:
application/json:
# --- truncated at 32 KB (1257 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/openapi/management-openapi-original.yml