- 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<\/a><\/li>
- API key<\/a><\/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 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 Hosted Checkout integration, you must integrate the following parts:<\/p>\n
- \n
- Your payment server<\/strong>: Sends the API request to create a Hosted Checkout 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 webhook server<\/strong>: Listens for webhook messages that include the outcome of each payment.<\/li>\n<\/ul>\n
Integration steps<\/h3>\n
To integrate Hosted Checkout:<\/p>\n
- \n
- Install an API library<\/a> on your server.<\/li>\n
- Configure the theme<\/a> for your Hosted Checkout page.<\/li>\n
- Create a payment session<\/a>.<\/li>\n
- Redirect the shopper<\/a> to the Hosted Checkout page.<\/li>\n
- Get the payment outcome.<\/li>\n<\/ol>\n
Shopper checkout experience<\/h3>\n
When the shopper goes to check out:<\/p>\n
- \n
- You redirect the shopper to an Adyen-hosted Hosted Checkout page.<\/li>\n
- The shopper completes the payment on the Hosted Checkout page.<\/li>\n
- The shopper gets redirected to your website where you show the result of the payment session.<\/li>\n<\/ol>\n
Payments integration flow<\/h3>\n
Your website\/app, your server and the Hosted Checkout page work together to complete the payment flow:<\/p>\n
- \n
- The shopper chooses to go to check out on your website\/app.<\/li>\n
- Your website\/app triggers your server to create a payment session.<\/li>\n
- Your server makes a POST \/sessions<\/a> request to Adyen, to create a payment session. Adyen returns the URL to the Hosted Checkout page.<\/li>\n
- Your server passes the URL to your website\/app.<\/li>\n
- Your website\/app redirects the shopper to the Hosted Checkout page.<\/li>\n
- The shopper completes the payment on the Hosted Checkout page.<\/li>\n
- The shopper gets redirected to your website\/app with appended session data.<\/li>\n
- Your website\/app passes appended session data to your server.<\/li>\n
- Your server makes a GET \/sessions\/{sessionId}<\/a> request to Adyen. Adyen returns the result of the payment session.<\/li>\n
- Your server passes the result to your website\/app.<\/li>\n
- Your website\/app shows the result of the payment session to the shopper.<\/li>\n
- Your webhook server receives webhook message with the payment outcome.<\/li>\n<\/ol>\n
CnNlcXVlbmNlRGlhZ3JhbQogICAgcGFydGljaXBhbnQgU2hvcHBlcgogICAgcGFydGljaXBhbnQgWW91ciB3ZWJzaXRlL2FwcAogICAgcGFydGljaXBhbnQgWW91ciBwYXltZW50IHNlcnZlcgogICAgcGFydGljaXBhbnQgQWR5ZW4gYXMgQWR5ZW4gc2VydmVyL0hvc3RlZCBDaGVja291dCBwYWdlCiAgICBwYXJ0aWNpcGFudCBZb3VyIHdlYmhvb2sgc2VydmVyCgogICAgU2hvcHBlci0+PllvdXIgd2Vic2l0ZS9hcHA6IDEuIEdvIHRvIGNoZWNrb3V0CiAgICBZb3VyIHdlYnNpdGUvYXBwLT4+WW91ciBwYXltZW50IHNlcnZlcjogMi4gVHJpZ2dlciBzZXNzaW9uIGNyZWF0aW9uIHJlcXVlc3QKICAgIFlvdXIgcGF5bWVudCBzZXJ2ZXItPj5BZHllbjogMy4gUmVxdWVzdCB0byBjcmVhdGUgcGF5bWVudCBzZXNzaW9uIChQT1NUIC9zZXNzaW9ucykgCiAgICBBZHllbi0tPj5Zb3VyIHBheW1lbnQgc2VydmVyOiBIb3N0ZWQgQ2hlY2tvdXQgcGFnZSBVUkwKICAgIFlvdXIgcGF5bWVudCBzZXJ2ZXItLT4+WW91ciB3ZWJzaXRlL2FwcDogNC4gUGFzcyBIb3N0ZWQgQ2hlY2tvdXQgcGFnZSBVUkwKICAgIFlvdXIgd2Vic2l0ZS9hcHAtPj5BZHllbjogNS4gUmVkaXJlY3Qgc2hvcHBlciB0byBIb3N0ZWQgQ2hlY2tvdXQgcGFnZSAKICAgIFNob3BwZXItPj5BZHllbjogNi4gQ29tcGxldGUgcGF5bWVudCBvbiBIb3N0ZWQgQ2hlY2tvdXQgcGFnZQogICAgQWR5ZW4tPj5Zb3VyIHdlYnNpdGUvYXBwOiA3LiBSZWRpcmVjdCBzaG9wcGVyIHRvIHlvdXIgd2Vic2l0ZS9hcHAgd2l0aCBhcHBlbmRlZCBzZXNzaW9uIGRhdGEKICAgIFlvdXIgd2Vic2l0ZS9hcHAtPj5Zb3VyIHBheW1lbnQgc2VydmVyOiA4LiBQYXNzIHRoZSBhcHBlbmRlZCBzZXNzaW9uIGRhdGEKICAgIFlvdXIgcGF5bWVudCBzZXJ2ZXItPj5BZHllbjogOS4gUmVxdWVzdCB0byBnZXQgcmVzdWx0IG9mIHBheW1lbnQgc2Vzc2lvbiAoR0VUIC9zZXNzaW9ucy9zZXNzaW9uSWQpCiAgICBBZHllbi0tPj5Zb3VyIHBheW1lbnQgc2VydmVyOiBSZXN1bHQgb2YgcGF5bWVudCBzZXNzaW9uCiAgICBZb3VyIHBheW1lbnQgc2VydmVyLT4+WW91ciB3ZWJzaXRlL2FwcDogMTAuIFBhc3MgcmVzdWx0IG9mIHBheW1lbnQgc2Vzc2lvbgogICAgWW91ciB3ZWJzaXRlL2FwcC0+PlNob3BwZXI6IDExLiBTaG93IHJlc3VsdCBvZiBwYXltZW50IHNlc3Npb24KICAgIEFkeWVuLT4+WW91ciB3ZWJob29rIHNlcnZlcjogMTIuIFdlYmhvb2sgbWVzc2FnZSB3aXRoIHBheW1lbnQgb3V0Y29tZQo=<\/div><\/div>\nInstall an API library<\/h2>\n\n
\n\nConfigure your theme<\/h2>\n
To create a theme, you must have one of the following user roles<\/a>:<\/p>\n
- \n
- Merchant admin<\/li>\n
- Hosted Checkout and Pay by Link Settings<\/li>\n<\/ul>\n
To create a new theme:<\/p>\n
- \n
- Log in to your Customer Area<\/a> and switch to your merchant account if necessary.<\/li>\n
- Go to Pay by Link<\/strong> > Themes<\/strong>.<\/li>\n
- Select Create a new theme<\/strong>.<\/li>\n
- Enter a Theme name<\/strong>. This name helps you to identify different themes.<\/li>\n
- Enter a Display name<\/strong>. This name is visible to the shopper on the Hosted Checkout page.<\/li>\n
- Upload a brand logo.<\/li>\n
- If you want this to be the default theme for all Hosted Checkout pages, select Set as default<\/strong>. Available only on the merchant account.<\/li>\n
- Select Create<\/strong>.<\/li>\n<\/ol>\n
Get the theme ID:<\/p>\n
- \n
- Go to Pay by Link<\/strong> > Themes<\/strong>.<\/li>\n
- Select the options icon from the theme.<\/li>\n
- Select Copy theme ID.<\/strong>
\nThis copies the theme ID to your system's clipboard.<\/li>\n<\/ol>\nCreate a payment session<\/h2>\n
When the shopper goes to checkout, for example by selecting a Checkout<\/strong> button, make a POST<\/strong> \/sessions<\/a> request from your server, including:<\/p>\n
- Go to Pay by Link<\/strong> > Themes<\/strong>.<\/li>\n
- Log in to your Customer Area<\/a> and switch to your merchant account if necessary.<\/li>\n
- Configure the theme<\/a> for your Hosted Checkout page.<\/li>\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 Hosted Checkout payment session.\n
- API key<\/a><\/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![\"\"](\"https:\/\/docs.adyen.com\/user\/pages\/docs\/standard\/integration\/hosted-checkout\/github-icon.png\"){kind=icon}
","gitpod-icon.png":"![\"\"](\"https:\/\/docs.adyen.com\/user\/pages\/docs\/standard\/integration\/hosted-checkout\/gitpod-icon.png\"){kind=icon}
","sessions-response.json":"