POST /merchants/{merchantId}/apiCredentials
Creates an API credential 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: used for API request authentication.
- Client key: public key used for client-side authentication.
- Username and password: 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.
To make this request, your API credential must have the following roles:
- Management API—API credentials read and write
Servers
- https://management-test.adyen.com/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
merchantId |
String | Yes |
The unique identifier of the merchant account. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
description |
String | No |
Description of the API credential. |
roles[] |
Array | No |
List of roles for the API credential. Only roles assigned to 'ws@Company.' can be assigned to other API credentials. |
allowedOrigins[] |
Array | No |
The list of allowed origins for the new API credential. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.