Adyen APIs

29 APIs526 Endpoints4 Categories

API Catalog

Account API

Onboard and manage marketplace account holders, sub-accounts, and their associated bank accounts and shareholders on the Adyen for Platforms classic integration. The API handles the full account lifecycle from creation through KYC verification, document upload, and suspension or closure. Each account holder can contain multiple accounts with separate balances and payout configurations.

20 endpoints

Adyen Balance Control API

The Adyen Balance Control API moves funds between merchant accounts that belong to the same legal entity inside one Adyen company account. It exposes a single POST /balanceTransfer endpoint that initiates a transfer with a source merchant account, destination merchant account, amount, and idempotency key. The API is designed for treasury operations on Adyen's classic platform — rebalancing settlement merchant accounts before payouts, reallocating commission, or correcting misrouted funds — and is separate from the Balance Platform Configuration API used by Adyen for Platforms customers.

1 endpoints

Adyen BinLookup API

The Adyen BIN Lookup API resolves card BIN (Bank Identification Number) data into actionable information for routing and authentication decisions before a payment is created. Two endpoints cover the core needs: POST /get3dsAvailability returns the 3D Secure version supported by the issuing bank for a given BIN, and POST /getCostEstimate returns Adyen's interchange and scheme fee estimate for a card. Use the API at the front of a checkout flow to choose the right authentication path and to surface processing-cost estimates to internal pricing logic.

2 endpoints

Adyen Checkout API

The Adyen Checkout API is Adyen's primary surface for initiating and authorising online payments — cards (including 3D Secure), mobile wallets, local payment methods, and recurring billing. The 26 endpoints in v70 cover the full payment lifecycle: list available payment methods for a session, create payments, post payment details for redirects and 3DS challenges, capture and cancel authorisations, refund, manage payment links, handle Apple Pay sessions, support recurring stored details, and process orders for partial-method splits and donations.

26 endpoints

Adyen Checkout API

Initiate and authorise online payments through Adyen's unified Checkout API, covering cards with 3D Secure, mobile wallets such as Apple Pay and Google Pay, and local payment methods like iDEAL and Sofort. The API exposes payment sessions, payment links, recurring tokens, donations, and modification operations (capture, cancel, refund) on a single integration. Version 71 of the API is reached via /v71/payments and related endpoints, with separate test and live environments.

26 endpoints

Adyen Classic Platforms Notifications

Specification for the webhook payloads Adyen sends from the classic Adyen for Platforms (MarketPay) integration, covering account holders, accounts, fund management, and other platform-level events. Adyen makes HTTP POST requests to the merchant's configured notification endpoint with a JSON body that the receiver authenticates using HTTP Basic credentials. Subscriptions are created and managed via the separate Notification Configuration API, while this spec describes the payload contract receivers must parse.

0 endpoints

Adyen Configuration API

The Adyen Configuration API is the core REST surface for Adyen for Platforms. It manages account holders, balance accounts, payment instruments, payment instrument groups, transaction rules, sweeps, network tokens, and grant accounts across a balance platform. The 56 endpoints cover creation, read, update, and lifecycle operations for every structural object Adyen for Platforms exposes — from posting a new accountHolder to retrieving the platform configuration to managing card-level transaction rules.

56 endpoints

Adyen Data Protection API

Submit GDPR Subject Erasure Requests against shopper data held by Adyen, including payment details, delivery addresses, and shopper email addresses tied to past transactions. The API exposes a single operation that records the erasure request and returns a unique request reference for audit and follow-up. Designed for merchants that need a programmatic way to satisfy Article 17 right-to-be-forgotten obligations.

1 endpoints

Adyen Disputes API

Automate the dispute and chargeback response cycle on Adyen by accepting or defending disputes, supplying defense documents, and retrieving the defense reasons applicable to a given dispute. The API exposes five operations covering the response side of the dispute workflow, with all calls going to /ca/services/DisputeService/v30. Suitable for merchants that want to react to chargebacks programmatically rather than through the Customer Area UI.

5 endpoints

Adyen Fund API

Manage funds within an Adyen Classic Platforms (MarketPay) marketplace by transferring money between platform accounts, paying out balances to account holders, refunding earlier transfers, and retrieving balances and transaction lists. Designed for the classic for-platforms integration; new implementations should use the modern Balance Platform APIs instead. Operates on /cal/services/Fund/v6 in test and the equivalent live endpoint.

8 endpoints

Adyen Hosted Onboarding API

Generate links to Adyen-hosted onboarding and PCI compliance pages for marketplace account holders on the Adyen for Platforms classic integration. The API exposes two operations: one returns a URL to a hosted onboarding page where account holders complete verification details and another returns a URL to a hosted PCI compliance questionnaire. Designed to slot into a classic platform onboarding flow without building custom KYC and PCI UI.

2 endpoints

Adyen Legal Entity Management API

Manage legal entities, business lines, transfer instruments, and verification documents on Adyen's modern Balance Platform and Issuing integrations. The API exposes 33 operations covering legal entity creation and updates, business line configuration, document upload, terms of service acceptance, PCI questionnaires, hosted onboarding URLs, and verification error inspection. Calls go to /lem/v3 in the test environment and the equivalent live KYC endpoint in production.

33 endpoints

Adyen Management API (v1)

Configure and manage Adyen company and merchant accounts, stores, payment terminals, payment methods, users, API credentials, allowed origins, webhooks, and Android apps and certificates from a single REST surface. Version 1 of the Management API exposes 130 operations against /v1, covering company-level, merchant-level, and store-level configuration without requiring access to the Customer Area UI. New integrations should consider Management API v3, which is the actively evolving version.

130 endpoints

Adyen Management API (v3)

Configure and manage Adyen company and merchant accounts, stores, payment terminals, payment methods, users, API credentials, allowed origins, webhooks, and Android apps and certificates from a single REST surface. Version 3 is the actively evolving Management API with 134 operations against /v3, including additional create-and-upload patterns on Android apps and certificates compared to v1. Recommended for new integrations that need programmatic control over the Adyen platform.

134 endpoints

Adyen Management Webhooks

Specification for the webhook payloads Adyen sends when configuration changes happen across company and merchant accounts, stores, payment terminals, and payment methods that are managed via the Management API. Adyen makes HTTP POST requests to the merchant's configured webhook URL with the event payload as the body, and the merchant's server authenticates the request using HTTP Basic credentials. This spec describes the payload contracts so receivers can validate and parse incoming events.

0 endpoints

Adyen Payment API

The Adyen Payment API is the classic-integration interface for authorising, capturing, modifying, and reversing card and alternative-payment-method transactions on Adyen's payment platform. The 13 endpoints cover the full authorise-capture-refund lifecycle, plus 3D Secure 1 and 3DS2 step-up flows, donation collection, and technical cancellations by merchant reference. New integrations should use the Checkout API; the Payment API remains the right choice for legacy classic integrations and server-to-server card processing where the integrator collects the PAN.

13 endpoints

Adyen Payout API

The Adyen Payout API is the classic-integration surface for storing payout details, submitting third-party payouts, and confirming or declining them with a separate review credential, plus running instant card payouts. The six endpoints implement the dual-credential flow Adyen requires for payouts: one credential stores details and submits a payout, a second credential confirms or declines it. Adyen has deprecated this API for new integrations and recommends the Transfers API for instant bank payouts and richer webhook signalling; the Payout API remains available for existing classic integrations.

6 endpoints

Adyen Recurring API (deprecated)

The Adyen Recurring API is the classic-integration surface for managing stored payment tokens (recurring details), permits that grant third parties limited charging rights against those tokens, and ancillary tasks such as scheduling Account Updater runs and notifying shoppers. The six endpoints cover listing stored details for a shopperReference, disabling a token, creating and revoking permits, and asking the issuer to push a payment notification to the shopper. Adyen has deprecated this API for new integrations and recommends the Checkout API stored payment methods endpoints instead; the Recurring API remains live for existing classic integrations.

6 endpoints

Adyen Stored Value API

The Adyen Stored Value API manages gift cards, prepaid cards, and other stored-value payment instruments issued through Adyen. The six endpoints cover card issuance, balance inquiries, loading funds onto a card, merging two card balances, voiding a previous transaction, and changing card status (for example to lock a lost card). It is the integration surface for retailers and brands running their own gift card or e-wallet programmes on Adyen rails.

6 endpoints

Adyen Terminal API

The Adyen Terminal API is the JSON message protocol for in-person payments and point-of-sale interactions on Adyen-supplied terminals. The 19 endpoints cover the full POS lifecycle: login and logout, payment, card acquisition, loyalty, stored value, reversal, reconciliation, totals reporting, balance inquiry, transaction status, abort, diagnosis, and direct device interactions such as display, input, print, and card-reader APDU. Both synchronous and asynchronous transport modes are supported, and the same protocol is used for cloud and local terminal integrations.

19 endpoints

Adyen Test Cards API

The Adyen Test Cards API generates custom test card number ranges for use in development and QA against Adyen's test environment. The single endpoint, POST /createTestCardRanges, returns synthetic PANs that approve, decline, or simulate specific behaviours such as 3D Secure challenges and fraud blocks. It exists so integrators can exercise edge cases that the standard Adyen test cards do not cover, such as a particular issuer country, fundingSource, or risk outcome.

1 endpoints

Adyen Transfers API

The Adyen Transfers API v3 is the Balance Platform interface for moving money between balance accounts, third-party bank accounts, and capital grants. The nine endpoints initiate transfers, approve or cancel pending transfers, return a settled transfer, list and inspect transactions, and request or look up Adyen Capital grants. It is the modern replacement for the deprecated classic Payout API and supports instant payouts, third-party bank transfers, and dual-control approval where required.

9 endpoints

Adyen Transfers API

The Adyen Transfers API v4 is the current major version of the Balance Platform interface for moving money between balance accounts, third-party bank accounts, and capital grants. The 11 endpoints initiate transfers, list and look up transfers and transactions, approve or cancel pending transfers, return a settled transfer, and request or inspect Adyen Capital grants. v4 adds GET /transfers list and GET /transfers/{id} on top of v3, enabling self-service reconciliation without polling individual transactions.

11 endpoints

Configuration webhooks

Adyen Balance Platform Configuration Webhooks notify your server of changes to account holders, balance accounts, payment instruments, card orders, and sweeps inside an Adyen for Platforms balance platform. The OpenAPI document defines the webhook event payloads — including balancePlatform.accountHolder.created, balanceAccount.updated, paymentInstrument.created, cardorder.created, and balanceAccountSweep events — that Adyen POSTs to your registered endpoint. You implement the receiver; this spec gives you typed schemas for parsing the events.

0 endpoints

Notification Configuration API

The Adyen Notification Configuration API is the classic-platform interface for subscribing to and managing webhook notifications about events on an Adyen marketplace or platform integration, including verification check completions, payout events, and dispute updates. The six endpoints let an integration create, list, retrieve, update, and delete notification subscriptions, plus send a synthetic test event to verify a configured endpoint URL responds correctly. It targets Adyen's classic platforms model; new integrations should use Balance Platform notifications instead.

6 endpoints

Payment webhooks (deprecated)

Adyen Balance Platform Payment Webhooks (v1) deliver legacy payment, incoming transfer, and outgoing transfer notifications for Adyen for Platforms balance platforms. The OpenAPI document defines the event payloads — balancePlatform.payment.created, payment.updated, incomingTransfer.created, incomingTransfer.updated, outgoingTransfer.created, and outgoingTransfer.updated — that Adyen POSTs to your endpoint. Adyen has deprecated this notification surface in favour of the accounting webhooks; use this spec only for receivers that have not yet migrated.

0 endpoints

POS Terminal Management API

The Adyen POS Terminal Management API administers the fleet of payment terminals in an Adyen merchant's estate. The five endpoints assign terminals to merchant accounts or stores, list terminals under an account, fetch the details of a specific terminal, find the account or store a terminal currently belongs to, and list the stores under an account. It is the back-office surface for terminal provisioning and reassignment, separate from the Terminal API that drives transactions.

5 endpoints

Report webhooks

Adyen Balance Platform Report Webhooks notify your server when a new report has been generated and is ready for download from your Adyen for Platforms balance platform. The OpenAPI document defines a single webhook event — balancePlatform.report.created — with a typed ReportNotificationRequest payload that includes the report identifier, type, and download URL. Pair the event with a download client to fetch the report file once the notification arrives.

0 endpoints

Transfer webhooks

Adyen Balance Platform Transfer Webhooks (v3) deliver the current accounting webhook surface for incoming and outgoing transfers across an Adyen for Platforms balance platform. The OpenAPI document defines balancePlatform.transfer.created and balancePlatform.transfer.updated events with a typed TransferNotificationRequest payload covering counterparty data, merchant metadata, validation facts, and amount. This is the surface that supersedes the deprecated Payment webhooks v1 — new integrations should target this version.

0 endpoints

Connect Your Agent

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.