Adyen Companies API
The Companies API from Adyen — 29 operation(s) for companies.
Adyen Companies API is one of 202 APIs that Adyen publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Companies. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.
This API exposes 44 operations across 29 paths, and defines 99 schemas. It is described by OpenAPI 3.1.0, at version 6.
Requests are made against a single base URL, https://cal-test.adyen.com/cal/services/Account/v6.
44 operations
29 paths
99 schemas
2 DELETE24 GET6 PATCH12 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Adyen Companies API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as X-API-Key (ApiKeyAuth).
It accepts HTTP basic authentication (BasicAuth).
Paths & Operations 44
Across 29 paths, the API surfaces 44 operations — 2 DELETE, 24 GET, 6 PATCH, 12 POST. Each is listed below with its method, path, parameters, and response codes.
Companies 44
GET
/companies
Adyen Get a List of Company Accounts
GET
/companies/{companyId}
Adyen Get a Company Account
GET
/companies/{companyId}/androidApps
Adyen Get a List of Android Apps
POST
/companies/{companyId}/androidApps
Adyen Upload Android App
GET
/companies/{companyId}/androidApps/{id}
Adyen Get Android App
GET
/companies/{companyId}/androidCertificates
Adyen Get a List of Android Certificates
GET
/companies/{companyId}/apiCredentials
Adyen Get a List of API Credentials
POST
/companies/{companyId}/apiCredentials
Adyen Create an API Credential.
GET
/companies/{companyId}/apiCredentials/{apiCredentialId}
Adyen Get an API Credential
PATCH
/companies/{companyId}/apiCredentials/{apiCredentialId}
Adyen Update an API Credential.
GET
/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins
Adyen Get a List of Allowed Origins
POST
/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins
Adyen Create an Allowed Origin
DELETE
/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}
Adyen Delete an Allowed Origin
GET
/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}
Adyen Get an Allowed Origin
POST
/companies/{companyId}/apiCredentials/{apiCredentialId}/generateApiKey
Adyen Generate New API Key
POST
/companies/{companyId}/apiCredentials/{apiCredentialId}/generateClientKey
Adyen Generate New Client Key
GET
/companies/{companyId}/billingEntities
Adyen Get a List of Billing Entities
GET
/companies/{companyId}/merchants
Adyen Get a List of Merchant Accounts
GET
/companies/{companyId}/shippingLocations
Adyen Get a List of Shipping Locations
POST
/companies/{companyId}/shippingLocations
Adyen Create a Shipping Location
GET
/companies/{companyId}/terminalActions
Adyen Get a List of Terminal Actions
GET
/companies/{companyId}/terminalActions/{actionId}
Adyen Get Terminal Action
GET
/companies/{companyId}/terminalLogos
Adyen Get the Terminal Logo
PATCH
/companies/{companyId}/terminalLogos
Adyen Update the Terminal Logo
GET
/companies/{companyId}/terminalModels
Adyen Get a List of Terminal Models
GET
/companies/{companyId}/terminalOrders
Adyen Get a List of Orders
POST
/companies/{companyId}/terminalOrders
Adyen Create an Order
GET
/companies/{companyId}/terminalOrders/{orderId}
Adyen Get an Order
PATCH
/companies/{companyId}/terminalOrders/{orderId}
Adyen Update an Order
POST
/companies/{companyId}/terminalOrders/{orderId}/cancel
Adyen Cancel an Order
GET
/companies/{companyId}/terminalProducts
Adyen Get a List of Terminal Products
GET
/companies/{companyId}/terminalSettings
Adyen Get Terminal Settings
PATCH
/companies/{companyId}/terminalSettings
Adyen Update Terminal Settings
GET
/companies/{companyId}/users
Adyen Get a List of Users
POST
/companies/{companyId}/users
Adyen Create a New User
GET
/companies/{companyId}/users/{userId}
Adyen Get User Details
PATCH
/companies/{companyId}/users/{userId}
Adyen Update User Details
GET
/companies/{companyId}/webhooks
Adyen List All Webhooks
POST
/companies/{companyId}/webhooks
Adyen Set Up a Webhook
DELETE
/companies/{companyId}/webhooks/{webhookId}
Adyen Remove a Webhook
GET
/companies/{companyId}/webhooks/{webhookId}
Adyen Get a Webhook
PATCH
/companies/{companyId}/webhooks/{webhookId}
Adyen Update a Webhook
POST
/companies/{companyId}/webhooks/{webhookId}/generateHmac
Adyen Generate an HMAC Key
POST
/companies/{companyId}/webhooks/{webhookId}/test
Adyen Test a Webhook
Schemas 99
The contract defines 99 schemas that model the data the API accepts and returns. The most detailed are Webhook (22 properties), TerminalSettings (20 properties), Profile (18 properties), ReceiptPrinting (16 properties). Each schema is shown below with its type and property counts.
AndroidApp
object
8 properties
2 required
Passcodes
object
4 properties
ShippingLocation
object
4 properties
Notification
object
5 properties
Standalone
object
2 properties
Logo
object
1 property
OrderItem
object
4 properties
TerminalProduct
object
5 properties
WebhookLinks
object
5 properties
3 required
Gratuity
object
4 properties
Address
object
7 properties
BillingEntity
object
5 properties
MinorUnitsMonetaryValue
object
2 properties
AndroidAppsResponse
object
1 property
Key
object
3 properties
AdditionalSettings
object
2 properties
TapToPay
object
1 property
WifiProfiles
object
2 properties
Nexo
object
5 properties
Configuration
object
4 properties
2 required
EventUrl
object
2 properties
ListCompanyUsersResponse
object
4 properties
2 required
Links
object
1 property
1 required
CompanyApiCredential
object
10 properties
6 required
TerminalProductPrice
object
2 properties
GenerateClientKeyResponse
object
1 property
1 required
LinksElement
object
1 property
ReceiptPrinting
object
16 properties
CreateCompanyApiCredentialRequest
object
4 properties
IdName
object
2 properties
RestServiceError
object
9 properties
5 required
ListCompanyResponse
object
4 properties
2 required
TestWebhookResponse
object
1 property
Opi
object
3 properties
Payment
object
2 properties
ExternalTerminalAction
object
8 properties
GenerateHmacKeyResponse
object
1 property
1 required
TerminalModelsResponse
object
1 property
AndroidCertificate
object
7 properties
1 required
OfflineProcessing
object
2 properties
PayAtTable
object
3 properties
ApiCredentialLinks
object
6 properties
1 required
ListMerchantResponse
object
4 properties
2 required
Name2
object
2 properties
Url
object
4 properties
ReceiptOptions
object
3 properties
ShippingLocationsResponse
object
1 property
TerminalSettings
object
20 properties
InvalidField
object
3 properties
3 required
CreateCompanyWebhookRequest
object
16 properties
6 required
TestOutput
object
6 properties
1 required
AllowedOriginsResponse
object
1 property
JSONObject
object
CreateCompanyUserResponse
object
11 properties
5 required
ListExternalTerminalActionsResponse
object
1 property
Webhook
object
22 properties
4 required
TerminalOrdersResponse
object
1 property
CompanyUser
object
11 properties
5 required
AndroidCertificatesResponse
object
1 property
AllowedOrigin
object
3 properties
1 required
GenerateApiKeyResponse
object
1 property
1 required
CustomNotification
object
7 properties
NotificationUrl
object
2 properties
Name
object
2 properties
2 required
TerminalProductsResponse
object
1 property
TerminalOrderRequest
object
6 properties
ListWebhooksResponse
object
5 properties
2 required
TestCompanyWebhookRequest
object
3 properties
TerminalOrder
object
8 properties
CreateCompanyUserRequest
object
7 properties
3 required
Amount
object
2 properties
2 required
UploadAndroidAppResponse
object
1 property
CompanyLinks
object
4 properties
1 required
DataCenter
object
2 properties
Refunds
object
1 property
Settings
object
3 properties
CreateCompanyApiCredentialResponse
object
12 properties
9 required
ListCompanyApiCredentialsResponse
object
4 properties
2 required
UpdateCompanyApiCredentialRequest
object
5 properties
Contact
object
5 properties
UpdateCompanyWebhookRequest
object
15 properties
Merchant
object
14 properties
PaginationLinks
object
5 properties
3 required
Connectivity
object
1 property
Profile
object
18 properties
4 required
UpdateCompanyUserRequest
object
7 properties
Currency
object
3 properties
1 required
Localization
object
3 properties
File
object
2 properties
2 required
MerchantLinks
object
4 properties
1 required
BillingEntitiesResponse
object
1 property
Company
object
7 properties
Signature
object
4 properties
Hardware
object
3 properties
AdditionalSettingsResponse
object
3 properties
Surcharge
object
2 properties
Referenced
object
1 property
CardholderReceipt
object
1 property
Timeouts
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Adyen 12
Other APIs Adyen publishes across the network.
Adyen acceptDispute API
Adyen Account API
Adyen accountHolderBalance API
Adyen accountHolders API
Adyen accountHolderTransactionList API
Adyen Accounting Notifications API
Adyen Accounts API
Adyen adjustAuthorisation API
Adyen Admin API
Adyen Amount API
Adyen Apple API
Adyen applePay API
#Companies