Get an API credential
Returns the API credential identified in the path.
To make this request, your API credential must have the following roles:
- Management API—API credentials read and write
In: header
Path Parameters
The unique identifier of the company account.
Unique identifier of the API credential.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/companies/string/apiCredentials/string"Example response with details of the API credential at the company level
{ "id": "YOUR_API_CREDENTIAL", "username": "YOUR_USERNAME", "clientKey": "YOUR_CLIENT_KEY", "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/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/allowedOrigins/YOUR_ALLOWED_ORIGIN_2" } } } ], "_links": { "self": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL" }, "allowedOrigins": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/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/generateApiKey" }, "generateClientKey": { "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateClientKey" } }, "associatedMerchantAccounts": []}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
Update an API credential. PATCH
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. 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