ManagementAPI credentialsA P I credentials company level
Get a list of API credentials
Returns the list of API credentials for the company account. The list is grouped into pages as defined by the query parameters.
To make this request, your API credential must have the following roles:
- Management API—API credentials read and write
AuthorizationBasic <token>
In: header
Path Parameters
companyId*string
The unique identifier of the company account.
Query Parameters
pageNumber?integer
The number of the page to fetch.
Format
int32pageSize?integer
The number of items to have on a page, maximum 100. The default is 10 items on a page.
Format
int32Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/companies/string/apiCredentials"Example response when your API credential has access to 25 API credentials at the company level
{ "_links": { "first": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials?pageNumber=1&pageSize=10" }, "last": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials?pageNumber=3&pageSize=10" }, "next": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials?pageNumber=2&pageSize=10" }, "self": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials?pageNumber=1&pageSize=10" } }, "itemsTotal": 25, "pagesTotal": 3, "data": [ { "id": "YOUR_API_CREDENTIAL_1", "username": "YOUR_USERNAME_1", "clientKey": "YOUR_CLIENT_KEY_1", "allowedIpAddresses": [], "roles": [ "Checkout encrypted cardholder data", "Merchant Recurring role", "Checkout webservice role" ], "active": true, "allowedOrigins": [ { "id": "YOUR_ALLOWED_ORIGIN_1", "domain": "http://localhost", "_links": { "self": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_1/allowedOrigins/YOUR_ALLOWED_ORIGIN_1" } } }, { "id": "YOUR_ALLOWED_ORIGIN_2", "domain": "http://localhost:3000", "_links": { "self": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_1/allowedOrigins/YOUR_ALLOWED_ORIGIN_2" } } } ], "_links": { "self": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_1" }, "allowedOrigins": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_1/allowedOrigins" }, "company": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT" }, "generateApiKey": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_1/generateApiKey" }, "generateClientKey": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_1/generateClientKey" } }, "associatedMerchantAccounts": [] }, { "id": "YOUR_API_CREDENTIAL_2", "username": "YOUR_USERNAME_2", "clientKey": "YOUR_CLIENT_KEY_2", "allowedIpAddresses": [], "roles": [ "Checkout encrypted cardholder data", "Merchant Recurring role", "Checkout webservice role" ], "active": true, "_links": { "self": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_2" }, "allowedOrigins": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_2/allowedOrigins" }, "company": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT" }, "generateApiKey": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_2/generateApiKey" }, "generateClientKey": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_2/generateClientKey" } }, "associatedMerchantAccounts": [] }, { "id": "YOUR_API_CREDENTIAL_3", "username": "YOUR_USERNAME_3", "clientKey": "YOUR_CLIENT_KEY_3", "allowedIpAddresses": [], "roles": [ "API Supply MPI data with Payments", "Checkout encrypted cardholder data", "Merchant Recurring role", "API PCI Payments role", "Checkout webservice role", "API 3DS 2.0 to retrieve the ThreeDS2Result for authentication only" ], "active": true, "_links": { "self": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_3" }, "allowedOrigins": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_3/allowedOrigins" }, "company": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT" }, "generateApiKey": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_3/generateApiKey" }, "generateClientKey": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_3/generateClientKey" } }, "associatedMerchantAccounts": [] }, { "id": "YOUR_API_CREDENTIAL_4", "username": "YOUR_USERNAME_4", "clientKey": "YOUR_CLIENT_KEY_4", "allowedIpAddresses": [], "roles": [ "Checkout encrypted cardholder data", "Checkout webservice role" ], "active": true, "_links": { "self": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_4" }, "allowedOrigins": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_4/allowedOrigins" }, "company": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT" }, "generateApiKey": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_4/generateApiKey" }, "generateClientKey": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_4/generateClientKey" } }, "associatedMerchantAccounts": [ "YOUR_MERCHANT_ACCOUNT_1" ] }, { "id": "YOUR_API_CREDENTIAL_5", "username": "YOUR_USERNAME_5", "clientKey": "YOUR_CLIENT_KEY_5", "allowedIpAddresses": [], "roles": [ "Checkout encrypted cardholder data", "Merchant Recurring role", "API Authorise Referred Payments", "API PCI Payments role", "Checkout webservice role", "Merchant PAL Webservice role" ], "active": true, "_links": { "self": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_5" }, "allowedOrigins": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_5/allowedOrigins" }, "company": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT" }, "generateApiKey": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_5/generateApiKey" }, "generateClientKey": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_5/generateClientKey" } }, "associatedMerchantAccounts": [] }, { "id": "YOUR_API_CREDENTIAL_6", "username": "YOUR_USERNAME_6", "clientKey": "YOUR_CLIENT_KEY_6", "allowedIpAddresses": [], "roles": [ "Merchant Report Download role" ], "active": true, "_links": { "self": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_6" }, "allowedOrigins": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_6/allowedOrigins" }, "company": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT" }, "generateApiKey": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_6/generateApiKey" }, "generateClientKey": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_6/generateClientKey" } }, "associatedMerchantAccounts": [] }, { "id": "YOUR_API_CREDENTIAL_7", "username": "YOUR_USERNAME_7", "clientKey": "YOUR_CLIENT_KEY_7", "allowedIpAddresses": [], "roles": [ "Merchant Report Download role" ], "active": true, "_links": { "self": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_7" }, "allowedOrigins": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_7/allowedOrigins" }, "company": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT" }, "generateApiKey": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_7/generateApiKey" }, "generateClientKey": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_7/generateClientKey" } }, "associatedMerchantAccounts": [ "YOUR_MERCHANT_ACCOUNT_2", "YOUR_MERCHANT_ACCOUNT_3" ] }, { "id": "YOUR_API_CREDENTIAL_8", "username": "YOUR_USERNAME_8", "clientKey": "YOUR_CLIENT_KEY_8", "allowedIpAddresses": [], "roles": [ "Merchant Report Download role" ], "active": true, "_links": { "self": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_8" }, "allowedOrigins": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_8/allowedOrigins" }, "company": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT" }, "generateApiKey": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_8/generateApiKey" }, "generateClientKey": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_8/generateClientKey" } }, "associatedMerchantAccounts": [] }, { "id": "YOUR_API_CREDENTIAL_9", "username": "YOUR_USERNAME_9", "clientKey": "YOUR_CLIENT_KEY_9", "allowedIpAddresses": [], "roles": [ "Merchant Report Download role" ], "active": true, "_links": { "self": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_9" }, "allowedOrigins": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_9/allowedOrigins" }, "company": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT" }, "generateApiKey": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_9/generateApiKey" }, "generateClientKey": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_9/generateClientKey" } }, "associatedMerchantAccounts": [ "YOUR_MERCHANT_ACCOUNT_4", "YOUR_MERCHANT_ACCOUNT_5" ] }, { "id": "YOUR_API_CREDENTIAL_10", "username": "YOUR_USERNAME_10", "clientKey": "YOUR_CLIENT_KEY_10", "allowedIpAddresses": [], "roles": [ "Merchant Report Download role" ], "active": true, "_links": { "self": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_10" }, "allowedOrigins": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_10/allowedOrigins" }, "company": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT" }, "generateApiKey": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_10/generateApiKey" }, "generateClientKey": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_10/generateClientKey" } }, "associatedMerchantAccounts": [] } ]}Generate a client key POST
Generates a new [client key](https://docs.adyen.com/development-resources/client-side-authentication/) used to authenticate requests from your payment environment. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write
Create an API credential. POST
Creates an [API credential](https://docs.adyen.com/development-resources/api-credentials) for the company account identified in the path. In the request, you can specify which merchant accounts the new API credential will have access to, as well as its roles and allowed origins. The response includes several types of authentication details: * [API key](https://docs.adyen.com/development-resources/api-authentication#api-key-authentication): used for API request authentication. * [Client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works): public key used for client-side authentication. * [Username and password](https://docs.adyen.com/development-resources/api-authentication#using-basic-authentication): used for basic authentication. > Make sure you store the API key securely in your system. You won't be able to retrieve it later. If your API key is lost or compromised, you need to [generate a new API key](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/apiCredentials/{apiCredentialId}/generateApiKey). To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write