> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/adyen.md).

# Adyen

Create Adyen payment links, charge stored payment methods, and capture or refund payments.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication   |
| --------- | ---------------- |
| Adyen     | API key or token |

#### Adyen

Create payment links, charge stored payment methods, and capture or refund payments.

**Set up in Adyen**

1. Prepare the Adyen account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Your Adyen API key, from Customer Area > Developers > API credentials. The credential needs a role covering Checkout payments (e.g. 'Checkout API' / 'Payments'). Test and live keys are separate credentials from separate Customer Areas; a test key never works against the live environment.
3. **Live URL Prefix:** Required only when Environment is 'live'. Your account's live URL prefix, from Customer Area > Developers > API URLs. A plain identifier only (letters, digits, hyphens), no scheme, slashes, or dots.
4. **Webhook HMAC Key:** Only needed if you use the Payment Result trigger. The HMAC key from Customer Area > Developers > Webhooks > (your webhook) > Security, used to verify that incoming webhook events genuinely came from Adyen.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Adyen**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field    | Required                 | What to enter                                                                                                                                                                                                                                                                                                                                                                            |
| ---------------- | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API Key          | Yes                      | Your Adyen API key, from Customer Area > Developers > API credentials. The credential needs a role covering Checkout payments (e.g. 'Checkout API' / 'Payments'). Test and live keys are separate credentials from separate Customer Areas; a test key never works against the live environment. [Provider instructions](https://docs.adyen.com/development-resources/api-credentials/). |
| Merchant Account | Yes                      | The Adyen merchant account code every payment, link, capture, and refund posts to.                                                                                                                                                                                                                                                                                                       |
| Environment      | Optional / as applicable | Whether this connection talks to Adyen's test or live Checkout API.                                                                                                                                                                                                                                                                                                                      |
| Live URL Prefix  | Optional / as applicable | Required only when Environment is 'live'. Your account's live URL prefix, from Customer Area > Developers > API URLs. A plain identifier only (letters, digits, hyphens), no scheme, slashes, or dots. [Provider instructions](https://docs.adyen.com/development-resources/live-endpoints/).                                                                                            |
| Webhook HMAC Key | Optional / as applicable | Only needed if you use the Payment Result trigger. The HMAC key from Customer Area > Developers > Webhooks > (your webhook) > Security, used to verify that incoming webhook events genuinely came from Adyen. [Provider instructions](https://docs.adyen.com/development-resources/webhooks/secure-webhooks/verify-hmac-signatures/).                                                   |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Adyen** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create Payment Link

Generate a secure Adyen page where a customer can pay.

**Inputs**

| Field                | Type            | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| -------------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Amount               | number          | Yes      | How much to charge, written as a normal decimal amount (e.g. 12.50 for twelve euros fifty). Do NOT enter Adyen's minor units here.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| Currency             | select (string) | Yes      | The currency to charge in. Available values: EUR - Euro, USD - US Dollar, GBP - British Pound, JPY - Japanese Yen, CHF - Swiss Franc, CAD - Canadian Dollar, AUD - Australian Dollar, SEK - Swedish Krona, NOK - Norwegian Krone, DKK - Danish Krone, PLN - Polish Zloty, CZK - Czech Koruna, HUF - Hungarian Forint, CNY - Chinese Yuan, HKD - Hong Kong Dollar, SGD - Singapore Dollar, NZD - New Zealand Dollar, MXN - Mexican Peso, BRL - Brazilian Real, ZAR - South African Rand, INR - Indian Rupee, AED - UAE Dirham, KRW - South Korean Won.                                                                         |
| Your Reference       | string          | Yes      | Your own order or invoice number, shown on the Adyen payment and in reports.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Customer Email       | string          | No       | Customer's email, used for the receipt and fraud checks. Adyen does not send the payment link itself; send the Payment URL output yourself.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Description          | string          | No       | What the customer is paying for. Shown on the payment page.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Expires At           | datetime        | No       | When the link stops working. Defaults to 24 hours.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| Show Advanced Fields | boolean         | No       | Reveal country, customer ID, save card, and idempotency key. Default: false.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Country              | string          | No       | Customer's country, which decides the payment methods offered.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Customer ID          | string          | No       | Your own id for this customer. Required if you turn on Save Card below: Adyen needs it to know whose card to store, and it is what Charge a Saved Payment Method later uses to find it.                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| Save Card            | select (string) | No       | Save the customer's card so it can be charged again later with Charge a Saved Payment Method, instead of sending a new link every time. 'Save it without asking' stores the card without the customer seeing any consent prompt, which carries its own consent and regulatory obligations on you; only use it if you already have the customer's consent to store their card from elsewhere, e.g. your own terms of service. 'Ask the customer for consent' shows them an opt-in checkbox on the payment page instead. Available values: Don't save, Ask the customer for consent, Save it without asking. Default: disabled. |
| Future Charge Type   | select (string) | No       | How the saved card will be charged later: a regular subscription on a fixed schedule, or a one-off/irregular charge. Pick the same option you plan to use in Charge a Saved Payment Method's Charge Type, for consistent reporting. Available values: Subscription (regular charge on a fixed schedule), One-off or irregular charge (not on a fixed schedule). Default: subscription.                                                                                                                                                                                                                                        |
| Idempotency Key      | string          | No       | Prevents a duplicate link if this step runs twice. Leave empty to skip that protection.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |

**Outputs**

| Field           | Type     | Description                                                                                   |
| --------------- | -------- | --------------------------------------------------------------------------------------------- |
| Payment URL     | string   | Send this link to the customer to collect payment.                                            |
| Payment Link ID | string   | Adyen's id for this link.                                                                     |
| Status          | string   | Whether the link is active, already paid, or expired.                                         |
| Expires At      | datetime | When the link stops working. May be absent; Adyen still applies its own default in that case. |

#### Get Payment Link

Check whether a payment link has been paid yet.

**Inputs**

| Field           | Type   | Required | Description                |
| --------------- | ------ | -------- | -------------------------- |
| Payment Link ID | string | Yes      | The payment link to check. |

**Outputs**

| Field          | Type    | Description                                        |
| -------------- | ------- | -------------------------------------------------- |
| Status         | string  | Whether the link is active, paid, or expired.      |
| Paid           | boolean | True once the customer has paid.                   |
| Payment URL    | string  | The payment page URL.                              |
| Amount         | number  | The amount the link is for.                        |
| Currency       | string  | The currency of the link.                          |
| Your Reference | string  | The reference you supplied when creating the link. |

#### Expire Payment Link

Cancel a payment link so it can no longer be paid.

**Inputs**

| Field           | Type   | Required | Description                 |
| --------------- | ------ | -------- | --------------------------- |
| Payment Link ID | string | Yes      | The payment link to cancel. |

**Outputs**

| Field           | Type   | Description                         |
| --------------- | ------ | ----------------------------------- |
| Payment Link ID | string | The link that was expired.          |
| Status          | string | The link's status after the change. |

#### Charge a Saved Payment Method

Charge a returning customer using a card they have already saved.

**Inputs**

| Field                | Type            | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| -------------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Amount               | number          | Yes      | How much, written the way you would on an invoice: 12.50 means twelve euros fifty, not one thousand two hundred and fifty. Use whole numbers for zero-decimal currencies such as JPY and KRW.                                                                                                                                                                                                                                                                                                                                                         |
| Currency             | select (string) | Yes      | The currency to charge in. Available values: EUR - Euro, USD - US Dollar, GBP - British Pound, JPY - Japanese Yen, CHF - Swiss Franc, CAD - Canadian Dollar, AUD - Australian Dollar, SEK - Swedish Krona, NOK - Norwegian Krone, DKK - Danish Krone, PLN - Polish Zloty, CZK - Czech Koruna, HUF - Hungarian Forint, CNY - Chinese Yuan, HKD - Hong Kong Dollar, SGD - Singapore Dollar, NZD - New Zealand Dollar, MXN - Mexican Peso, BRL - Brazilian Real, ZAR - South African Rand, INR - Indian Rupee, AED - UAE Dirham, KRW - South Korean Won. |
| Your Reference       | string          | Yes      | Your own order or invoice number for this charge.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Your Customer ID     | string          | Yes      | Your id for the customer whose saved method you are charging.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| Saved Payment Method | select (string) | Yes      | Which saved card to charge. Options load from the selected connection.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Charge Type          | select (string) | Yes      | Whether this is a regular subscription charge or a one-off/irregular charge against the saved card. Required: there is no default, so you must pick one. Available values: Subscription (regular charge on a fixed schedule), One-off or irregular charge (not on a fixed schedule).                                                                                                                                                                                                                                                                  |
| Idempotency Key      | string          | No       | Prevents a double charge if this step runs twice. Strongly recommended.                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |

**Outputs**

| Field                   | Type    | Description                                                      |
| ----------------------- | ------- | ---------------------------------------------------------------- |
| Adyen Payment Reference | string  | Adyen's id for this payment, when Adyen returned one.            |
| Result                  | string  | Whether the charge was authorised, refused, or needs more steps. |
| Authorised              | boolean | True when the charge succeeded.                                  |
| Outcome                 | string  | Whether the charge succeeded, was declined, or is not yet known. |
| Refusal Reason          | string  | Why the bank declined, when it did.                              |

#### Capture Payment

Take the money for a payment that was authorised earlier.

**Inputs**

| Field                   | Type            | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| ----------------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Adyen Payment Reference | string          | Yes      | The authorised payment to capture.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Amount to Capture       | number          | Yes      | How much, written the way you would on an invoice: 12.50 means twelve euros fifty, not one thousand two hundred and fifty. Use whole numbers for zero-decimal currencies such as JPY and KRW.                                                                                                                                                                                                                                                                                                                                                                                        |
| Currency                | select (string) | Yes      | Currency of the capture. Must match the original payment. Available values: EUR - Euro, USD - US Dollar, GBP - British Pound, JPY - Japanese Yen, CHF - Swiss Franc, CAD - Canadian Dollar, AUD - Australian Dollar, SEK - Swedish Krona, NOK - Norwegian Krone, DKK - Danish Krone, PLN - Polish Zloty, CZK - Czech Koruna, HUF - Hungarian Forint, CNY - Chinese Yuan, HKD - Hong Kong Dollar, SGD - Singapore Dollar, NZD - New Zealand Dollar, MXN - Mexican Peso, BRL - Brazilian Real, ZAR - South African Rand, INR - Indian Rupee, AED - UAE Dirham, KRW - South Korean Won. |
| Your Reference          | string          | No       | Your own reference for this capture.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| Idempotency Key         | string          | No       | Prevents a double capture if this step runs twice. Strongly recommended.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |

**Outputs**

| Field                      | Type    | Description                                             |
| -------------------------- | ------- | ------------------------------------------------------- |
| Capture Reference          | string  | Adyen's id for this capture request.                    |
| Original Payment Reference | string  | The payment this capture belongs to.                    |
| Status                     | string  | Adyen has accepted the request. The result comes later. |
| Outcome Known              | boolean | False, because Adyen confirms captures asynchronously.  |

#### Refund Payment

Return money to a customer for a payment that was already captured.

**Inputs**

| Field                   | Type            | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| ----------------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Adyen Payment Reference | string          | Yes      | The captured payment to refund.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Amount to Refund        | number          | Yes      | How much, written the way you would on an invoice: 12.50 means twelve euros fifty, not one thousand two hundred and fifty. Use whole numbers for zero-decimal currencies such as JPY and KRW.                                                                                                                                                                                                                                                                                                                                                                                       |
| Currency                | select (string) | Yes      | Currency of the refund. Must match the original payment. Available values: EUR - Euro, USD - US Dollar, GBP - British Pound, JPY - Japanese Yen, CHF - Swiss Franc, CAD - Canadian Dollar, AUD - Australian Dollar, SEK - Swedish Krona, NOK - Norwegian Krone, DKK - Danish Krone, PLN - Polish Zloty, CZK - Czech Koruna, HUF - Hungarian Forint, CNY - Chinese Yuan, HKD - Hong Kong Dollar, SGD - Singapore Dollar, NZD - New Zealand Dollar, MXN - Mexican Peso, BRL - Brazilian Real, ZAR - South African Rand, INR - Indian Rupee, AED - UAE Dirham, KRW - South Korean Won. |
| Your Reference          | string          | No       | Your own reference for this refund.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| Idempotency Key         | string          | No       | Prevents a double refund if this step runs twice. Strongly recommended.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |

**Outputs**

| Field                      | Type    | Description                                             |
| -------------------------- | ------- | ------------------------------------------------------- |
| Refund Reference           | string  | Adyen's id for this refund request.                     |
| Original Payment Reference | string  | The payment this refund belongs to.                     |
| Status                     | string  | Adyen has accepted the request. The result comes later. |
| Outcome Known              | boolean | False, because Adyen confirms refunds asynchronously.   |

### Triggers

A trigger starts a workflow when its configured event occurs. Configure the event and filters before enabling the trigger.

#### Payment Result

Starts the workflow when Adyen confirms the outcome of a payment, capture, or refund. Requires a webhook configured in the Adyen Customer Area pointing at the StackAI URL, with its HMAC key saved on the Adyen connection.

Adyen webhooks are set up by hand in the Customer Area; there is no automatic setup. **Setup steps:** 1. Open the Adyen Customer Area that matches this connection's Environment: the [test Customer Area](https://ca-test.adyen.com/) or the [live Customer Area](https://ca-live.adyen.com/). These are separate accounts with separate webhooks, so a webhook added in one is invisible to the other. Then open **Developers > Webhooks**. 2. Click **Add webhook**, then choose **Standard notification**. 3. Under **General**, paste this URL into the **URL** field: {{webhook\_url}} 4. Under **Additional settings > Events**, add the events you care about (Authorisation, Capture, Capture Failed, Refund, Refund Failed, Cancellation). 5. Under **Security**, click **Generate new HMAC key**, then copy it. 6. Save the webhook, then open the StackAI Adyen connection this workflow uses and paste the copied key into its **Webhook HMAC Key** field. Every event is rejected until this is done.

**Configuration**

| Field                  | Type                      | Required | Description                                                                                                                                                   |
| ---------------------- | ------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Events                 | multiple\_select (string) | No       | Only fire for these Adyen events. Leave empty for all of them. Available values: Authorisation, Capture, Capture failed, Refund, Refund failed, Cancellation. |
| Only successful events | boolean                   | No       | Ignore failures and only fire when the event succeeded. Default: false.                                                                                       |

**Event inputs**

| Field                      | Type    | Required | Description                                                          |
| -------------------------- | ------- | -------- | -------------------------------------------------------------------- |
| Event                      | string  | Yes      | Which kind of event this is. Default: .                              |
| Succeeded                  | boolean | Yes      | Whether the event represents a success or a failure. Default: false. |
| Adyen Reference            | string  | Yes      | Adyen's id for the event. Default: .                                 |
| Original Payment Reference | string  | No       | The original payment, for capture and refund events.                 |
| Your Reference             | string  | No       | The reference you supplied on the original request.                  |
| Amount                     | number  | No       | The amount involved, in normal decimal form.                         |
| Currency                   | string  | No       | Currency of the amount.                                              |
| Reason                     | string  | No       | Why it failed, when it did.                                          |

**Outputs**

| Field                      | Type    | Description                                          |
| -------------------------- | ------- | ---------------------------------------------------- |
| Event                      | string  | Which kind of event this is.                         |
| Succeeded                  | boolean | Whether the event represents a success or a failure. |
| Adyen Reference            | string  | Adyen's id for the event.                            |
| Original Payment Reference | string  | The original payment, for capture and refund events. |
| Your Reference             | string  | The reference you supplied on the original request.  |
| Amount                     | number  | The amount involved, in normal decimal form.         |
| Currency                   | string  | Currency of the amount.                              |
| Reason                     | string  | Why it failed, when it did.                          |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/adyen.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
