{"title":"Terminal API go-live checklist","category":"default","creationDate":1598359380,"content":"<div class=\"additional-info-block output-inline\">\n<h5 class=\"article__heading additional-info-block__title\">Support<\/h5><div class=\"additional-info-block__body\"><p>Articles, FAQs, and getting support: <a href=\"https:\/\/help.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Adyen Help<\/a><\/p><\/div><\/div>\n\n<p>A Terminal API integration with Adyen-provided payment terminals lets you start payments from your POS app on a terminal and process these payments through Adyen.<\/p>\n<p>Here we describe how you can take such an integration live.<\/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;\">The information on this page is relevant for building a point-of-sale integration with the Adyen Terminal API and Adyen-provided payment terminals.<\/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\"><a href=\"\/get-started-with-adyen#apply-for-your-live-account\">Apply for a live account<\/a> and <a href=\"\/get-started-with-adyen#step-4-sign-the-contract-and-get-your-live-account\">sign the contract<\/a>.<\/li><li markdown=\"1\">Make sure that you have read the <a href=\"\/get-started-with-adyen\/application-requirements\">Requirements for your live account application<\/a>.<\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2>1. Set up your Adyen live account<\/h2>\n<p>The structure from your test account is not copied over. This means you need to set up a structure for your live account using your <a href=\"https:\/\/ca-live.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">live Customer Area<\/a>.<\/p>\n<ol>\n<li>\n<p>Request the merchant accounts that you need, providing as many details as possible and ensuring you submit the correct documents and links. The usual processing time is around four business days.<\/p>\n<\/li>\n<li>\n<p>If you require stores in your account structure, wait for confirmation that your live merchant accounts are created and then submit a store request form. The usual processing time is around two business days.<\/p>\n<\/li>\n<\/ol>\n<div class=\"next-steps\" id=\"next-steps\" >\n<a href=\"\/point-of-sale\/design-your-integration\/determine-account-structure#request-merchant-accounts\" class=\"next-steps__step\" style=\"width:45%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Create merchant accounts<\/h6><p>Add one or more merchant accounts.<\/p><\/div><\/p><\/a><a href=\"\/point-of-sale\/design-your-integration\/determine-account-structure#create-stores\" class=\"next-steps__step\" style=\"width:45%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Create stores<\/h6><p>Add one or more stores to your merchant accounts.<\/p><\/div><\/p><\/a><\/div>\n\n<h2>2. Review your finance settings<\/h2>\n<ol>\n<li>\n<p>Receive payouts from Adyen:<\/p>\n<ol>\n<li>Provide information about the bank accounts where you want to receive the payouts from Adyen. If you are accepting payments in multiple currencies, you can add a separate bank account for each currency.<\/li>\n<li>Optionally change the payout schedule in your <a href=\"https:\/\/ca-live.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a> &gt; <strong>Finance<\/strong> &gt; <strong>Payout model<\/strong>.<br \/>\nThe default is Sales-Day payout. With this schedule, we pay out funds on a daily basis (from Monday to Friday), with transactions processed on a single day paid out in one batch.<\/li>\n<\/ol>\n<div class=\"next-steps\" id=\"next-steps\" >\n<a href=\"\/account\/manage-payout-account-details\" class=\"next-steps__step\" style=\"width:45%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Add payout accounts<\/h6><p>Add the bank accounts where you want to receive payouts from Adyen.<\/p><\/div><\/p><\/a><a href=\"\/account\/getting-paid\" class=\"next-steps__step\" style=\"width:45%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Review payout schedule<\/h6><p>Optionally switch from Sales-Day payout to another payout schedule.<\/p><\/div><\/p><\/a><\/div>\n\n<\/li>\n<li>\n<p>Use reports for reconciliation:<\/p>\n<ol>\n<li>Set up automatic generation and downloading of reports.<\/li>\n<li>Use the Settlement details report to reconcile your accounts on a transaction level.<\/li>\n<li>Consider automating your reconciliation process.<\/li>\n<\/ol>\n<div class=\"next-steps\" id=\"next-steps\" >\n<a href=\"\/reporting\/automatically-get-reports\" class=\"next-steps__step\" style=\"width:29%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Automate reporting<\/h6><p>Automate the process of generating and downloading reports.<\/p><\/div><\/p><\/a><a href=\"\/reporting\/settlement-reconciliation\/transaction-level\/settlement-details-report\" class=\"next-steps__step\" style=\"width:29%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Settlement details<\/h6><p>Use this report for reconciliation on transaction level.<\/p><\/div><\/p><\/a><a href=\"\/reporting\/settlement-reconciliation\" class=\"next-steps__step\" style=\"width:29%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Automate reconciliation<\/h6><p>Learn how to automate your payment reconciliation.<\/p><\/div><\/p><\/a><\/div>\n\n<\/li>\n<li>\n<p>Consider setting up a Reserve and auto-funding.<br \/>\nYour Reserve is used for refunds and other operational expenses in case of insufficient in-process funds. To make sure there's always enough balance available on your account for refunds, you can also set up auto-funding.<\/p>\n<div class=\"next-steps\" id=\"next-steps\" >\n<a href=\"\/account\/balances\/reserve\" class=\"next-steps__step\" style=\"width:45%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Set up a Reserve<\/h6><p>Make sure that you have a Reserve to cover refunds and expenses.<\/p><\/div><\/p><\/a><a href=\"\/account\/balances\/reserve#auto-funding\" class=\"next-steps__step\" style=\"width:45%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Set up auto-funding<\/h6><p>Make sure that your Reserve doesn't drop below a configured value.<\/p><\/div><\/p><\/a><\/div>\n\n<\/li>\n<\/ol>\n<h2>3. Order live payment terminals<\/h2>\n<p>Your test terminals are for testing purposes only. They cannot process live payments. This means you need to order new terminals from your <a href=\"https:\/\/ca-live.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">live Customer Area<\/a>.<\/p>\n<ol>\n<li>Order the terminals that are needed in your physical stores.<\/li>\n<\/ol>\n<div class=\"next-steps\" id=\"next-steps\" style=display:block;>\n<a href=\"\/point-of-sale\/managing-terminals\/order-terminals#sales-order-steps\" class=\"next-steps__step\" style=\"width:45%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Order terminals<\/h6><p>Order live terminals to be used in your stores.<\/p><\/div><\/p><\/a><\/div>\n\n<p>It usually takes around four business days before your terminals arrive.<\/p>\n<h2>4. Prepare your terminals<\/h2>\n<p>The configured settings from your test environment are not copied over. This means you need to configure your live terminals and payment features from scratch in your <a href=\"https:\/\/ca-live.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">live Customer Area<\/a>. You can configure settings at the company account level, the merchant account level, the store level, or the terminal level.<\/p>\n<ol>\n<li>\n<p>Enable Terminal API for your terminals.<\/p>\n<\/li>\n<li>\n<p>Add payment methods and configure the terminal and payment features that you want to use. 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> will help you with any features that you cannot fully configure yourself.<\/p>\n<\/li>\n<li>\n<p>Assign the live terminals to a store. This makes it easier to start using terminals when you receive them. You can assign terminals from your Customer Area or using our Terminal Management API.<\/p>\n<\/li>\n<\/ol>\n<div class=\"next-steps\" id=\"next-steps\" >\n<a href=\"\/point-of-sale\/design-your-integration\/terminal-api#enable-terminal-api\" class=\"next-steps__step\" style=\"width:29%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Enable Terminal API<\/h6><p>Make your terminals ready to use the Adyen Terminal API.<\/p><\/div><\/p><\/a><a href=\"\/point-of-sale\/design-your-integration\/determine-account-structure\/configure-features\" class=\"next-steps__step\" style=\"width:29%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Configure features<\/h6><p>Add branding and set up payment features.<\/p><\/div><\/p><\/a><a href=\"\/point-of-sale\/managing-terminals\/assign-terminals\" class=\"next-steps__step\" style=\"width:29%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Assign terminals<\/h6><p>Prepare your terminals for quicker boarding.<\/p><\/div><\/p><\/a><\/div>\n\n<h2>5. Update your integration<\/h2>\n<ol>\n<li>\n<p>Add API credentials and optionally add users to your <a href=\"https:\/\/ca-live.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">live Customer Area<\/a>.<br \/>\nFor your live account we recommend creating a new API credential in addition to the default one. For example, you could add a new API credential to each merchant account, or one for point of sale and one for ecommerce.<br \/>\nYou can also create additional Customer Area users for your team members and assign the roles they need for their tasks.<\/p>\n<div class=\"next-steps\" id=\"next-steps\" >\n<a href=\"\/development-resources\/api-credentials#new-credential\" class=\"next-steps__step\" style=\"width:45%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Create API credentials<\/h6><p>Create additional API credentials for your live account.<\/p><\/div><\/p><\/a><a href=\"\/account\/users\" class=\"next-steps__step\" style=\"width:45%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Add Customer Area users<\/h6><p>Make sure team members can do tasks in the Customer Area.<\/p><\/div><\/p><\/a><\/div>\n\n<\/li>\n<li>\n<p>Update your code:<\/p>\n<ul>\n<li>\n<p>For a local integration, update your integration to reflect the IP addresses (or resolvable hostnames) of the live terminals, and install and verify our live terminal certificate (or use a library). If you skipped encrypting communications in your test integration, you need to implement encryption now.<\/p>\n<div class=\"notices red\">\n<p>A live terminal will not accept API requests without encryption.<\/p>\n<\/div>\n<\/li>\n<li>\n<p>For a cloud integration, generate a new API key for the API credential you are using, and switch to the live endpoints and the new API key.<\/p>\n<\/li>\n<\/ul>\n<div class=\"next-steps\" id=\"next-steps\" >\n<a href=\"\/point-of-sale\/design-your-integration\/choose-your-architecture\/local#protect-communications\" class=\"next-steps__step\" style=\"width:45%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Local integration?<\/h6><p>Switch to live terminal IP addresses and our live certificate.<\/p><\/div><\/p><\/a><a href=\"\/point-of-sale\/design-your-integration\/terminal-api#cloud\" class=\"next-steps__step\" style=\"width:45%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Cloud integration?<\/h6><p>Switch to a new API key and live endpoints.<\/p><\/div><\/p><\/a><\/div>\n\n<\/li>\n<li>\n<p>When you receive the terminals, follow the steps in the manual for the terminal model to get the terminals up and running. The steps are to:<\/p>\n<ul>\n<li>Inspect the terminal, to verify it has not been tampered with.<\/li>\n<li>Insert the receipt paper roll (if applicable).<\/li>\n<li>Turn on the terminal.<\/li>\n<li>Connect the terminal to your network.<\/li>\n<li>Board the terminal.<\/li>\n<li>Test the connection with the Adyen payments platform.<\/li>\n<\/ul>\n<div class=\"next-steps\" id=\"next-steps\" style=display:block;>\n<a href=\"\/point-of-sale\/user-manuals\" class=\"next-steps__step\" style=\"width:45%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Get terminals up and ready<\/h6><p>Connect and board the terminals when you receive them.<\/p><\/div><\/p><\/a><\/div>\n\n<\/li>\n<\/ol>\n<h2>6. Test your integration<\/h2>\n<p>To make sure your live integration is working as expected, you should do end-to-end tests from making a payment with a real card to completing your reconciliation.<\/p>\n<p>For example:<\/p>\n<ol>\n<li>\n<p>Make a low-value payment with a real card.<\/p>\n<\/li>\n<li>\n<p>Log in to your <a href=\"https:\/\/ca-live.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">live Customer Area<\/a> and verify that the payment was successful:<\/p>\n<ol>\n<li>Go to <strong>Transactions<\/strong> &gt; <strong>Payments<\/strong> and find the payment.<\/li>\n<li>Click on the payment's <strong>PSP reference<\/strong>.<\/li>\n<li>\n<p>Under <strong>History<\/strong>, you should see the journal types transition from:<\/p>\n<ul>\n<li><span translate=\"no\"><strong>Received<\/strong><\/span><\/li>\n<li><span translate=\"no\"><strong>Authorised<\/strong><\/span><\/li>\n<li>\n<p><span translate=\"no\"><strong>Settled<\/strong><\/span><\/p>\n<!-- list separator -->\n<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n<p>If the payment reached a journal type of <span translate=\"no\"><strong>Settled<\/strong><\/span> the payment was successfully processed by the card issuer.<\/p>\n<\/li>\n<li>\n<p>Refund the payment, to test your refund flow.<\/p>\n<\/li>\n<\/ol>\n<h2>See also<\/h2>\n<div class=\"see-also-links output-inline\" id=\"see-also\">\n<ul><li><a href=\"\/point-of-sale\/diagnostics\"\n                        target=\"_self\"\n                        >\n                    Verify the state of a payment terminal.\n                <\/a><\/li><li><a href=\"\/point-of-sale\/pos-troubleshooting\"\n                        target=\"_self\"\n                        >\n                    Troubleshooting terminals\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/point-of-sale\/get-started\/go-live-tapi","articleFields":{"description":"Checklist to take your Terminal API integration with payment terminals live.","last_edit_on":"25-09-2020 16:53"},"algolia":{"url":"https:\/\/docs.adyen.com\/point-of-sale\/get-started\/go-live-tapi","title":"Terminal API go-live checklist","content":"\nSupportArticles, FAQs, and getting support: Adyen Help\n\nA Terminal API integration with Adyen-provided payment terminals lets you start payments from your POS app on a terminal and process these payments through Adyen.\nHere we describe how you can take such an integration live.\nRequirements\nBefore you begin, take into account the following requirements, limitations, and preparations.\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nThe information on this page is relevant for building a point-of-sale integration with the Adyen Terminal API and Adyen-provided payment terminals.\n\n\nSetup steps\nBefore you begin: Apply for a live account and sign the contract.Make sure that you have read the Requirements for your live account application.\n\n\n\n1. Set up your Adyen live account\nThe structure from your test account is not copied over. This means you need to set up a structure for your live account using your live Customer Area.\n\n\nRequest the merchant accounts that you need, providing as many details as possible and ensuring you submit the correct documents and links. The usual processing time is around four business days.\n\n\nIf you require stores in your account structure, wait for confirmation that your live merchant accounts are created and then submit a store request form. The usual processing time is around two business days.\n\n\n\nCreate merchant accountsAdd one or more merchant accounts.Create storesAdd one or more stores to your merchant accounts.\n\n2. Review your finance settings\n\n\nReceive payouts from Adyen:\n\nProvide information about the bank accounts where you want to receive the payouts from Adyen. If you are accepting payments in multiple currencies, you can add a separate bank account for each currency.\nOptionally change the payout schedule in your Customer Area &gt; Finance &gt; Payout model.\nThe default is Sales-Day payout. With this schedule, we pay out funds on a daily basis (from Monday to Friday), with transactions processed on a single day paid out in one batch.\n\n\nAdd payout accountsAdd the bank accounts where you want to receive payouts from Adyen.Review payout scheduleOptionally switch from Sales-Day payout to another payout schedule.\n\n\n\nUse reports for reconciliation:\n\nSet up automatic generation and downloading of reports.\nUse the Settlement details report to reconcile your accounts on a transaction level.\nConsider automating your reconciliation process.\n\n\nAutomate reportingAutomate the process of generating and downloading reports.Settlement detailsUse this report for reconciliation on transaction level.Automate reconciliationLearn how to automate your payment reconciliation.\n\n\n\nConsider setting up a Reserve and auto-funding.\nYour Reserve is used for refunds and other operational expenses in case of insufficient in-process funds. To make sure there's always enough balance available on your account for refunds, you can also set up auto-funding.\n\nSet up a ReserveMake sure that you have a Reserve to cover refunds and expenses.Set up auto-fundingMake sure that your Reserve doesn't drop below a configured value.\n\n\n\n3. Order live payment terminals\nYour test terminals are for testing purposes only. They cannot process live payments. This means you need to order new terminals from your live Customer Area.\n\nOrder the terminals that are needed in your physical stores.\n\n\nOrder terminalsOrder live terminals to be used in your stores.\n\nIt usually takes around four business days before your terminals arrive.\n4. Prepare your terminals\nThe configured settings from your test environment are not copied over. This means you need to configure your live terminals and payment features from scratch in your live Customer Area. You can configure settings at the company account level, the merchant account level, the store level, or the terminal level.\n\n\nEnable Terminal API for your terminals.\n\n\nAdd payment methods and configure the terminal and payment features that you want to use. Our Support Team will help you with any features that you cannot fully configure yourself.\n\n\nAssign the live terminals to a store. This makes it easier to start using terminals when you receive them. You can assign terminals from your Customer Area or using our Terminal Management API.\n\n\n\nEnable Terminal APIMake your terminals ready to use the Adyen Terminal API.Configure featuresAdd branding and set up payment features.Assign terminalsPrepare your terminals for quicker boarding.\n\n5. Update your integration\n\n\nAdd API credentials and optionally add users to your live Customer Area.\nFor your live account we recommend creating a new API credential in addition to the default one. For example, you could add a new API credential to each merchant account, or one for point of sale and one for ecommerce.\nYou can also create additional Customer Area users for your team members and assign the roles they need for their tasks.\n\nCreate API credentialsCreate additional API credentials for your live account.Add Customer Area usersMake sure team members can do tasks in the Customer Area.\n\n\n\nUpdate your code:\n\n\nFor a local integration, update your integration to reflect the IP addresses (or resolvable hostnames) of the live terminals, and install and verify our live terminal certificate (or use a library). If you skipped encrypting communications in your test integration, you need to implement encryption now.\n\nA live terminal will not accept API requests without encryption.\n\n\n\nFor a cloud integration, generate a new API key for the API credential you are using, and switch to the live endpoints and the new API key.\n\n\n\nLocal integration?Switch to live terminal IP addresses and our live certificate.Cloud integration?Switch to a new API key and live endpoints.\n\n\n\nWhen you receive the terminals, follow the steps in the manual for the terminal model to get the terminals up and running. The steps are to:\n\nInspect the terminal, to verify it has not been tampered with.\nInsert the receipt paper roll (if applicable).\nTurn on the terminal.\nConnect the terminal to your network.\nBoard the terminal.\nTest the connection with the Adyen payments platform.\n\n\nGet terminals up and readyConnect and board the terminals when you receive them.\n\n\n\n6. Test your integration\nTo make sure your live integration is working as expected, you should do end-to-end tests from making a payment with a real card to completing your reconciliation.\nFor example:\n\n\nMake a low-value payment with a real card.\n\n\nLog in to your live Customer Area and verify that the payment was successful:\n\nGo to Transactions &gt; Payments and find the payment.\nClick on the payment's PSP reference.\n\nUnder History, you should see the journal types transition from:\n\nReceived\nAuthorised\n\nSettled\n\n\n\n\n\nIf the payment reached a journal type of Settled the payment was successfully processed by the card issuer.\n\n\nRefund the payment, to test your refund flow.\n\n\nSee also\n\n\n                    Verify the state of a payment terminal.\n                \n                    Troubleshooting terminals\n                \n","type":"page","locale":"en","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"In-person payments","lvl2":"Integration overview","lvl3":"Terminal API go-live checklist"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/","lvl1":"https:\/\/docs.adyen.com\/point-of-sale","lvl2":"https:\/\/docs.adyen.com\/point-of-sale\/get-started","lvl3":"\/point-of-sale\/get-started\/go-live-tapi"},"levels":4,"category":"In-person payments","category_color":"green","tags":["Terminal","go-live","checklist"]}}