- Merchant admin role<\/strong><\/li>
- Manage API credentials<\/strong><\/li><\/ul><\/td>\n<\/tr>\n
\n Adyen API credentials<\/strong><\/td>\n Make sure that you have created the following: - API credential<\/li>
- API key<\/li>
- Client key<\/li><\/ul><\/td>\n<\/tr>\n
\n Adyen API credential roles<\/strong><\/td>\n Make sure that you have the roles for payments that are assigned by default.<\/td>\n<\/tr>\n \n Webhooks<\/strong><\/td>\n Subscribe to the following webhooks: - standard webhook with default event codes<\/li><\/ul><\/td>\n<\/tr>\n
\n Limitations<\/strong><\/td>\n Make sure that your integration follows our recommended best practices: - <iframe><\/a><\/strong>: an <iframe> must be hosted on the same domain as the parent window to support payment flows that use redirects.<\/li>
- WebViews<\/a><\/strong>: we do not recommend using WebViews in native apps due to security and functionality limitations. Use native equivalents instead.<\/li>
- Server-side Rendering (SSR)<\/a><\/strong>: if you use SSR, ensure the
AdyenCheckout<\/code> instance and Drop-in are initialized on the client side.<\/li>- Browser support<\/a><\/strong>: we support recent versions of all major browsers.<\/li><\/ul> For 3D Secure 2:
- A strict Content Security Policy (CSP) can prevent native 3D Secure 2 challenges from being loaded on your website, because loading the 3D Secure 2 interface requires adding more URLs to your CSP. Adyen does not maintain a list of all URLs. You can specify to use the redirect flow when creating a session if you do not want to adjust your CSP.<\/li><\/ul><\/td>\n<\/tr>\n
\n Setup steps<\/strong><\/td>\n Make sure that you have done the following: - Set up your test account.<\/li>
- Got an overview of what is required before you accept live payments.<\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
How it works<\/h2>\n
For a Drop-in integration, you must implement the following parts:<\/p>\n
- \n
- Your payment server<\/strong>: Sends the API request to create a payment session.\n
- \n
- Use the \/sessions<\/a> endpoint on Checkout API v72 or later.<\/li>\n
- Use a server-side library<\/a> released on March 30, 2026 or later.<\/li>\n<\/ul><\/li>\n
- Your client website<\/strong>: Shows the Drop-in UI where the shopper makes the payment. Drop-in uses the data from the API responses to handle the payment flow and additional actions on your client website.\n
- \n
- Use Web Drop-in<\/a> v6.30.0 or later.<\/li>\n<\/ul><\/li>\n
- Your webhook server<\/strong>: Listens for webhook messages that include the outcome of each payment.<\/li>\n<\/ul>\n
Payment flow<\/h3>\n
The parts of your integration work together to complete the payment flow. The payment flow is the same for all payments:<\/p>\n
- \n
- The shopper goes to the checkout page.<\/li>\n
- Your client website triggers a request to your payment server to create a payment session.<\/li>\n
- Your server uses the shopper's country and currency information from your client to make a POST \/sessions<\/a> request to create a payment session. Adyen returns session data (
session.id<\/code>,session.sessionData<\/code>).<\/li>\n- Your server passes the session data to your client website.<\/li>\n
- Your client website creates an instance of
AdyenCheckout<\/code> using the session data, initializes Drop-in, and shows the payment UI to the shopper.<\/li>\n- The shopper selects the payment method, enters payment details, and submits the payment.<\/li>\n
- Drop-in handles the payment flow and sends payment data. Adyen returns the result of the payment session to Drop-in.<\/li>\n
- Your client website shows the result of the payment session to the shopper.<\/li>\n
- Your webhook server receives a webhook message with the payment outcome.<\/li>\n<\/ol>\n
CnNlcXVlbmNlRGlhZ3JhbQogICAgcGFydGljaXBhbnQgU2hvcHBlcgogICAgcGFydGljaXBhbnQgQ2xpZW50IGFzIFlvdXIgY2xpZW50IHdlYnNpdGUKICAgIHBhcnRpY2lwYW50IFNlcnZlciBhcyBZb3VyIHBheW1lbnQgc2VydmVyCiAgICBwYXJ0aWNpcGFudCBBZHllbgogICAgcGFydGljaXBhbnQgV2ViaG9vayBhcyBZb3VyIHdlYmhvb2sgc2VydmVyCgogICAgU2hvcHBlci0+PkNsaWVudDogMS4gR28gdG8gY2hlY2tvdXQgcGFnZQogICAgQ2xpZW50LT4+U2VydmVyOiAyLiBUcmlnZ2VyIHJlcXVlc3QgZm9yIHBheW1lbnQgc2Vzc2lvbgogICAgU2VydmVyLT4+QWR5ZW46IDMuIFJlcXVlc3QgdG8gY3JlYXRlIHBheW1lbnQgc2Vzc2lvbiAoUE9TVCAvc2Vzc2lvbnMpCiAgICBBZHllbi0tPj5TZXJ2ZXI6IFNlc3Npb24gZGF0YSAoc2Vzc2lvbi5pZCwgc2Vzc2lvbi5zZXNzaW9uRGF0YSkKICAgIFNlcnZlci0+PkNsaWVudDogNC4gUGFzcyBzZXNzaW9uIGRhdGEKICAgIENsaWVudC0+PkNsaWVudDogNS4gQ3JlYXRlIGluc3RhbmNlIG9mIGBBZHllbkNoZWNrb3V0YCBhbmQgaW5pdGlhbGl6ZSBEcm9wLWluCiAgICBDbGllbnQtPj5TaG9wcGVyOiBTaG93IHBheW1lbnQgVUkgdG8gc2hvcHBlcgogICAgU2hvcHBlci0+PkNsaWVudDogNi4gU3VibWl0IHRoZSBwYXltZW50CiAgICBDbGllbnQtPj5BZHllbjogNy4gRHJvcC1pbiBoYW5kbGVzIHRoZSBwYXltZW50IGZsb3cgYW5kIHNlbmRzIHBheW1lbnQgZGF0YQogICAgQWR5ZW4tLT4+Q2xpZW50OiBSZXN1bHQgb2YgdGhlIHBheW1lbnQgc2Vzc2lvbiB0byBEcm9wLWluCiAgICBDbGllbnQtPj5TaG9wcGVyOiA4LiBTaG93IHJlc3VsdCBvZiBwYXltZW50IHNlc3Npb24KICAgIEFkeWVuLT4+V2ViaG9vazogOS4gV2ViaG9vayBtZXNzYWdlIHdpdGggcGF5bWVudCBvdXRjb21lCg==<\/div><\/div>\nImplementation overview<\/h3>\n
This guide is organized by each part of the integration that you must implement:<\/p>\n
- \n
- \n Payment server<\/strong>\n<\/a>: Server-side setup and API calls.<\/li>\n
- \n Client website<\/strong>\n<\/a>: Client-side setup, Drop-in configuration, and payment handling.<\/li>\n
- \n Webhook server<\/strong>\n<\/a>: Receiving payment outcome notifications.<\/li>\n<\/ul>\n
Payment server<\/h2>\n
This section covers all the server-side implementation required for your Sessions flow integration. Complete these steps to set up your payment server.<\/p>\n
- \n
- Install an API library<\/a><\/li>\n
- Create a payment session<\/a><\/li>\n
- Handle the payment result<\/a><\/li>\n<\/ul>\n
Install an API library<\/h3>\n
We provide server-side API libraries for several programming languages, available through common package managers, like Gradle and npm, for easier installation and version management. Our API libraries will save you development time, because they:<\/p>\n
- \n
- Use an API version that is up to date.<\/li>\n
- Have generated models to help you construct requests.<\/li>\n
- Send the request to Adyen using their built-in HTTP client, so you do not have to create your own.<\/li>\n<\/ul>\n\n\n\n
Create a session<\/h3>\n\n
A payment session is a resource with information about a payment flow initiated by the shopper. This resource has all the information required to handle all the stages of a payment flow. You can configure this resource with information like available payment methods, payment amount, or line items.<\/p>\n
To create a payment session, make a \/sessions<\/a> request, including:<\/p>\n
Request headers:<\/strong><\/p>\n
- Create a payment session<\/a><\/li>\n
- \n Client website<\/strong>\n<\/a>: Client-side setup, Drop-in configuration, and payment handling.<\/li>\n
- Your webhook server<\/strong>: Listens for webhook messages that include the outcome of each payment.<\/li>\n<\/ul>\n
- Use a server-side library<\/a> released on March 30, 2026 or later.<\/li>\n<\/ul><\/li>\n
- Use the \/sessions<\/a> endpoint on Checkout API v72 or later.<\/li>\n
- Your payment server<\/strong>: Sends the API request to create a payment session.\n
- WebViews<\/a><\/strong>: we do not recommend using WebViews in native apps due to security and functionality limitations. Use native equivalents instead.<\/li>
- <iframe><\/a><\/strong>: an <iframe> must be hosted on the same domain as the parent window to support payment flows that use redirects.<\/li>
- standard webhook with default event codes<\/li><\/ul><\/td>\n<\/tr>\n
- Manage API credentials<\/strong><\/li><\/ul><\/td>\n<\/tr>\n
![\"Required\"](\"\/user\/pages\/reuse\/image-library\/01.icons\/required\/required.svg?decoding=auto&fetchpriority=auto\")
<\/span><\/td>\n