canonical: https://jentic.com/apis/adyen.com/adyen-checkout-service-v71 # 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. ## For AI agents 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. ## Scope Does not handle marketplace account onboarding, KYC verification, or in-person terminal payments - use for online payment authorisation, modification, and payment links only. ## Capabilities - Initiate card, wallet, and local payment method payments via /payments and /sessions - Generate hosted payment links with /paymentLinks and update their status when paid or expired - Capture, cancel, refund, or reverse authorised payments with the /captures, /cancels, /refunds, and /reversals modifications - Tokenise card details for recurring billing and disable stored payment methods on demand - Run 3D Secure 2 authentication flows including PaRes submission and result handling - Process donation transactions and look up active donation campaigns for charitable round-ups ## Use cases ### E-Commerce Card Checkout Accept card payments on a web or mobile checkout with 3D Secure 2 authentication and automatic fallback to 3DS1 where issuers require it. The Checkout API drives the full flow: create a /sessions object for the Drop-in component, handle additional details via /payments/details, and capture or refund the resulting payment. Integration through the Drop-in takes one to two days for a standard card flow. Example prompt: Create a /sessions object for amount 4999 EUR with returnUrl set to the merchant return page, then poll the resulting paymentPspReference for authorisation status ### Hosted Payment Links Generate sharable payment links to collect payment without building a full checkout, useful for invoices, phone orders, and ad-hoc charges. The /paymentLinks endpoint returns a hosted URL that supports cards and local payment methods, with status updates available via GET /paymentLinks/{linkId}. Setup takes under a day because no front-end work is required. Example prompt: POST /paymentLinks with amount 25000 EUR, reference INV-2026-0421, and expiresAt 24 hours from now, then return the resulting url to the caller ### Recurring and Subscription Billing Tokenise a card on first payment and charge the stored token on each subsequent billing cycle without re-prompting the cardholder. The Checkout API exposes recurring tokens via /payments with shopperReference and storePaymentMethod, and disables them on cancellation through the /storedPaymentMethods endpoint. Suitable for SaaS, content subscriptions, and metered services that need scheduled charges. Example prompt: Authorise a payment with shopperReference cust_8421 and storePaymentMethod true, then on the renewal date charge the recurring token via /payments with the stored payment method ID ### AI Agent Checkout Automation AI agents process and reconcile payments through Jentic without holding raw Adyen API keys. An agent searches for 'process a card payment' via Jentic, receives the /payments operation schema with required amount, paymentMethod, and reference fields, and executes the call. Captures, refunds, and status checks follow the same search-load-execute pattern, keeping credentials isolated in your Jentic One instance. Example prompt: Search Jentic for 'capture an authorised Adyen payment', load the schema, then call /payments/{paymentPspReference}/captures with the amount and reference for an existing pending authorisation ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | /sessions | Create a checkout session for the Drop-in or Components | | POST | /payments | Authorise a payment with a payment method | | POST | /payments/details | Submit additional payment details such as 3DS results | | POST | /paymentLinks | Create a payment link | | POST | /payments/{paymentPspReference}/captures | Capture an authorised payment | | POST | /payments/{paymentPspReference}/refunds | Refund a captured payment | | POST | /payments/{paymentPspReference}/cancels | Cancel an authorised payment | | POST | /applePay/sessions | Get an Apple Pay merchant session | ## Key resources - **Payments** — Authorise, modify, and look up payments across cards, wallets, and local methods - **Sessions** — Server-side session objects that power Drop-in and Components on the front end - **Payment Links** — Hosted payment links that collect payment without a custom checkout - **Modifications** — Captures, cancels, refunds, and reversals against authorised payments - **Stored Payment Methods** — Recurring tokens for repeat charges against the same shopper - **Donations** — Donation transactions and campaign lookup for round-up giving ## Why Jentic - **Setup:** Wiring the Adyen Checkout API by hand means handling its X-API-Key or basic auth, targeting the v71 checkout host, and assembling amount, paymentMethod, and reference fields for each payment. Through Jentic you install once, import the Checkout API from the API Directory, store the key once, and your agent calls it. - **Permission scoping:** Checkout puts the payment reference in the URL path for modifications (/payments/{paymentPspReference}/captures), so a rule can pin your agent to one payment: it can capture that payment and nothing else. You choose the operations it may call, so refunds and cancels stay out unless you add them. - **Credential handling:** Your Adyen X-API-Key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'process a card payment' or 'create a payment link', and Jentic returns the matching Checkout operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Adyen Management API** — Configure the merchant accounts, payment methods, and webhooks that Checkout uses - **Adyen Disputes API** — Respond to chargebacks raised on payments authorised through Checkout - **Stripe API** — Stripe offers comparable card, wallet, and local payment processing with PaymentIntents - **Braintree API** — PayPal-owned gateway covering cards, PayPal, and Venmo with Drop-in and hosted fields ## FAQ ### What authentication does the Adyen Checkout API use? The Checkout API accepts an API key in the X-API-Key header or HTTP Basic authentication with web service user credentials. Generate the key in your Adyen Customer Area. Through Jentic, the X-API-Key value is stored encrypted in your Jentic One instance and agents call the API with scoped tokens, so the raw key never enters the agent context or logs. ### Can I run 3D Secure authentication through the Checkout API? Yes. Submit the initial authorisation through POST /payments with the cardholder's payment method. If the issuer requires 3DS, the response returns an action object that the front end resolves, then you complete the flow by POSTing the result to /payments/details. Both 3DS2 native and redirect flows are supported on v71. ### What are the rate limits for the Adyen Checkout API? Adyen applies per-endpoint rate limits tied to your merchant account contract, typically into the hundreds of requests per second for /payments on production. Test environment limits are lower. Exceeded limits return HTTP 429 with a retry hint, and Adyen's account team raises limits on request for high-volume merchants. ### How do I capture an authorised payment through Jentic? Search Jentic for 'capture an Adyen payment' to find the POST /payments/{paymentPspReference}/captures operation. Required fields are the original pspReference in the path plus an amount object and merchantReference in the body. Jentic loads the full schema and executes the call. Run it through Jentic One, the self-hosted execution layer. ### Does the Checkout API support payment links and Apple Pay? Yes. Payment links are created with POST /paymentLinks and return a hosted URL covering cards and local methods. Apple Pay sessions are negotiated server-side via POST /applePay/sessions, returning the session payload that the iOS or web Apple Pay button needs to present the sheet to the shopper. ### How do I refund a captured Checkout payment? Call POST /payments/{paymentPspReference}/refunds with the captured amount and a merchantReference. Partial refunds are supported by passing a value lower than the captured total. The refund pspReference returned in the response is the identifier for matching webhook notifications and reconciliation entries. ### Can I limit what my agent is allowed to do with the Adyen Checkout API? Yes. Jentic One is self-hosted, so your own rules decide which Checkout operations and credentials your agent may use. Because modifications put the payment reference in the URL path, such as POST /payments/{paymentPspReference}/captures, a rule can pin the agent to a single payment so it captures that one and nothing else. You choose the operations it may call, so refunds via /payments/{paymentPspReference}/refunds and cancels via /payments/{paymentPspReference}/cancels stay off limits unless you explicitly allow them.