{"title":"Collect input","category":"default","creationDate":1672131120,"content":"<p>In addition to making payments, Adyen's payment terminals can request input from your shopper or staff. This allows you to collect the shopper's email address for example, or perform a survey. The communication flow is between your POS app and the terminal, and does not involve the Adyen backend. You need to process the collected input with your own business logic.<\/p>\n<p>After the user has provided input, you may want to show a waiting screen while your back-end system is processing the input. You can do this by <a href=\"\/point-of-sale\/shopper-engagement\/create-session\">creating a session<\/a> that spans multiple requests.<\/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><strong>Requirement<\/strong><\/th>\n<th><strong>Description<\/strong><\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><strong>Integration type<\/strong><\/td>\n<td>A <a href=\"\/point-of-sale\/get-started\">Terminal API integration<\/a> with payment terminals.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2>Input types<\/h2>\n<p>There are several types of input request:<\/p>\n<ul>\n<li><a href=\"\/point-of-sale\/shopper-engagement\/shopper-input\/confirmation\">Confirmation<\/a>: show some information and ask the user to confirm they agree.<\/li>\n<li><a href=\"\/point-of-sale\/shopper-engagement\/shopper-input\/signature\">Signature<\/a>: show some information and ask the user to confirm by supplying their signature.<\/li>\n<li><a href=\"\/point-of-sale\/shopper-engagement\/shopper-input\/menu\">Multiple choice\u2014single answer<\/a>: show a multiple-choice question and let the user select one of the answers. You can use this for NPS surveys, order lists, and such.<\/li>\n<li><a href=\"\/point-of-sale\/shopper-engagement\/shopper-input\/multi-menu\">Multiple choice\u2014multiple answers<\/a>: show a multiple-choice question and let the user select more than one of the answers.<\/li>\n<li><a href=\"\/point-of-sale\/shopper-engagement\/shopper-input\/digit\">Digit<\/a>: ask for numeric input, like a zip code. Another example is a pay-at-table flow where you ask your staff for the table number. This input accepts input of whole numbers.<\/li>\n<li><a href=\"\/point-of-sale\/shopper-engagement\/shopper-input\/amount\">Amount<\/a>: ask for an amount. This input request shows the currency and accepts input of a number with two decimals.<\/li>\n<li><a href=\"\/point-of-sale\/shopper-engagement\/shopper-input\/phone-number\">Phone number<\/a>: ask for a telephone number. The country code is prefilled based on the location of the terminal, but can be changed.<\/li>\n<li><a href=\"\/point-of-sale\/shopper-engagement\/shopper-input\/rating\">Rating<\/a>: show a question and let the user select a rating from 0 to 10.<\/li>\n<li><a href=\"\/point-of-sale\/shopper-engagement\/shopper-input\/text\">Text<\/a>: you'd typically use this to collect an email address.<\/li>\n<\/ul>\n<p>For each input type, we provide predefined elements to show on the terminal display, and fields that you need to populate with your own text. The user enters a response with the terminal keypad or the on-screen keyboard and buttons.<\/p>\n<h2>Select an input request<\/h2>\n<div class=\"next-steps\" id=\"next-steps\" >\n<a href=\"\/point-of-sale\/shopper-engagement\/shopper-input\/confirmation\" class=\"next-steps__step\" style=\"width:29%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><img src=\"\/user\/themes\/adyen\/images\/illustrations\/checkmark.svg\"><h6 class=\"next-steps__title\">Confirmation<\/h6><p>Ask for confirmation.<\/p><\/div><\/p><\/a><a href=\"\/point-of-sale\/shopper-engagement\/shopper-input\/signature\" class=\"next-steps__step\" style=\"width:29%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><img src=\"\/user\/themes\/adyen\/images\/illustrations\/digital-signature.svg\"><h6 class=\"next-steps__title\">Signature<\/h6><p>Ask for a signature.<\/p><\/div><\/p><\/a><a href=\"\/point-of-sale\/shopper-engagement\/shopper-input\/menu\" class=\"next-steps__step\" style=\"width:29%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><img src=\"\/user\/themes\/adyen\/images\/illustrations\/select.svg\"><h6 class=\"next-steps__title\">Multiple choice\u2014single answer<\/h6><p>Ask to select one option from a list.<\/p><\/div><\/p><\/a><a href=\"\/point-of-sale\/shopper-engagement\/shopper-input\/multi-menu\" class=\"next-steps__step\" style=\"width:29%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><img src=\"\/user\/themes\/adyen\/images\/illustrations\/equalizer.svg\"><h6 class=\"next-steps__title\">Multiple choice\u2014multiple answers<\/h6><p>Ask to select one or more options from a list.<\/p><\/div><\/p><\/a><a href=\"\/point-of-sale\/shopper-engagement\/shopper-input\/digit\" class=\"next-steps__step\" style=\"width:29%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><img src=\"\/user\/themes\/adyen\/images\/illustrations\/123.svg\"><h6 class=\"next-steps__title\">Digit<\/h6><p>Ask for numeric input.<\/p><\/div><\/p><\/a><a href=\"\/point-of-sale\/shopper-engagement\/shopper-input\/amount\" class=\"next-steps__step\" style=\"width:29%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><img src=\"\/user\/themes\/adyen\/images\/illustrations\/currency-conversion-2.svg\"><h6 class=\"next-steps__title\">Amount<\/h6><p>Ask to enter an amount.<\/p><\/div><\/p><\/a><a href=\"\/point-of-sale\/shopper-engagement\/shopper-input\/phone-number\" class=\"next-steps__step\" style=\"width:29%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><img src=\"\/user\/themes\/adyen\/images\/illustrations\/mobile.svg\"><h6 class=\"next-steps__title\">Phone number<\/h6><p>Ask for a telephone number.<\/p><\/div><\/p><\/a><a href=\"\/point-of-sale\/shopper-engagement\/shopper-input\/rating\" class=\"next-steps__step\" style=\"width:29%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><img src=\"\/user\/themes\/adyen\/images\/illustrations\/acting.svg\"><h6 class=\"next-steps__title\">Rating<\/h6><p>Ask for a rating.<\/p><\/div><\/p><\/a><a href=\"\/point-of-sale\/shopper-engagement\/shopper-input\/text\" class=\"next-steps__step\" style=\"width:29%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><img src=\"\/user\/themes\/adyen\/images\/illustrations\/blog.svg\"><h6 class=\"next-steps__title\">Text<\/h6><p>Ask for text input.<\/p><\/div><\/p><\/a><\/div>\n\n<h2>Other related options<\/h2>\n<div class=\"next-steps\" id=\"next-steps\" >\n<a href=\"\/point-of-sale\/shopper-engagement\/shopper-input\/cancel-input\" class=\"next-steps__step\" style=\"width:45%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Cancel collecting input<\/h6><p>Cancel an in-progress input request.<\/p><\/div><\/p><\/a><a href=\"\/point-of-sale\/shopper-engagement\/create-session\" 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 a session<\/h6><p>Show a waiting screen while processing input.<\/p><\/div><\/p><\/a><\/div>\n","url":"https:\/\/docs.adyen.com\/point-of-sale\/shopper-engagement\/shopper-input","articleFields":{"description":"Learn how to use the payment terminal to collect input from your customers or staff.","feedback_component":true,"last_edit_on":"27-12-2022 09:53","page_id":"8bb0cdb4-9f9b-4c8e-bc47-be84092ad2be","filters_component":false,"decision_tree":"[]"},"algolia":{"url":"https:\/\/docs.adyen.com\/point-of-sale\/shopper-engagement\/shopper-input","title":"Collect input","content":"In addition to making payments, Adyen's payment terminals can request input from your shopper or staff. This allows you to collect the shopper's email address for example, or perform a survey. The communication flow is between your POS app and the terminal, and does not involve the Adyen backend. You need to process the collected input with your own business logic.\nAfter the user has provided input, you may want to show a waiting screen while your back-end system is processing the input. You can do this by creating a session that spans multiple requests.\nRequirements\nBefore you begin, take into account the following requirements, limitations, and preparations.\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nA Terminal API integration with payment terminals.\n\n\n\nInput types\nThere are several types of input request:\n\nConfirmation: show some information and ask the user to confirm they agree.\nSignature: show some information and ask the user to confirm by supplying their signature.\nMultiple choice\u2014single answer: show a multiple-choice question and let the user select one of the answers. You can use this for NPS surveys, order lists, and such.\nMultiple choice\u2014multiple answers: show a multiple-choice question and let the user select more than one of the answers.\nDigit: ask for numeric input, like a zip code. Another example is a pay-at-table flow where you ask your staff for the table number. This input accepts input of whole numbers.\nAmount: ask for an amount. This input request shows the currency and accepts input of a number with two decimals.\nPhone number: ask for a telephone number. The country code is prefilled based on the location of the terminal, but can be changed.\nRating: show a question and let the user select a rating from 0 to 10.\nText: you'd typically use this to collect an email address.\n\nFor each input type, we provide predefined elements to show on the terminal display, and fields that you need to populate with your own text. The user enters a response with the terminal keypad or the on-screen keyboard and buttons.\nSelect an input request\n\nConfirmationAsk for confirmation.SignatureAsk for a signature.Multiple choice\u2014single answerAsk to select one option from a list.Multiple choice\u2014multiple answersAsk to select one or more options from a list.DigitAsk for numeric input.AmountAsk to enter an amount.Phone numberAsk for a telephone number.RatingAsk for a rating.TextAsk for text input.\n\nOther related options\n\nCancel collecting inputCancel an in-progress input request.Create a sessionShow a waiting screen while processing input.\n","type":"page","locale":"en","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"In-person payments","lvl2":"Shopper engagement","lvl3":"Collect input"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/","lvl1":"https:\/\/docs.adyen.com\/point-of-sale","lvl2":"https:\/\/docs.adyen.com\/point-of-sale\/shopper-engagement","lvl3":"\/point-of-sale\/shopper-engagement\/shopper-input"},"levels":4,"category":"In-person payments","category_color":"green","tags":["Collect","input"]},"articleFiles":{"shopper-input_0.json":"<p alt=\"\">shopper-input_0.json<\/p>","shopper-input_1.json":"<p alt=\"\">shopper-input_1.json<\/p>","shopper-input_2.json":"<p alt=\"\">shopper-input_2.json<\/p>","shopper-input_3.json":"<p alt=\"\">shopper-input_3.json<\/p>","shopper-input_4.json":"<p alt=\"\">shopper-input_4.json<\/p>","shopper-input_5.json":"<p alt=\"\">shopper-input_5.json<\/p>"}}