{"title":"Ask for amount input","category":"default","creationDate":1776961627,"content":"<p>Here we describe how you can use an input request to ask the customer to enter an amount. For example, the amount they want to pay when splitting the bill. The terminal shows the currency and a placeholder amount with two decimals.<\/p>\n<h2>Requirements<\/h2>\n<p>Before you begin, take into account the following requirement.<\/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;\">A <a href=\"\/pt\/point-of-sale\/get-started\">Terminal API integration<\/a> with payment terminals.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2>How it works<\/h2>\n<p>When you use a <span translate=\"no\"><strong>GetAmount<\/strong><\/span> <code>InputRequest<\/code>, the terminal prompts the shopper or your staff to enter an amount. The terminal continues to show your input request until one of these events occurs:<\/p>\n<ul>\n<li>The user has provided input.<\/li>\n<li>The maximum input time expires. You can set this time in the request.<\/li>\n<li>On the terminal, <strong>Cancel<\/strong> <strong><img alt=\"\" src=\"\/images\/6\/2\/0\/e\/0\/620e0c5c343676dd2b947bbdb1573f7eebc3caf7-cancel2x.png\" \/><\/strong> is selected.<\/li>\n<li>The terminal receives a <a href=\"\/pt\/point-of-sale\/shopper-engagement\/shopper-input\/cancel-input\">request to cancel collecting input<\/a> or any other request from the POS app.<\/li>\n<\/ul>\n<h3>Examples<\/h3>\n<p>The next illustration shows the amount input screen on a landscape display.<\/p>\n<div style=\"text-align: center;\">\n<p><img alt=\"\" src=\"\/images\/9\/4\/1\/2\/1\/94121c686fbede8897a0316de62c8df57b31d55e-screen-engetamountlandscape.png\" \/><\/p>\n<\/div>\n<p>The following illustrations show the amount input screen on a small portrait display and a portrait display without a keypad.<\/p>\n<div class=\"sc-columns\" style=\"columns:2 auto;-moz-columns:2 auto;column-gap:normal;-moz-column-gap:normal;\">\n<div style=\"text-align: center;\">\n<p><img alt=\"\" src=\"\/images\/5\/5\/d\/3\/4\/55d34ee2793a40fd48786ab5ce833a61c3c0e5a1-screen-ene285amount.png\" \/><\/p>\n<\/div>\n<div style=\"text-align: center;\">\n<p><img alt=\"\" src=\"\/images\/e\/a\/d\/5\/e\/ead5efd7b7fcfd83839a19c2da4efbf15116b17d-screen-engetamountportrait280.png\" \/><\/p>\n<\/div>\n<\/div>\n<h2>Entering an amount<\/h2>\n<p>As the customer enters their input, the amount is populated from right to left. For example, when the customer selects <strong>3<\/strong>, <strong>6<\/strong>, <strong>5<\/strong>, and <strong>9<\/strong> to enter an amount of <strong>EUR 36.59<\/strong>, the screen changes from a placeholder amount of EUR 0.00 to <em>EUR 0.03<\/em>, to <em>EUR 0.36<\/em> and so on.<\/p>\n<h2>Currency<\/h2>\n<p>By default, the currency is set to the first one specified for your store in the <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/p>\n<p>To check this: your settings in your Customer Area:<\/p>\n<ol>\n<li>In your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>, go to <strong>In-person payments<\/strong> &gt; <strong>Stores<\/strong>.<\/li>\n<li>Select your store, and go to <strong>Payment features<\/strong>.<\/li>\n<\/ol>\n<p>If you use a merchant account to represent a physical store, it is the first currency defined for the merchant account. To check this:<\/p>\n<ol>\n<li>In your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>, select your merchant account.<\/li>\n<li>Go to <strong>In-person payments<\/strong> &gt; <strong>Terminal settings<\/strong> &gt; <strong>Payment features<\/strong>.<\/li>\n<\/ol>\n<h2 id=\"digit-input-request\">Make an Amount input request<\/h2>\n<p>To use the payment terminal to ask for an amount input:<\/p>\n<ol>\n<li>\n<p>Make a <a href=\"\/pt\/point-of-sale\/design-your-integration\/terminal-api\">Terminal API<\/a> input request, specifying:<\/p>\n<ul>\n<li>\n<p>The standard <a href=\"\/pt\/point-of-sale\/design-your-integration\/terminal-api#request-message-header\">\n  <code>SaleToPOIRequest.MessageHeader<\/code>\n<\/a> object, with <code>MessageClass<\/code> set to <span translate=\"no\"><strong>Device<\/strong><\/span> and <code>MessageCategory<\/code> set to <span translate=\"no\"><strong>Input<\/strong><\/span>.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Parameter<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>ProtocolVersion<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\"><strong>3.0<\/strong><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>MessageClass<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>Device<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>MessageCategory<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>Input<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>MessageType<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>Request<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>ServiceID<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">Your unique ID for this request, consisting of 1-10 alphanumeric characters. Must be unique within the last 48 hours for the terminal (<code>POIID<\/code>) being used.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>SaleID<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">Your unique ID for the system where you send this request from.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>POIID<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">The unique ID of the terminal to send this request to. Format: <em>[device model]-[serial number]<\/em>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ul>\n<ul>\n<li>\n<p>The  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/terminal-api\/latest\/post\/input#request-DisplayOutput\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">InputRequest.DisplayOutput<\/a> object to define what is shown on the terminal:<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Parameter<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>Device<\/code><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>CustomerDisplay<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>InfoQualify<\/code><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>Display<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>OutputContent.OutputFormat<\/code><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>Text<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>OutputContent.PredefinedContent.ReferenceID<\/code><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>GetAmount<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>OutputContent.OutputText<\/code><\/td>\n<td style=\"text-align: left;\">An array of one <code>Text<\/code> field containing your own text to show on the terminal. On a portrait display, limited to about 20 characters. Apart from the text you specify, the terminal will show the currency and an instruction for how to confirm the input.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<li>\n<p>The  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/terminal-api\/latest\/post\/input#request-InputData\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">InputRequest.InputData<\/a> object to handle the user input:<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Parameter<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>Device<\/code><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>CustomerInput<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>InfoQualify<\/code><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>Input<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>InputCommand<\/code><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>DecimalString<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>MaxInputTime<\/code><\/td>\n<td style=\"text-align: left;\">(Integer) Time-out in seconds. This is the time that the user gets to finish their input.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>DefaultInputString<\/code><\/td>\n<td style=\"text-align: left;\">Placeholder text for the input box, to let the user know what input format you are expecting. For example: <strong>0.00<\/strong><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ul>\n<p>The following example asks the shopper to enter the amount they want to pay.<\/p>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"''\" :id=\"'shopper-input_amount'\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"JSON\",\"content\":\"{\\n    \\\"SaleToPOIRequest\\\":{\\n        \\\"MessageHeader\\\":{\\n            \\\"ProtocolVersion\\\":\\\"3.0\\\",\\n            \\\"MessageClass\\\":\\\"Device\\\",\\n            \\\"MessageCategory\\\":\\\"Input\\\",\\n            \\\"MessageType\\\":\\\"Request\\\",\\n            \\\"SaleID\\\":\\\"POSSystemID12345\\\",\\n            \\\"ServiceID\\\":\\\"185341262\\\",\\n            \\\"POIID\\\":\\\"V400m-346937816\\\"\\n        },\\n        \\\"InputRequest\\\":{\\n            \\\"DisplayOutput\\\":{\\n                \\\"Device\\\":\\\"CustomerDisplay\\\",\\n                \\\"InfoQualify\\\":\\\"Display\\\",\\n                \\\"OutputContent\\\":{\\n                    \\\"OutputFormat\\\":\\\"Text\\\",\\n                    \\\"PredefinedContent\\\":{\\n                        \\\"ReferenceID\\\":\\\"GetAmount\\\"\\n                    },\\n                    \\\"OutputText\\\":[\\n                        {\\n                            \\\"Text\\\":\\\"Enter Amount:\\\"\\n                        }\\n                    ]\\n                }\\n            },\\n            \\\"InputData\\\":{\\n                \\\"Device\\\":\\\"CustomerInput\\\",\\n                \\\"InfoQualify\\\":\\\"Input\\\",\\n                \\\"InputCommand\\\":\\\"DecimalString\\\",\\n                \\\"MaxInputTime\\\": 30,\\n                \\\"DefaultInputString\\\":\\\"0.00\\\"\\n            }\\n        }\\n    }\\n}\"},{\"language\":\"java\",\"tabTitle\":\"Java\",\"content\":\"SaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest();\\nMessageHeader messageHeader = new MessageHeader();\\nsaleToPOIRequest.setMessageHeader(messageHeader);\\n\\nInputRequest inputRequest = new InputRequest();\\nDisplayOutput displayOutput = new DisplayOutput();\\ndisplayOutput.setDevice( DeviceType.CUSTOMER_DISPLAY );\\ndisplayOutput.setInfoQualify( InfoQualifyType.DISPLAY );\\nOutputContent outputContent = new OutputContent();\\noutputContent.setOutputFormat( OutputFormatType.TEXT );\\nPredefinedContent predefinedContent = new PredefinedContent();\\npredefinedContent.setReferenceID(\\\"GetAmount\\\");\\noutputContent.setPredefinedContent(predefinedContent);\\n\\nOutputText outputText = new OutputText();\\noutputText.setText(\\\"Enter Amount:\\\");\\noutputContent.getOutputText().add(outputText);\\ndisplayOutput.setOutputContent(outputContent);\\ninputRequest.setDisplayOutput(displayOutput);\\n\\nInputData inputData = new InputData();\\ninputData.setDevice( DeviceType.CUSTOMER_INPUT );\\ninputData.setInfoQualify( InfoQualifyType.INPUT );\\ninputData.setInputCommand( InputCommandType.DIGIT_DECIMAL );\\ninputData.setMaxInputTime( BigInteger.valueOf(30) );\\ninputData.setDefaultInputString(\\\"0.00\\\");\\ninputRequest.setInputData(inputData);\\nsaleToPOIRequest.setInputRequest(inputRequest);\\nterminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest);\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<li>\n<p>Wait for the user to supply the requested input.<\/p>\n<p>If input is received from the terminal, the input response includes an  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/terminal-api\/latest\/post\/input#responses-200-InputResult\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">InputResult<\/a> object with:<\/p>\n<ul>\n<li><code>Input.DigitInput<\/code>: The amount that the user entered.<\/li>\n<\/ul>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Example response when the shopper entered an amount'\" :id=\"''\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n    \\\"SaleToPOIResponse\\\": {\\n        \\\"InputResponse\\\": {\\n            \\\"InputResult\\\": {\\n                \\\"Device\\\": \\\"CustomerInput\\\",\\n                \\\"InfoQualify\\\": \\\"Input\\\",\\n                \\\"Input\\\": {\\n                  \\\"InputCommand\\\": \\\"DecimalString\\\",\\n                  \\\"DigitInput\\\": \\\"36.59\\\"\\n                },\\n                \\\"Response\\\": {\\n                    \\\"Result\\\": \\\"Success\\\",\\n                    \\\"AdditionalResponse\\\": \\\"responseData=%7b%20%20%7d\\\",\\n                }\\n            },\\n            \\\"OutputResult\\\": {\\n                \\\"Device\\\": \\\"CustomerDisplay\\\",\\n                \\\"InfoQualify\\\": \\\"Display\\\",\\n                \\\"Response\\\": {\\n                    \\\"Result\\\": \\\"Success\\\"\\n                }\\n            }\\n        },\\n        \\\"MessageHeader\\\": {\\n           \\\"ProtocolVersion\\\": \\\"3.0\\\",\\n           \\\"MessageClass\\\": \\\"Device\\\",\\n           \\\"MessageCategory\\\": \\\"Input\\\",\\n           \\\"MessageType\\\": \\\"Response\\\",\\n           \\\"SaleID\\\": \\\"POSSystemID12345\\\",\\n           \\\"ServiceID\\\": \\\"185341262\\\",\\n           \\\"POIID\\\": \\\"V400m-346937816\\\"\\n        }\\n    }\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<ul>\n<li>\n<p>If the input request times out, the <code>InputResult.Response<\/code> has <code>AdditionalResponse<\/code>: <span translate=\"no\"><strong>message=Screen%20timeout<\/strong><\/span>, <code>Result<\/code>: <span translate=\"no\"><strong>Failure<\/strong><\/span>, and <code>ErrorCondition<\/code>: <span translate=\"no\"><strong>Cancel<\/strong><\/span>.<\/p>\n<\/li>\n<li>\n<p>If you make a payment request while the input request is waiting for input on the terminal, the payment request overrides the input request. The <code>InputResult.Response<\/code> has <code>AdditionalResponse<\/code>: <span translate=\"no\"><strong>message=A%20higher%20priority%20request%20has%20been%20received<\/strong><\/span>, <code>Result<\/code>: <span translate=\"no\"><strong>Failure<\/strong><\/span>, and <code>ErrorCondition<\/code>: <span translate=\"no\"><strong>Busy<\/strong><\/span>.<\/p>\n<\/li>\n<li>\n<p>If the user declined to respond (selected the <strong>Cancel<\/strong> key <strong><img alt=\"\" src=\"\/images\/6\/2\/0\/e\/0\/620e0c5c343676dd2b947bbdb1573f7eebc3caf7-cancel2x.png\" \/><\/strong>), the <code>InputResult.Input.DigitInput<\/code> field is empty. The <code>InputResult.Response<\/code> has <code>Result<\/code>: <span translate=\"no\"><strong>Failure<\/strong><\/span> and <code>ErrorCondition<\/code>: <span translate=\"no\"><strong>Cancel<\/strong><\/span>.<\/p>\n<\/li>\n<\/ul>\n<\/li>\n<li>\n<p>Pass the <code>DigitInput<\/code> value to your system for validation and further use.<\/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\/shopper-engagement\/shopper-input\/cancel-input\"\n                        target=\"_self\"\n                        >\n                    Cancel an input request\n                <\/a><\/li><li><a href=\"\/point-of-sale\/shopper-engagement\/shopper-input\/select-input-request\"\n                        target=\"_self\"\n                        >\n                    Ask for another type of input\n                <\/a><\/li><li><a href=\"\/point-of-sale\/shopper-engagement\/create-session\"\n                        target=\"_self\"\n                        >\n                    Create a session\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/shopper-engagement\/shopper-input\/amount","articleFields":{"description":"Use an input request to ask a shopper to enter an amount."},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/shopper-engagement\/shopper-input\/amount","title":"Ask for amount input","content":"Here we describe how you can use an input request to ask the customer to enter an amount. For example, the amount they want to pay when splitting the bill. The terminal shows the currency and a placeholder amount with two decimals.\nRequirements\nBefore you begin, take into account the following requirement.\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nA Terminal API integration with payment terminals.\n\n\n\nHow it works\nWhen you use a GetAmount InputRequest, the terminal prompts the shopper or your staff to enter an amount. The terminal continues to show your input request until one of these events occurs:\n\nThe user has provided input.\nThe maximum input time expires. You can set this time in the request.\nOn the terminal, Cancel  is selected.\nThe terminal receives a request to cancel collecting input or any other request from the POS app.\n\nExamples\nThe next illustration shows the amount input screen on a landscape display.\n\n\n\nThe following illustrations show the amount input screen on a small portrait display and a portrait display without a keypad.\n\n\n\n\n\n\n\n\nEntering an amount\nAs the customer enters their input, the amount is populated from right to left. For example, when the customer selects 3, 6, 5, and 9 to enter an amount of EUR 36.59, the screen changes from a placeholder amount of EUR 0.00 to EUR 0.03, to EUR 0.36 and so on.\nCurrency\nBy default, the currency is set to the first one specified for your store in the Customer Area.\nTo check this: your settings in your Customer Area:\n\nIn your Customer Area, go to In-person payments &gt; Stores.\nSelect your store, and go to Payment features.\n\nIf you use a merchant account to represent a physical store, it is the first currency defined for the merchant account. To check this:\n\nIn your Customer Area, select your merchant account.\nGo to In-person payments &gt; Terminal settings &gt; Payment features.\n\nMake an Amount input request\nTo use the payment terminal to ask for an amount input:\n\n\nMake a Terminal API input request, specifying:\n\n\nThe standard \n  SaleToPOIRequest.MessageHeader\n object, with MessageClass set to Device and MessageCategory set to Input.\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\nProtocolVersion\n\n3.0\n\n\nMessageClass\n\nDevice\n\n\nMessageCategory\n\nInput\n\n\nMessageType\n\nRequest\n\n\nServiceID\n\nYour unique ID for this request, consisting of 1-10 alphanumeric characters. Must be unique within the last 48 hours for the terminal (POIID) being used.\n\n\nSaleID\n\nYour unique ID for the system where you send this request from.\n\n\nPOIID\n\nThe unique ID of the terminal to send this request to. Format: [device model]-[serial number].\n\n\n\n\n\n\n\nThe  InputRequest.DisplayOutput object to define what is shown on the terminal:\n\n\n\nParameter\nDescription\n\n\n\n\nDevice\nCustomerDisplay\n\n\nInfoQualify\nDisplay\n\n\nOutputContent.OutputFormat\nText\n\n\nOutputContent.PredefinedContent.ReferenceID\nGetAmount\n\n\nOutputContent.OutputText\nAn array of one Text field containing your own text to show on the terminal. On a portrait display, limited to about 20 characters. Apart from the text you specify, the terminal will show the currency and an instruction for how to confirm the input.\n\n\n\n\n\nThe  InputRequest.InputData object to handle the user input:\n\n\n\nParameter\nDescription\n\n\n\n\nDevice\nCustomerInput\n\n\nInfoQualify\nInput\n\n\nInputCommand\nDecimalString\n\n\nMaxInputTime\n(Integer) Time-out in seconds. This is the time that the user gets to finish their input.\n\n\nDefaultInputString\nPlaceholder text for the input box, to let the user know what input format you are expecting. For example: 0.00\n\n\n\n\n\nThe following example asks the shopper to enter the amount they want to pay.\n\n\n\n\n\nWait for the user to supply the requested input.\nIf input is received from the terminal, the input response includes an  InputResult object with:\n\nInput.DigitInput: The amount that the user entered.\n\n\n\n\n\n\nIf the input request times out, the InputResult.Response has AdditionalResponse: message=Screen%20timeout, Result: Failure, and ErrorCondition: Cancel.\n\n\nIf you make a payment request while the input request is waiting for input on the terminal, the payment request overrides the input request. The InputResult.Response has AdditionalResponse: message=A%20higher%20priority%20request%20has%20been%20received, Result: Failure, and ErrorCondition: Busy.\n\n\nIf the user declined to respond (selected the Cancel key ), the InputResult.Input.DigitInput field is empty. The InputResult.Response has Result: Failure and ErrorCondition: Cancel.\n\n\n\n\nPass the DigitInput value to your system for validation and further use.\n\n\nSee also\n\n\n                    Cancel an input request\n                \n                    Ask for another type of input\n                \n                    Create a session\n                \n","type":"page","locale":"pt","boost":16,"hierarchy":{"lvl0":"Home","lvl1":"Terminais","lvl2":"Shopper engagement","lvl3":"Coletar informa\u00e7\u00f5es","lvl4":"Ask for amount input"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/point-of-sale","lvl2":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/shopper-engagement","lvl3":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/shopper-engagement\/shopper-input","lvl4":"\/pt\/point-of-sale\/shopper-engagement\/shopper-input\/amount"},"levels":5,"category":"In-person payments","category_color":"green","tags":["amount","input"]},"articleFiles":{"screen-EN_e285_amount.png":"<img alt=\"\" src=\"https:\/\/docs.adyen.com\/images\/6\/5\/0\/b\/5\/650b54d91cd399963c79c34e4014d68aa0405e8d-screen-ene285amount.png\" \/>","screen-EN_GetAmount_landscape.png":"<img alt=\"\" src=\"https:\/\/docs.adyen.com\/images\/3\/b\/0\/1\/9\/3b0190095a8571a2d8f4cbdc0c4813d1d60e80e3-screen-engetamountlandscape.png\" \/>","screen-EN_GetAmount_portrait_280.png":"<img alt=\"\" src=\"https:\/\/docs.adyen.com\/images\/f\/3\/8\/2\/5\/f38255cf6903c421c79d08ae882c255fa76d128a-screen-engetamountportrait280.png\" \/>","shopper-input_amount.json":"<p alt=\"\">shopper-input_amount.json<\/p>"}}