ADadyen
API credentials - company level

Update an API credential.

Changed on

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:

  • Management API—API credentials read and write
patch/companies/{companyId}/apiCredentials/{apiCredentialId}

Request

  • Base URL
    https://management-test.adyen.com/v3
  • URL
    https://management-test.adyen.com/v3/companies/{companyId}/apiCredentials/{apiCredentialId}
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Path parameters

companyIdstring required

The unique identifier of the company account.

apiCredentialIdstring required

Unique identifier of the API credential.

Request body

activeboolean

Indicates if the API credential is enabled.

allowedOriginsstring[]

The new list of allowed origins for the API credential.

associatedMerchantAccountsstring[]

List of merchant accounts that the API credential has access to.

descriptionstring

Description of the API credential.

rolesstring[]

List of roles for the API credential. Only roles assigned to 'ws@Company.<CompanyName>' can be assigned to other API credentials.

subjectDNstring

The subject DN of the certificate issued by Adyen.

Response

OK - the request has succeeded.

activeboolean required

Indicates if the API credential is enabled. Must be set to true to use the credential in your integration.

allowedIpAddressesstring[] required

List of IP addresses from which your client can make requests.

If the list is empty, we allow requests from any IP. If the list is not empty and we get a request from an IP which is not on the list, you get a security error.

associatedMerchantAccountsstring[]

List of merchant accounts that the API credential has explicit access to. If the credential has access to a company, this implies access to all merchant accounts and no merchants for that company will be included.

clientKeystring required

Public key used for client-side authentication. The client key is required for Drop-in and Components integrations.

descriptionstring

Description of the API credential.

idstring required

Unique identifier of the API credential.

rolesstring[] required

List of roles for the API credential.

subjectDNstring

The subject DN of the certificate issued by Adyen.

usernamestring required

The name of the API credential, for example ws@Company.TestCompany.

Example response

{
  "allowedOrigins": [
    {
      "domain": "https://adyen.com"
    }
  ]
}

Changes

  • v3e6341bd2895aRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status