\n Create a session\n <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/shopper-engagement\/shopper-input\/rating","articleFields":{"description":"Use an input request to ask a shopper for a rating from 0 to 10."},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/shopper-engagement\/shopper-input\/rating","title":"Ask for a rating","content":"Here we describe how you can use an input request to ask the shopper or your staff to enter a numerical value from 0 to 10. You can use this, for example, to conduct a Net Promoter Score (NPS) survey.\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 GetRating InputRequest, the terminal prompts the shopper or your staff for a rating. 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 following illustrations show a rating input screen on a portrait and landscape display.\n\n\nOn a small non-android payment terminal portrait display, the information is divided over two screens. The user needs to select Enter rating before entering a value using the keypad.\n\n\n\n\n\n\n\n\nOn a portrait and landscape terminal without keypad, an on-screen keyboard appears.\n\n\nMake a Rating input request\nTo use the payment terminal to ask for a rating from 0 to 10:\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\nGetRating\n\n\nOutputContent.OutputText\nAn array of one or two Text fields containing your own text to show on the terminal. The first text is shown in bold. Use \\n for a new line. Apart from the text you specify, the terminal will show 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\nDigitString\n\n\nMaxInputTime\n(Integer) Time-out in seconds. This is the time that the user gets to finish their input.\n\n\n\n\n\nThe following example asks the shopper for a rating using the first Text field for the core question and the second Text field to explain the scoring.\n\n\n\n\n\nWait for the user to supply the requested input.\n\nThe input is not validated against a format.\n\nIf input is received from the terminal, the input response includes an InputResult object with:\n\nInput.DigitInput: The numeral 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 a rating"},"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\/rating"},"levels":5,"category":"In-person payments","category_color":"green","tags":["rating"]},"articleFiles":{"screen-EN_GetNPS_landscape.png":"![\"\"](\"https:\/\/docs.adyen.com\/images\/8\/d\/d\/3\/7\/8dd37e3cb95580d58d08f1b86c1764ce192d817e-screen-engetnpslandscape.png\")
","screen-EN_GetNPS_portrait.png":"![\"\"](\"https:\/\/docs.adyen.com\/images\/5\/c\/1\/5\/5\/5c15539093c134d018ffc925ec3ce7bb1eeade2c-screen-engetnpsportrait.png\")
","screen-EN_GetRating-landscape.png":"![\"\"](\"https:\/\/docs.adyen.com\/images\/0\/d\/3\/b\/d\/0d3bd22a1c08a5fa7186aeb3b5ad466e01cec373-screen-engetrating-landscape.png\")
","screen-EN_GetRating-portrait.png":"![\"\"](\"https:\/\/docs.adyen.com\/images\/6\/5\/6\/7\/a\/6567aa4802cb7eb793fe5442adaafd8ee1a0b8d8-screen-engetrating-portrait.png\")
","get_rating.json":"get_rating.json<\/p>","Screen-EN_GetNPSP56-2.svg":"![\"\"](\"https:\/\/docs.adyen.com\/user\/pages\/docs\/03.point-of-sale\/41.shopper-engagement\/03.shopper-input\/12.rating\/Screen-EN_GetNPSP56-2.svg?decoding=auto&fetchpriority=auto\")
","screen-EN_GetRatingP56-1.svg":"![\"\"](\"https:\/\/docs.adyen.com\/user\/pages\/docs\/03.point-of-sale\/41.shopper-engagement\/03.shopper-input\/12.rating\/screen-EN_GetRatingP56-1.svg?decoding=auto&fetchpriority=auto\")
"}}
![\"\"](\"\/images\/6\/2\/0\/e\/0\/620e0c5c343676dd2b947bbdb1573f7eebc3caf7-cancel2x.png\")
<\/strong> is selected.<\/li>\n![\"\"](\"\/images\/8\/b\/5\/c\/2\/8b5c2cf59fb943c44fafd299d4bcabf42b715c8d-screen-engetnpsportrait.png\")
<\/p>\n![\"\"](\"\/images\/1\/8\/8\/b\/6\/188b6256f2eba19d8f1e521b8b07dad3d2890b5e-screen-engetnpslandscape.png\")
<\/p>\n![\"\"](\"\/user\/pages\/docs\/03.point-of-sale\/41.shopper-engagement\/03.shopper-input\/12.rating\/screen-EN_GetRatingP56-1.svg?decoding=auto&fetchpriority=auto\")
<\/p>\n<\/div>\n![\"\"](\"\/user\/pages\/docs\/03.point-of-sale\/41.shopper-engagement\/03.shopper-input\/12.rating\/Screen-EN_GetNPSP56-2.svg?decoding=auto&fetchpriority=auto\")
<\/p>\n<\/div>\n<\/div>\n![\"\"](\"\/images\/6\/c\/6\/1\/e\/6c61e3ebaa49fa0a8452f71a9cdb34c93d69e641-screen-engetrating-portrait.png\")
<\/p>\n![\"\"](\"\/images\/c\/3\/1\/a\/3\/c31a3237a48adf9d9ebe5d6b51df3f9f14d94bf6-screen-engetrating-landscape.png\")
<\/p>\n![\"-white_check_mark-\"](\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" "\\"-white_check_mark-\\"")
<\/td>\n