canonical: https://jentic.com/apis/adyen.com

# Adyen APIs

Adyen is a single payments platform that spans online checkout, in-person terminals, marketplace and platform money movement, KYC and legal entity verification, and account configuration. Its APIs let a business authorise and modify card, wallet, and local payment method transactions, drive point-of-sale terminals, onboard and verify sellers on Adyen for Platforms, move funds between balance accounts and bank accounts, respond to chargebacks, and configure merchant accounts, stores, and webhooks from one integration.

## For AI agents

Across Adyen's APIs an agent can create and modify online and in-person payments, onboard and KYC-verify legal entities, provision balance accounts and issue cards, move funds and run payouts, defend or accept disputes, and configure merchant accounts, terminals, and webhooks. It can also parse Adyen webhook payloads to react to payment, transfer, configuration, and report events.

## Scope

Use for: Automating online and in-person card, wallet, and local payment method transactions; marketplace and platform onboarding, KYC, fund movement, card issuing, payouts, dispute response, and account and webhook configuration on Adyen

Not supported:
- banking license
- fraud risk scoring
- tax filing
- accounting ledger
- customer support desk

## APIs

| API | Category | Endpoints | Description |
| --- | --- | --- | --- |
| Adyen Management API (v3) | developer-tools | 134 | Programmatically configure Adyen merchant accounts, stores, terminals, payment methods, API credentials, and webhooks on the actively maintained v3 Management API. |
| Adyen Management API (v1) | developer-tools | 130 | Programmatically configure Adyen merchant accounts, stores, terminals, payment methods, API credentials, and webhooks across companies and merchants on the v1 Management API. |
| Adyen Configuration API | payments | 56 | Manage account holders, balance accounts, payment instruments, sweeps, and transaction rules across an Adyen for Platforms balance platform. |
| Adyen Legal Entity Management API | identity-auth | 33 | Create and update legal entities, attach business lines and transfer instruments, upload verification documents, and run hosted onboarding for Adyen Balance Platform and Issuing accounts. |
| Adyen Checkout API | payments | 26 | Create payment sessions, generate payment links, capture or refund authorised payments, and manage stored payment methods on Adyen with cards, wallets, and local payment methods. |
| Account API | payments | 20 | Create and manage marketplace account holders, sub-accounts, bank accounts, and shareholders on Adyen's classic platform integration. |
| Adyen Terminal API | payments | 19 | Drive in-person payments and POS interactions on Adyen terminals - accept payments, refunds, loyalty, stored-value, displays, prints, and reconciliation. |
| Adyen Payment API | payments | 13 | Authorise, capture, cancel, and refund card payments through Adyen's classic server-to-server interface, including 3D Secure and 3DS2 step-up flows. |
| Adyen Transfers API | payments | 11 | Initiate, list, look up, approve, cancel, and return transfers between balance accounts and third-party banks on Adyen's Balance Platform. |
| Adyen Fund API | payments | 8 | Move funds between marketplace accounts, pay out balances to account holders, and retrieve balances and transactions on Adyen's classic for-platforms integration. |
| Adyen Payout API | payments | 6 | Submit, confirm, decline, and store details for third-party payouts on Adyen's classic platform, plus run instant card payouts. |
| Adyen Recurring API (deprecated) | payments | 6 | List, disable, and permit-manage Adyen stored payment tokens for subscription billing on classic integrations. |
| Adyen Stored Value API | payments | 6 | Issue, load, balance-check, merge, status-change, and void transactions on Adyen-issued gift and stored-value cards. |
| Notification Configuration API | payments | 6 | Subscribe to and manage Adyen classic-platform webhook notifications for verification, payout, and platform events, with end-to-end test delivery. |
| Adyen Disputes API | payments | 5 | Accept, defend, and supply or remove evidence on Adyen disputes and chargebacks, plus look up which defense reasons apply to a given dispute. |
| POS Terminal Management API | payments | 5 | Provision, list, and reassign Adyen POS terminals across merchant accounts and stores via back-office terminal management endpoints. |
| Adyen BIN Lookup API | payments | 2 | Look up 3D Secure version availability and processing cost estimates for a card BIN before creating a payment. |
| Adyen Hosted Onboarding API | identity-auth | 2 | Generate links to Adyen-hosted onboarding and PCI compliance pages for marketplace account holders on Adyen's classic for-platforms integration. |
| Adyen Balance Control API | payments | 1 | Transfer funds between two merchant accounts on the same Adyen legal entity using a single balanceTransfer call. |
| Adyen Data Protection API | security | 1 | Submit GDPR right-to-erasure requests to Adyen for a specific shopper, removing payment and personal data tied to past transactions and returning an audit reference. |
| Adyen Test Cards API | developer-tools | 1 | Generate custom Adyen test card number ranges for QA scenarios that the standard test cards do not cover. |
| Adyen Classic Platforms Notifications | developer-tools | 0 | Reference for the webhook payloads Adyen sends from the classic for-platforms integration, covering account holders, accounts, fund management, and platform events. |
| Adyen Configuration Webhooks | payments | 0 | Receive and parse Adyen Balance Platform configuration events for account holders, balance accounts, payment instruments, card orders, and sweeps. |
| Adyen Management Webhooks | developer-tools | 0 | Reference for the webhook payloads Adyen sends when merchant accounts, stores, payment terminals, and payment methods change via the Management API. |
| Adyen Payment Webhooks (deprecated) | payments | 0 | Receive deprecated Adyen Balance Platform payment and transfer events for legacy receivers that have not migrated to accounting webhooks. |
| Adyen Report Webhooks | payments | 0 | Receive a webhook when a new Adyen Balance Platform report is generated, with a typed payload pointing at the downloadable report file. |
| Adyen Transfer Webhooks | payments | 0 | Receive current Adyen Balance Platform transfer events with typed counterparty, validation, and amount data - the surface that replaced the deprecated payment webhooks. |

## Which API to use

| Need | API | Why |
| --- | --- | --- |
| Take an online card, wallet, or local payment method payment | CheckoutService-v71 | Checkout is the current unified online payment surface with sessions, payment links, and modifications; PaymentService is the older classic server-to-server card interface |
| Authorise a card payment on the classic server-to-server integration | PaymentService | Use only when an existing classic integration targets it; new online integrations should use CheckoutService-v71 |
| Configure merchant accounts, stores, terminals, and webhooks | ManagementService-v3 | v3 is the actively maintained Management surface with Android app uploads; ManagementService v1 is the earlier version kept for existing integrations |
| Move funds between balance accounts and to bank accounts | TransferService-v4 | Transfers v4 is the current Balance Platform money-movement surface; PayoutService and FundService are the deprecated classic-platform payout paths |
| Pay out balances on a marketplace | PayoutService | Classic for-platforms payout surface, superseded by TransferService-v4 for new Balance Platform integrations |
| Onboard and verify a seller or business | LegalEntityService | Legal Entity Management handles KYC and KYB on the modern Balance Platform; AccountService and HopService cover the classic for-platforms onboarding model |
| Create account holders, balance accounts, and payment instruments | BalancePlatformService | The Configuration API is the modern Balance Platform structural surface; AccountService is the classic-platform equivalent |
| Take a payment on a physical terminal | TerminalAPI-v1 | Terminal API drives in-person POS interactions; TfmAPIService only provisions and assigns the terminal hardware |
| Manage stored payment tokens for subscriptions | RecurringService | Deprecated classic tokenisation surface; new recurring billing should use tokenisation in CheckoutService-v71 |

## Cross-API use cases

### Onboard a marketplace seller and pay them out

Verify a new seller as a legal entity, provision their balance account and payment instrument, then move their settled proceeds to a bank account. Legal Entity Management runs the KYC and KYB checks, the Configuration API creates the account holder, balance account, and any issued card, and the Transfers API moves funds once verification clears.

Example prompt: Create the legal entity and check verification errors via LegalEntityService, create the account holder and balance account via BalancePlatformService, then initiate the payout via TransferService-v4 once verification clears

### Configure a merchant account then take payments

Provision a merchant account with its payment methods and webhook subscriptions, then process online payments against it. The Management API v3 configures the merchant account, payment methods, and webhooks, and the Checkout API authorises and captures the resulting payments.

Example prompt: Create the merchant account, configure payment methods, and add a webhook subscription via ManagementService-v3, then create a session and authorise the payment via CheckoutService-v71

### Process a payment and defend the resulting chargeback

Authorise a payment, listen for the dispute webhook, then respond to the chargeback with evidence. Checkout authorises and captures the payment, the Management Webhooks spec signals when a dispute arrives, and the Disputes API retrieves defense reasons and submits the response.

Example prompt: Capture the payment via CheckoutService-v71, parse the dispute event from ManagementNotificationService-v1, then retrieve defense reasons and defend the dispute via DisputeService-v30

### Run one payment stack across web and physical store

Take online payments and in-person terminal payments for the same merchant while managing the terminal fleet. Checkout handles card-not-present web and app payments, the Terminal API drives in-person transactions, and POS Terminal Management assigns and reassigns terminals across stores.

Example prompt: Provision terminals to stores via TfmAPIService, take online payments via CheckoutService-v71 and in-person payments via TerminalAPI-v1, and reconcile both at close of business

## Why Jentic

- **Setup:** Wiring Adyen by hand means handling API key or basic auth for each surface, targeting the right test or live host per API, and threading identifiers such as companyId, accountHolderId, and pspReference through a large operation set. Through Jentic you install once, add the Adyen APIs you need from the Jentic API Directory, store the key once, and your agent calls them.
- **Permission scoping:** Because you run Jentic One yourself, your own rules decide which Adyen operations and credentials the agent may use. Many APIs carry the resource id in the URL path, so a rule can pin the agent to one company, account holder, or transfer, while high-impact operations such as initiating transfers, issuing cards, or generating API keys stay off the agent's list unless you add them.
- **Credential handling:** Your Adyen credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search the Jentic directory by intent such as 'take a payment on Adyen' or 'send an Adyen transfer to a bank account', and Jentic returns the matching Adyen operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related vendors

- **Stripe** — Comparable payment processor with online payments, Connect for marketplaces, and Issuing for card programs
- **Braintree** — PayPal-owned gateway covering cards, PayPal, and Venmo as an alternative online payment processor
- **Onfido** — Standalone identity verification provider, an alternative to Adyen's Legal Entity Management for KYC
- **Sumsub** — KYC and KYB verification platform with hosted flows, an alternative for seller onboarding checks

## FAQ

### Which Adyen APIs should I use for a new integration?

For new online payments use the Checkout API rather than the classic Payment API. For platform money movement use the Transfers API v4 rather than the deprecated Payout and Fund APIs. For onboarding and verification on the modern Balance Platform use Legal Entity Management and the Configuration API rather than the classic Account and Hosted Onboarding APIs. The classic surfaces remain available for existing integrations that already target them.

### Does one API key work across all of Adyen's APIs?

The APIs share the same authentication model, an API key in the X-API-Key header or HTTP Basic auth, but the key must be generated with the roles for each surface. Balance Platform APIs such as Transfers and Configuration also accept a clientKey for client-side flows. In practice you generate a key in the relevant Customer Area and grant it the roles the operations require.

### What is the difference between the classic and Balance Platform APIs?

The classic for-platforms APIs, including Account, Fund, Payout, and Hosted Onboarding, model marketplaces the original way. The modern Balance Platform, including the Configuration, Legal Entity Management, and Transfers APIs, models the same concepts as legal entities, account holders, balance accounts, and transfers. New platform integrations should build on the Balance Platform surface.

### Can I handle online and in-person payments through Adyen?

Yes. The Checkout API covers online card-not-present payments across cards, wallets, and local payment methods, while the Terminal API drives in-person payments on Adyen-supplied point-of-sale terminals. POS Terminal Management provisions and assigns the terminal hardware. Using both lets one merchant run a single payment stack across web, app, and physical store.

### How do webhooks fit into the Adyen APIs?

Several REST APIs pair with a webhook specification that describes the events they emit. The Management, Configuration, Transfer, and classic platform webhook specs let an agent parse the payloads Adyen sends when payments, transfers, configuration, or reports change, so a workflow can react asynchronously to actions taken through the REST APIs.

### Does Adyen support marketplaces and card issuing?

Yes. Adyen for Platforms lets a marketplace or platform onboard sellers as legal entities, hold their funds in balance accounts, issue physical and virtual cards as payment instruments, apply transaction rules, and move money with the Transfers API. The Configuration and Legal Entity Management APIs together model the full platform structure.