API Key Generation Flow

This recipe was an interactive walkthrough in the previous portal. Each step below names the API call it makes; open it in the API Reference to try it.

OverviewCopy Anchor Link

API Key Rotation FlowCopy Anchor Link

This recipe walks you through safely rotating an API key for a merchant-level credential — entirely through the API, without touching the Customer Area.

Flow OverviewCopy Anchor Link

1. List Merchants — Retrieve the merchants under your company account and identify the target merchant.
2. List API Credentials — Fetch the API credentials for that merchant to identify the credential to rotate.
3. Generate New API Key — Rotate the API key for the selected credential. The old key remains valid for 24 hours to allow a safe cutover.

API Endpoints InvolvedCopy Anchor Link

• GET /companies/{companyId}/merchants
• GET /merchants/{merchantId}/apiCredentials
• POST /merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateApiKey

⚠️ PrerequisitesCopy Anchor Link

• Your Company ID (companyId) — found in your Adyen Customer Area under Settings > Account.
• An API key with the Management API — API credentials read and write role.

Tip: The merchantId from Step 1 and credentialId from Step 2 are automatically passed into subsequent steps.

Step 1: List MerchantsCopy Anchor Link

Returns the list of merchant accounts under the company account specified in the path.\n\n

API call: listCompanyMerchants

Example arguments:

{
                        companyId: "APIMatic300"
                    }

Step 2: List API CredentialsCopy Anchor Link

Returns the list of API credentials

API call: listMerchantApiCredentials

Example arguments:

{
                        merchantId: merchantId,
                    }

Step 3: Generate New API KeyCopy Anchor Link

Generates a new API key for credential

API call: generateMerchantApiKey

Example arguments:

{
                        merchantId: merchantId,
                        apiCredentialId: credentialId,
                    }