---
title: "Ask for confirmation"
description: "Use an input request to ask a shopper for confirmation."
url: "https://docs.adyen.com/point-of-sale/shopper-engagement/shopper-input/confirmation"
source_url: "https://docs.adyen.com/point-of-sale/shopper-engagement/shopper-input/confirmation.md"
canonical: "https://docs.adyen.com/point-of-sale/shopper-engagement/shopper-input/confirmation"
last_modified: "2026-06-01T15:33:14+02:00"
language: "en"
---

# Ask for confirmation

Use an input request to ask a shopper for confirmation.

[View source](/point-of-sale/shopper-engagement/shopper-input/confirmation.md)

Here we describe how you can use an input request to show some information on the display of the payment terminal and ask the shopper to confirm they agree.

## Requirements

Before you begin, take into account the following requirement.

| Requirement          | Description                                                                      |
| -------------------- | -------------------------------------------------------------------------------- |
| **Integration type** | A [Terminal API integration](/point-of-sale/get-started) with payment terminals. |

## How it works

When you use a **GetConfirmation** `InputRequest`, the terminal shows some information on the display of the terminal and asks the shopper to confirm they agree. The terminal continues to show your input request until one of these events occurs:

* The user has provided input.
* The maximum input time expires. You can set this time in the request.
* On the terminal, **Cancel** **![](/images/5/8/8/4/9/58849deb729ef765fb92c34a2b367b9ae58a5598-cancel2x.png)** is selected.
* The terminal receives a [request to cancel collecting input](/point-of-sale/shopper-engagement/shopper-input/cancel-input) or any other request from the POS app.

### Examples

The following illustrations show a confirmation screen on a portrait, small portrait, and landscape display.

![](/images/4/d/4/a/e/4d4ae86e46e52808776e573ada3d8c2ca6cff9a6-screen-engetconfirmationportrait.png)

![](/images/f/f/a/d/a/ffadaecc77ec11ba4f6040190190b4ecc94e5a1e-screen-engetconfirmationportrait-small.png)

![](/images/1/1/2/5/5/112550f13a4501e7a433d2de8f2c9015f427b7ef-screen-engetconfirmationlandscape.png)

## Make a Confirmation input request

To use the payment terminal to ask a shopper to confirm something:

1. Make a [Terminal API](/point-of-sale/design-your-integration/terminal-api) input request, specifying:

   * The standard [`SaleToPOIRequest.MessageHeader` ](/point-of-sale/design-your-integration/terminal-api#request-message-header)object, with `MessageClass` set to **Device** and `MessageCategory` set to **Input**.

     | Parameter         | Required                                                                                    | Description                                                                                                                                                 |
     | ----------------- | ------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
     | `ProtocolVersion` | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | **3.0**                                                                                                                                                     |
     | `MessageClass`    | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | **Device**                                                                                                                                                  |
     | `MessageCategory` | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | **Input**                                                                                                                                                   |
     | `MessageType`     | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | **Request**                                                                                                                                                 |
     | `ServiceID`       | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | Your 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. |
     | `SaleID`          | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | Your unique ID for the system where you send this request from.                                                                                             |
     | `POIID`           | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The unique ID of the terminal to send this request to. Format: *\[device model]-\[serial number]*.                                                          |

   - The [InputRequest.DisplayOutput](https://docs.adyen.com/api-explorer/terminal-api/latest/post/input#request-DisplayOutput) object to define what is shown on the terminal:

     | Parameter                                     | Description                                                                                                                                                                                                                                                                                                                                    |
     | --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
     | `Device`                                      | **CustomerDisplay**                                                                                                                                                                                                                                                                                                                            |
     | `InfoQualify`                                 | **Display**                                                                                                                                                                                                                                                                                                                                    |
     | `OutputContent.OutputFormat`                  | **Text**                                                                                                                                                                                                                                                                                                                                       |
     | `OutputContent.PredefinedContent.ReferenceID` | **GetConfirmation**                                                                                                                                                                                                                                                                                                                            |
     | `OutputContent.OutputText`                    | An array of four `Text` fields containing your own text to show on the terminal:1) The title. On a portrait display, this is limited to about 20 characters.
     2) Additional text which can be long. Use `\n` to add a line break.
     3) The label for the **"Cancel"** button on the left.
     4) The label for the **"Confirm"** button on the right. |

   - The [InputRequest.InputData](https://docs.adyen.com/api-explorer/terminal-api/latest/post/input#request-InputData) object to handle the user input:

     | Parameter      | Description                                                                               |
     | -------------- | ----------------------------------------------------------------------------------------- |
     | `Device`       | **CustomerInput**                                                                         |
     | `InfoQualify`  | **Input**                                                                                 |
     | `InputCommand` | **GetConfirmation**                                                                       |
     | `MaxInputTime` | (Integer) Time-out in seconds. This is the time that the user gets to finish their input. |

   The following example asks the shopper to confirm they agree.

   #### JSON

   ```json
   {
       "SaleToPOIRequest":{
           "MessageHeader":{
               "ProtocolVersion":"3.0",
               "MessageClass":"Device",
               "MessageCategory":"Input",
               "MessageType":"Request",
               "ServiceID":"0207111104",
               "SaleID":"POSSystemID12345",
               "POIID":"V400m-324688179"
           },
           "InputRequest":{
               "DisplayOutput":{
                   "Device":"CustomerDisplay",
                   "InfoQualify":"Display",
                   "OutputContent":{
                       "OutputFormat":"Text",
                       "PredefinedContent":{
                           "ReferenceID":"GetConfirmation"
                       },
                       "OutputText":[
                           {
                               "Text":"Terms & Conditions"
                           },
                           {
                               "Text":"Do you accept our Terms and Conditions? \n The full text is available on our website."
                           },
                           {
                               "Text":"Decline"
                           },
                           {
                               "Text":"Agree"
                           }
                       ]
                   }
               },
               "InputData":{
                   "Device":"CustomerInput",
                   "InfoQualify":"Input",
                   "InputCommand":"GetConfirmation",
                   "MaxInputTime":30
               }
           }
       }
   }
   ```

   #### Java

   ```java
   SaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest();
   MessageHeader messageHeader = new MessageHeader();
   saleToPOIRequest.setMessageHeader(messageHeader);

   InputRequest inputRequest = new InputRequest();
   DisplayOutput displayOutput = new DisplayOutput();
   displayOutput.setDevice( DeviceType.CUSTOMER_DISPLAY );
   displayOutput.setInfoQualify( InfoQualifyType.DISPLAY );
   OutputContent outputContent = new OutputContent();
   outputContent.setOutputFormat( OutputFormatType.TEXT );
   PredefinedContent predefinedContent = new PredefinedContent();
   predefinedContent.setReferenceID("GetConfirmation");
   outputContent.setPredefinedContent(predefinedContent);

   OutputText title = new OutputText();
   title.setText("Terms & Conditions");
   OutputText additionalText = new OutputText();
   additionalText.setText("Do you accept our Terms and Conditions? \n The full text is available on our website.");
   OutputText declineAnswer = new OutputText();
   declineAnswer.setText("Decline");
   OutputText agreeAnswer = new OutputText();
   agreeAnswer.setText("Agree");
   outputContent.getOutputText().add(title);
   outputContent.getOutputText().add(additionalText);
   outputContent.getOutputText().add(declineAnswer);
   outputContent.getOutputText().add(agreeAnswer);
   displayOutput.setOutputContent(outputContent);
   inputRequest.setDisplayOutput(displayOutput);

   InputData inputData = new InputData();
   inputData.setDevice( DeviceType.CUSTOMER_INPUT );
   inputData.setInfoQualify( InfoQualifyType.INPUT );
   inputData.setInputCommand( InputCommandType.GET_CONFIRMATION );
   inputData.setMaxInputTime( BigInteger.valueOf(30) );
   inputRequest.setInputData(inputData);
   saleToPOIRequest.setInputRequest(inputRequest);
   terminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest);
   ```

2. Wait for the user to supply the requested input.

   The input is not validated against a format.

   If input is received from the terminal, the input response includes an [InputResult](https://docs.adyen.com/api-explorer/terminal-api/latest/post/input#responses-200-InputResult) object with:

   * `Input.ConfirmedFlag`: **true** indicates the shopper confirmed their agreement by selecting the right button on the display ("Agree") or the **Confirm** key **![](/images/6/9/3/7/8/6937831b6e8ba90eddeddde32c67f49162760228-confirm2x.png)** on the keypad.
   * `Input.ConfirmedFlag`: **false** means the shopper selected the left button on the display ("Decline") or the **Cancel** key **![](/images/5/8/8/4/9/58849deb729ef765fb92c34a2b367b9ae58a5598-cancel2x.png)** on the keypad.

   **Example response when the shopper confirmed**

   ```json
   {
     "SaleToPOIResponse": {
       "InputResponse": {
         "InputResult": {
           "Device": "CustomerInput",
           "InfoQualify": "Input",
           "Response": {
             "Result": "Success"
           },
           "Input": {
             "ConfirmedFlag": true,
             "InputCommand": "GetConfirmation"
           }
         },
         "OutputResult": {
           "Device": "CustomerDisplay",
           "InfoQualify": "Display",
           "Response": {
             "Result": "Success"
           }
         }
       },
       "MessageHeader": {...}
     }
   }
   ```

   * If the input request times out, the `InputResult.Response` has `AdditionalResponse`: **message=Screen%20timeout**, `Result`: **Failure**, and `ErrorCondition`: **Cancel**.

   * 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 `InputResult.Response` has `AdditionalResponse`: **message=A%20higher%20priority%20request%20has%20been%20received**, `Result`: **Failure**, and `ErrorCondition`: **Busy**.

3. Pass the relevant data from `InputResult.Input` to your system for validation and further use.

## See also

* [Cancel an input request](/point-of-sale/shopper-engagement/shopper-input/cancel-input)
* [Ask for another type of input](/point-of-sale/shopper-engagement/shopper-input/select-input-request)
* [Create a session](/point-of-sale/shopper-engagement/create-session)
