APIMatic Adyen APIs
Sign Up to APIMatic
HomeSDKsAPI ReferenceContext Plugin
ManagementAPI credentialsA P I credentials merchant level

Get an API credential

GET
/merchants/{merchantId}/apiCredentials/{apiCredentialId}

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

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

merchantId*string

The unique identifier of the merchant account.

apiCredentialId*string

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/merchants/string/apiCredentials/string"

Example response with details of the API credential at the merchant level

{  "id": "YOUR_API_CREDENTIAL",  "username": "YOUR_USERNAME",  "clientKey": "YOUR_CLIENT_KEY",  "allowedIpAddresses": [],  "roles": [    "Merchant Report Download role"  ],  "active": true,  "_links": {    "self": {      "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_CREDENTIAL"    },    "allowedOrigins": {      "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_CREDENTIAL/allowedOrigins"    },    "generateApiKey": {      "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_CREDENTIAL/generateApiKey"    },    "generateClientKey": {      "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_CREDENTIAL/generateClientKey"    },    "merchant": {      "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"    }  }}

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 the roles and allowed origins for the new API credential. The response includes the: * [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/merchants/{merchantId}/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, 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