{"title":"Live endpoints","category":"default","creationDate":1691007660,"content":"<p>To communicate with our API, you submit HTTP requests to applicable endpoints.<\/p>\n<p>These endpoints differ for test and live accounts, and also depend on the data format (SOAP, JSON, or FORM) you use to submit data to the\u00a0Adyen payments platform.<\/p>\n<p>You can <a href=\"#view-your-live-endpoints\">view your live endpoints<\/a> in your Customer Area. When using our <a href=\"\/development-resources\/libraries\">libraries<\/a> or <a href=\"\/plugins\">plugins<\/a>, you also need to pass a <a href=\"#live-url-prefix\">prefix for the live URL<\/a>.<\/p>\n<p>On this page, you can also read about our recommended <a href=\"#maximum-transmission-unit\">Maximum Transmission Unit<\/a> setting, and <a href=\"#connection-keepalive\">connection keepalive<\/a>.<\/p>\n<h2>Requirements<\/h2>\n<p>Before you begin, take into account the following requirements, limitations, and preparations.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Requirement<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><strong>Integration type<\/strong><\/td>\n<td style=\"text-align: left;\">An <a href=\"\/online-payments\/\">online payments<\/a> integration.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong><a href=\"\/development-resources\/api-credentials\/roles\/\">API credential roles<\/a><\/strong><\/td>\n<td style=\"text-align: left;\">Make sure that you have the roles that are required for the API(s) you are using from the <a href=\"\/development-resources\/api-credentials\/roles\/#roles-for-payments\">roles for payments integrations<\/a>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Setup steps<\/strong><\/td>\n<td style=\"text-align: left;\">Before you begin: <ul><li markdown=\"1\">Apply and get your <a href=\"\/get-started-with-adyen\/\">live account<\/a>.<\/li><li markdown=\"1\"><a href=\"\/development-resources\/api-credentials\/#generate-api-key\">Generate an API key<\/a> for the live environment.<\/li><li markdown=\"1\">Refer to the <a href=\"\/online-payments\/go-live-checklist\/\">go-live checklist<\/a> to get an overview of the steps required when taking your integration live.<\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2>View your live endpoints<\/h2>\n<p>Live endpoints are set up automatically. To view your live endpoints in your <a href=\"https:\/\/ca-live.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">live Customer Area<\/a>, go to <strong>Developers<\/strong> &gt; <strong>API URLs<\/strong>.<\/p>\n<p>On the <strong>API URLs and Response<\/strong> page, you can see the configured data centres and prefixes for your company account.<\/p>\n<h3>Location-based live endpoints<\/h3>\n<p>If you need to connect to a certain data center of the Adyen payments platform (for example, US or AU data centers), you can set up location-based live endpoints. To use location-based live endpoints, contact our <a href=\"https:\/\/ca-test.adyen.com\/ca\/ca\/contactUs\/support.shtml?form=other\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Support Team<\/a>.<\/p>\n<div class=\"sc-notice note\"><div>\n<p>If you use a location-based live endpoint, and use our Drop-in\/Components integrations:<\/p>\n<ul>\n<li>For web integrations, if you embed the script and stylesheet to load the client-side resources, make sure to use the <a href=\"\/online-payments\/web-best-practices#embed-script-and-stylesheet\">region-specific URL<\/a> that matches the region of your live endpoint.<\/li>\n<li>When you go live, set the <code>environment<\/code> for your Drop-in\/Component to match your live endpoint region. Find the <code>environment<\/code> values for each platform in our <a href=\"\/online-payments\/build-your-integration\/sessions-flow\">Sessions<\/a> and <a href=\"\/online-payments\/build-your-integration\/advanced-flow\">Advanced<\/a> flow integration guides.\n<\/div><\/div><\/li>\n<\/ul>\n<h2 id=\"live-url-prefix\">Pass the URL prefix<\/h2>\n<p>The live URL prefix is a string composed of a hex-encoded random part and your company name. When using our <a href=\"\/development-resources\/libraries\">libraries<\/a> or <a href=\"\/plugins\">plugins<\/a> for live transactions, you need to pass the prefix for the live URL.<\/p>\n<p>To get your URL prefix, in your <a href=\"https:\/\/ca-live.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">live Customer Area<\/a>, go to <strong>Developers<\/strong> &gt; <strong>API URLs<\/strong> &gt; <strong>Prefix<\/strong>.<\/p>\n<p>For example, if this is your prefix for your live URL: <span translate=\"no\"><strong>1797a841fbb37ca7-AdyenDemo<\/strong><\/span><\/p>\n<p>Then your live URL for the <code>\/payments<\/code> endpoint on Checkout API v69 is: https&#58;\/\/<span translate=\"no\"><strong>1797a841fbb37ca7-AdyenDemo<\/strong><\/span>-checkout-live.adyenpayments.com\/checkout\/v72\/payments<\/p>\n<h2 id=\"live-endpoints-structure\">Live endpoints structure<\/h2>\n<p>The tables below show the structure of test and live endpoints for the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/overview\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Checkout API<\/a> and  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Payment\/latest\/overview\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Classic Payments API<\/a>.<\/p>\n<h3 id=\"checkout-endpoints\">Checkout API endpoints<\/h3>\n<table>\n<thead>\n<tr>\n<th><\/th>\n<th><\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Test<\/td>\n<td><span translate=\"no\">https&#58;\/\/checkout-<strong>test<\/strong>.adyen.com\/<strong>[version]<\/strong>\/<strong>[method]<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td>Live<\/td>\n<td><span translate=\"no\">https&#58;\/\/<strong>[prefix]<\/strong>-checkout-<strong>live<\/strong>.adyenpayments.com\/checkout\/<strong>[version]<\/strong>\/<strong>[method]<\/strong><\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3 id=\"classic-payments-endpoints\">Classic Payments API endpoints<\/h3>\n<table>\n<thead>\n<tr>\n<th><\/th>\n<th><\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Test<\/td>\n<td><span translate=\"no\">https&#58;\/\/pal-<strong>test<\/strong>.adyen.com\/pal\/servlet\/Payment\/<strong>[version]<\/strong>\/<strong>[method]<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td>Live<\/td>\n<td><span translate=\"no\">https&#58;\/\/<strong>[prefix]<\/strong>-pal-<strong>live<\/strong>.adyenpayments.com\/pal\/servlet\/Payment\/<strong>[version]<\/strong>\/<strong>[method]<\/strong><\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>In the live endpoint examples:<\/p>\n<ul>\n<li><code>[version]<\/code>: The version number, always starting with \"v\", for example, <span translate=\"no\"><strong>v52<\/strong><\/span>. To learn more about API versioning for classic and new APIs, see <a href=\"\/development-resources\/versioning\">Versioning<\/a>.<\/li>\n<li><code>[method]<\/code>: The endpoint name, for example, <span translate=\"no\"><strong>payments<\/strong><\/span>, or <span translate=\"no\"><strong>sessions<\/strong><\/span>.<\/li>\n<li><code>[prefix]<\/code>: The <a href=\"#live-url-prefix\">live ULR prefix<\/a> from your Customer Area.<\/li>\n<\/ul>\n<p>Each <a href=\"\/account\/account-structure\/#company-account\">company account<\/a> is provided with a unique hostname to communicate with Adyen's APIs. By connecting to this merchant-specific hostname, Adyen has more control over the routing of transactions. This allows Adyen to improve service robustness and availability for our merchants.<\/p>\n<p>By default, all transactions for a merchant-specific endpoint are routed to the same infrastructure as the standard endpoint, however in case of an infrastructure problem on the standard endpoint, especially if the cause is outside of Adyen's scope of control, alternative routing can be enabled to backup infrastructure and new infrastructure can be provisioned on demand.<\/p>\n<h2>Maximum Transmission Unit<\/h2>\n<p>We strongly recommend setting the <a href=\"https:\/\/en.wikipedia.org\/wiki\/Maximum_transmission_unit\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Maximum Transmission Unit (MTU)<\/a> to 1500 bytes on the network interfaces connecting to Adyen endpoints. The MTU defines the maximum permissible size of the packets passing through the interface. As most of the public internet assumes a maximum packet size of 1500 bytes, configuring the MTU to larger values can lead to connectivity and stability issues.<\/p>\n<h2>Connection keepalive<\/h2>\n<p>You can keep your connections to Adyen endpoints open for longer so you can continue to send or receive data as part of the same TCP session.<br \/>\nYou can do this in your client-side software by enabling TCP keepalive and HTTP keepalive for HTTP connections.<\/p>\n<div class=\"notices yellow\">\n<p>Make sure to enable both TCP keepalive and HTTP keepalive for HTTP connections to avoid connection errors.<\/p>\n<\/div>\n<h3>Timeouts<\/h3>\n<p>Adyen endpoints have a 60-second time-out for inactive HTTP connections with keepalive enabled. If no new data is transmitted within 60 seconds of the TCP session, we initiate closing the TCP connection.<\/p>\n<p>To prevent connection issues, we recommend you set the client-side HTTP keepalive timeout to be shorter than 60 seconds, for example between 30 and 50 seconds.<\/p>\n<h2 id=\"see-also\">See also<\/h2>\n<div class=\"see-also-links output-inline\" id=\"see-also\">\n<ul><li><a href=\"\/risk-management\/automate-submitting-referrals\/referrals-api-reference\/\"\n                        target=\"_self\"\n                        >\n                    Referrals API reference\n                <\/a><\/li><li><a href=\"\/development-resources\/test-cards-and-credentials\/create-test-cards\/test-cards-api\/\"\n                        target=\"_self\"\n                        >\n                    Test cards API\n                <\/a><\/li><li><a href=\"\/point-of-sale\/design-your-integration\/terminal-api#endpoints\"\n                        target=\"_self\"\n                        >\n                    Terminal API endpoints\n                <\/a><\/li><li><a href=\"\/platforms\/integration-checklist\/#go-live\"\n                        target=\"_self\"\n                        >\n                    Go live with Adyen for Platforms\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/development-resources\/live-endpoints","articleFields":{"description":"Learn about the structure of live endpoints and additional recommendations for using live endpoints.","feedback_component":true,"id":"25134655","type":"page","_expandable":{"operations":""},"status":"current","last_edit_on":"18-01-2024 13:03","filters_component":false,"decision_tree":"[]","page_id":"55d98287-02a1-4f2f-a0b1-fb648faf4c84"},"algolia":{"url":"https:\/\/docs.adyen.com\/development-resources\/live-endpoints","title":"Live endpoints","content":"To communicate with our API, you submit HTTP requests to applicable endpoints.\nThese endpoints differ for test and live accounts, and also depend on the data format (SOAP, JSON, or FORM) you use to submit data to the\u00a0Adyen payments platform.\nYou can view your live endpoints in your Customer Area. When using our libraries or plugins, you also need to pass a prefix for the live URL.\nOn this page, you can also read about our recommended Maximum Transmission Unit setting, and connection keepalive.\nRequirements\nBefore you begin, take into account the following requirements, limitations, and preparations.\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nAn online payments integration.\n\n\nAPI credential roles\nMake sure that you have the roles that are required for the API(s) you are using from the roles for payments integrations.\n\n\nSetup steps\nBefore you begin: Apply and get your live account.Generate an API key for the live environment.Refer to the go-live checklist to get an overview of the steps required when taking your integration live.\n\n\n\nView your live endpoints\nLive endpoints are set up automatically. To view your live endpoints in your live Customer Area, go to Developers &gt; API URLs.\nOn the API URLs and Response page, you can see the configured data centres and prefixes for your company account.\nLocation-based live endpoints\nIf you need to connect to a certain data center of the Adyen payments platform (for example, US or AU data centers), you can set up location-based live endpoints. To use location-based live endpoints, contact our Support Team.\n\nIf you use a location-based live endpoint, and use our Drop-in\/Components integrations:\n\nFor web integrations, if you embed the script and stylesheet to load the client-side resources, make sure to use the region-specific URL that matches the region of your live endpoint.\nWhen you go live, set the environment for your Drop-in\/Component to match your live endpoint region. Find the environment values for each platform in our Sessions and Advanced flow integration guides.\n\n\nPass the URL prefix\nThe live URL prefix is a string composed of a hex-encoded random part and your company name. When using our libraries or plugins for live transactions, you need to pass the prefix for the live URL.\nTo get your URL prefix, in your live Customer Area, go to Developers &gt; API URLs &gt; Prefix.\nFor example, if this is your prefix for your live URL: 1797a841fbb37ca7-AdyenDemo\nThen your live URL for the \/payments endpoint on Checkout API v69 is: https&#58;\/\/1797a841fbb37ca7-AdyenDemo-checkout-live.adyenpayments.com\/checkout\/v72\/payments\nLive endpoints structure\nThe tables below show the structure of test and live endpoints for the  Checkout API and  Classic Payments API.\nCheckout API endpoints\n\n\n\n\n\n\n\n\n\nTest\nhttps&#58;\/\/checkout-test.adyen.com\/[version]\/[method]\n\n\nLive\nhttps&#58;\/\/[prefix]-checkout-live.adyenpayments.com\/checkout\/[version]\/[method]\n\n\n\nClassic Payments API endpoints\n\n\n\n\n\n\n\n\n\nTest\nhttps&#58;\/\/pal-test.adyen.com\/pal\/servlet\/Payment\/[version]\/[method]\n\n\nLive\nhttps&#58;\/\/[prefix]-pal-live.adyenpayments.com\/pal\/servlet\/Payment\/[version]\/[method]\n\n\n\nIn the live endpoint examples:\n\n[version]: The version number, always starting with \"v\", for example, v52. To learn more about API versioning for classic and new APIs, see Versioning.\n[method]: The endpoint name, for example, payments, or sessions.\n[prefix]: The live ULR prefix from your Customer Area.\n\nEach company account is provided with a unique hostname to communicate with Adyen's APIs. By connecting to this merchant-specific hostname, Adyen has more control over the routing of transactions. This allows Adyen to improve service robustness and availability for our merchants.\nBy default, all transactions for a merchant-specific endpoint are routed to the same infrastructure as the standard endpoint, however in case of an infrastructure problem on the standard endpoint, especially if the cause is outside of Adyen's scope of control, alternative routing can be enabled to backup infrastructure and new infrastructure can be provisioned on demand.\nMaximum Transmission Unit\nWe strongly recommend setting the Maximum Transmission Unit (MTU) to 1500 bytes on the network interfaces connecting to Adyen endpoints. The MTU defines the maximum permissible size of the packets passing through the interface. As most of the public internet assumes a maximum packet size of 1500 bytes, configuring the MTU to larger values can lead to connectivity and stability issues.\nConnection keepalive\nYou can keep your connections to Adyen endpoints open for longer so you can continue to send or receive data as part of the same TCP session.\nYou can do this in your client-side software by enabling TCP keepalive and HTTP keepalive for HTTP connections.\n\nMake sure to enable both TCP keepalive and HTTP keepalive for HTTP connections to avoid connection errors.\n\nTimeouts\nAdyen endpoints have a 60-second time-out for inactive HTTP connections with keepalive enabled. If no new data is transmitted within 60 seconds of the TCP session, we initiate closing the TCP connection.\nTo prevent connection issues, we recommend you set the client-side HTTP keepalive timeout to be shorter than 60 seconds, for example between 30 and 50 seconds.\nSee also\n\n\n                    Referrals API reference\n                \n                    Test cards API\n                \n                    Terminal API endpoints\n                \n                    Go live with Adyen for Platforms\n                \n","type":"page","locale":"en","boost":18,"hierarchy":{"lvl0":"Home","lvl1":"Development resources","lvl2":"Live endpoints"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/","lvl1":"https:\/\/docs.adyen.com\/development-resources","lvl2":"\/development-resources\/live-endpoints"},"levels":3,"category":"Development Resources","category_color":"green","tags":["endpoints"]}}