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

# Adyen

Connect & Ingest data from Adyen

Adyen is a global payment platform that provides a unified commerce solution for online, in-store, and mobile payments. The Sling Adyen connector extracts data from the Adyen Management API, supporting company accounts, merchant accounts, stores, webhooks, API credentials, payment method settings, and payout settings.

{% hint style="success" %}
**CLI Pro Required**: APIs require a [CLI Pro token](/sling-cli/cli-pro.md) or [Platform Plan](/sling-platform/platform.md).
{% endhint %}

## Setup

The following credentials and inputs are accepted:

**Secrets:**

* `api_key` **(required)** -> Your Adyen Management API key
* `mgmt_host` (optional) -> Override the Management API host (defaults to `management-test.adyen.com` for test, use `management-live.adyen.com` for live)

### Getting Your API Key

1. Log in to your [Adyen Customer Area](https://ca-test.adyen.com/) (test) or [live](https://ca-live.adyen.com/)
2. Go to **Developers** → **API credentials** in the left sidebar
3. Click on the **ws** (web service) credential, or create a new credential
4. Under the **API key** tab, click **Generate API key**
5. Copy the API key immediately — it is only shown once
6. Ensure the credential has the required roles under **Roles**: Management API - Accounts read, Webhooks read, API credentials read and write, Payment methods read, Payout Account Settings Read
7. Click **Save changes**

{% hint style="warning" %}
**Important:** The API key is only displayed once when generated. If you lose it, you will need to generate a new one. Ensure you have the appropriate Management API roles assigned to the credential.
{% endhint %}

### Using `sling conns`

{% code overflow="wrap" %}

```bash
sling conns set ADYEN type=api spec=adyen secrets='{ api_key: "${ADYEN_API_KEY}" }'
```

{% endcode %}

### Environment Variable

See [here](https://docs.slingdata.io/connections/api-connections/pages/eAdVs2BHCgdr6RS8GoJC#dot-env-file-.env.sling) to learn more about the `.env.sling` file.

{% code overflow="wrap" %}

```bash
export ADYEN='{ type: api, spec: adyen, secrets: { api_key: "${ADYEN_API_KEY}" } }'
```

{% endcode %}

### Sling Env File YAML

See [here](https://docs.slingdata.io/connections/api-connections/pages/eAdVs2BHCgdr6RS8GoJC#sling-env-file-env.yaml) to learn more about the sling `env.yaml` file.

```yaml
connections:
  ADYEN:
    type: api
    spec: adyen
    secrets:
      api_key: ${ADYEN_API_KEY}
```

**For live environment:**

```yaml
connections:
  ADYEN:
    type: api
    spec: adyen
    secrets:
      api_key: ${ADYEN_API_KEY}
      mgmt_host: ${ADYEN_MGMT_HOST}
```

## Replication

Here's an example replication configuration to sync Adyen data to a PostgreSQL database:

```yaml
source: ADYEN
target: MY_POSTGRES

defaults:
  mode: full-refresh
  object: adyen.{stream_name}

streams:
  companies:
  merchants:
  stores:
  company_webhooks:
  company_api_credentials:
  merchant_webhooks:
  payment_methods:
  payout_settings:
```

## Endpoints

### Company & Merchant Configuration

| Endpoint    | Description                | Incremental |
| ----------- | -------------------------- | ----------- |
| `companies` | List all company accounts  | No          |
| `merchants` | List all merchant accounts | No          |
| `stores`    | List all stores            | No          |

### Company-Scoped

| Endpoint                  | Description                          | Incremental |
| ------------------------- | ------------------------------------ | ----------- |
| `company_webhooks`        | Webhooks configured for each company | No          |
| `company_api_credentials` | API credentials for each company     | No          |

### Merchant-Scoped

| Endpoint            | Description                                       | Incremental |
| ------------------- | ------------------------------------------------- | ----------- |
| `merchant_webhooks` | Webhooks configured for each merchant             | No          |
| `payment_methods`   | Payment method settings for each merchant         | No          |
| `payout_settings`   | Payout settings (bank accounts) for each merchant | No          |

To discover available endpoints:

```bash
sling conns discover ADYEN
```

## Test vs Live Environment

The Adyen connector defaults to the **test environment** (`management-test.adyen.com`). To use the live environment, set the `mgmt_host` secret:

```yaml
connections:
  ADYEN:
    type: api
    spec: adyen
    secrets:
      api_key: ${ADYEN_API_KEY}
      mgmt_host: ${ADYEN_MGMT_HOST}
```

{% hint style="info" %}
Test and live environments use separate API keys. Generate your live API key from the [live Customer Area](https://ca-live.adyen.com/).
{% endhint %}

## Rate Limiting

The Adyen Management API enforces rate limits. The connector automatically:

* Uses a conservative rate of 10 requests/second
* Processes queue-based endpoints with concurrency of 3
* Retries with exponential backoff on 429 (rate limit) responses up to 10 attempts
* Retries server errors (5xx) with linear backoff up to 3 attempts

If you are facing issues connecting, please reach out to us at <support@slingdata.io>, on [discord](https://discord.gg/q5xtaSNDvp) or open a Github Issue [here](https://github.com/slingdata-io/sling-cli/issues).


---

# 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.slingdata.io/connections/api-connections/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.
