ADadyen
API credentials - merchant level

Get an API credential

Changed on

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
get/merchants/{merchantId}/apiCredentials/{apiCredentialId}

Request

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

Path parameters

merchantIdstring required

The unique identifier of the merchant account.

apiCredentialIdstring required

Unique identifier of the API credential.

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.

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