Adyen

{/* Generated by scripts/generate-integration-catalog.mjs. Do not edit by hand. */}

At a glance

  • Availability: Experimental (how to enable).
  • Authentication: API key.
  • Connection: The key from ADYEN_API_KEY is sent as the X-API-Key header.
  • Provider documentation: Authentication reference.

Credentials

Set these per environment. See Connect an integration.

VariableRequiredDescription
ADYEN_API_KEYYesAdyen API key generated for your API credential in the Customer Area (Developers > API credentials) Docs.
ADYEN_MERCHANT_ACCOUNTNoAdyen merchant account name, passed as the merchantAccount field in API requests Docs.
ADYEN_CHECKOUT_HOSTNoAdyen Checkout API URL prefix without scheme. Keep the default checkout-test.adyen.com for test. For live, use your prefixed live host from Developers > API URLs followed by /checkout, e.g. 1797a841fbb37ca7-AdyenDemo-checkout-live.adyenpayments.com/checkout, because live Checkout endpoints sit under that extra path segment.

Setup

  1. Create an Adyen test account: Sign up for a free Adyen test account at https://www.adyen.com/signup. This gives you a test Customer Area at https://ca-test.adyen.com with a test merchant account.
  2. Generate an API key: In the Customer Area, go to Developers > API credentials, select (or create) a credential, then under Server settings > Authentication open the API key tab and select Generate API key. Copy it immediately - it cannot be shown again after you leave the page.
  3. Configure environment variables: Set ADYEN_API_KEY to the generated key. Optionally set ADYEN_MERCHANT_ACCOUNT to your merchant account name (shown in the Customer Area) - it is required as the merchantAccount field in every request body.
  4. Going live: Live mode needs a separate API key generated in the live Customer Area (https://ca-live.adyen.com), and live API calls use your unique live URL prefix. Find the prefix under Developers > API URLs in the live Customer Area, then set ADYEN_CHECKOUT_HOST to that host plus /checkout, e.g. 1797a841fbb37ca7-AdyenDemo-checkout-live.adyenpayments.com/checkout. Live Checkout URLs use /checkout/v71/.... while the test host uses /v71/.... directly.

Provider notes

  • Requests go to the URL prefix configured via the ADYEN_CHECKOUT_HOST environment variable. For test, keep the default checkout-test.adyen.com. For live, set your prefixed live host plus the /checkout path segment, e.g. 1797a841fbb37ca7-AdyenDemo-checkout-live.adyenpayments.com/checkout (live Checkout URLs require /checkout/v71/.... while test uses /v71/...).
  • Amounts are in minor units (e.g. value 1000 with currency EUR is EUR 10.00).
  • Refund outcomes are asynchronous: the API acknowledges the request and the final result is delivered via a REFUND webhook.
  • The Checkout API does not provide a payment listing endpoint; use get_session_result or webhooks to track payment outcomes.

Provider API reference.

Tools

ToolAccessDescription
Create Payment Session<br /><code className="reference-identifier">adyen__create_payment_session</code>WriteCreate payment session
Get Session Result<br /><code className="reference-identifier">adyen__get_session_result</code>ReadGet session result
List Payment Methods<br /><code className="reference-identifier">adyen__list_payment_methods</code>ReadList payment methods
Create Payment Link<br /><code className="reference-identifier">adyen__create_payment_link</code>WriteCreate payment link
Capture Payment<br /><code className="reference-identifier">adyen__capture_payment</code>WriteStart payment capture
Create Refund<br /><code className="reference-identifier">adyen__create_refund</code>WriteStart payment refund

Verify the connection

Call a read tool such as adyen__get_session_result with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.