> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Adyen

> Create Adyen payment sessions, check session results, list payment methods, and issue refunds via the Checkout API

## At a glance

* **Availability**: Experimental ([how to enable](/cloud/integrations)).
* **Auth**: API key.
* **Connection**: The key from `ADYEN_API_KEY` is sent as the `X-API-Key` header.
* **Docs**: [https://docs.adyen.com/development-resources/api-credentials/](https://docs.adyen.com/development-resources/api-credentials/)

## Credentials

Set these per environment. See [Connect an integration](/cloud/integrations).

| Variable                 | Required | Description                                                                                                                                                                |
| ------------------------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ADYEN_API_KEY`          | Yes      | Adyen API key generated for your API credential in the Customer Area (Developers > API credentials) [Docs](https://docs.adyen.com/development-resources/api-credentials/). |
| `ADYEN_MERCHANT_ACCOUNT` | No       | Adyen merchant account name, passed as the merchantAccount field in API requests [Docs](https://docs.adyen.com/account/account-structure/).                                |

## Setup

1. **Create an Adyen test account**: Sign up for a free Adyen test account at [https://www.adyen.com/signup](https://www.adyen.com/signup). This gives you a test Customer Area at [https://ca-test.adyen.com](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](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.

* Each tool takes a checkoutHost parameter. For test, keep the default checkout-test.adyen.com. For live, pass your prefixed live host including the checkout path segment, e.g. 1797a841fbb37ca7-AdyenDemo-checkout-live.adyenpayments.com/checkout (test and live URLs have different structures).
* 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: [https://docs.adyen.com/api-explorer/Checkout/71/overview](https://docs.adyen.com/api-explorer/Checkout/71/overview)

## Tools

| Tool                   | Access | Description                                                                                                              |
| ---------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------ |
| Create Payment Session | Write  | Create an Adyen Checkout payment session that a Drop-in or Component can use to collect payment                          |
| Get Session Result     | Read   | Get the final result of an Adyen payment session, including authorized payments and status                               |
| List Payment Methods   | Read   | List the payment methods available for a merchant account, amount, and shopper country                                   |
| Create Payment Link    | Write  | Create a hosted Pay by Link URL the shopper can open to pay, without needing a Drop-in or Component frontend             |
| Capture Payment        | Write  | Capture an authorised Adyen payment (for manual-capture flows); the outcome arrives asynchronously via a CAPTURE webhook |
| Create Refund          | Write  | Refund all or part of a captured Adyen payment; the outcome arrives asynchronously via a REFUND webhook                  |

## Example prompts

* Create an Adyen payment session for a given amount and currency, and give me the session details.
* Check the result of an Adyen payment session and summarize whether the payment succeeded.
* Refund an Adyen payment by PSP reference: confirm the amount with me first, then submit the refund.