Input

Message category	Class	Direction
`Input`	Device	Both

📘
Used in these guides
Connect your ECR · Loyalty and card acquisition · BankAxept voice authorisation

Used in Customer onboarding to show the terms and ask the customer for their mobile number.

Example request and response

input

All fields

Example Input request

{
  "SaleToPOIRequest": {
    "MessageHeader": {
      "ProtocolVersion": "3.1",
      "ServiceID": "2",
      "MessageClass": "Device",
      "MessageCategory": "Input",
      "MessageType": "Request",
      "DeviceID": "ABC123",
      "SaleID": "ECR123",
      "POIID": "AT12345"
    },
    "InputRequest": {
      "DisplayOutput": {
        "Device": "CustomerDisplay",
        "InfoQualify": "Display",
        "OutputContent": {
          "OutputFormat": "Text",
          "OutputText": [
            {
              "Text": "Text row 1"
            },
            {
              "Text": "Text row 2"
            }
          ]
        }
      },
      "InputData": {
        "Device": "CustomerInput",
        "InfoQualify": "Input",
        "InputCommand": "DigitString"
      }
    }
  }
}

Field	Required	Description
`InputRequest`	Required	Contains the fields below
↳ `DisplayOutput`	Required	Contains the fields below
↳ `Device`	Required	Always "CustomerDisplay"
↳ `InfoQualify`	Required	Always "Display"
↳ `OutputContent`	Required	Contains the fields below
↳ `OutputFormat`	Required	"Text" to indicate text format
↳ `OutputText`	Required	List, one per text row
↳ `Text`	Required	Row text
↳ `InputData`	Required	Contains the fields below
↳ `Device`	Required	Always "CustomerInput"
↳ `InfoQualify`	Required	Always "Input"
↳ `InputCommand`	Required	"DigitString" (requesting digit input like a phone number)

Example Input response

{
  "SaleToPOIResponse": {
    "MessageHeader": {
      "ProtocolVersion": "3.1",
      "ServiceID": "2",
      "MessageClass": "Device",
      "MessageCategory": "Input",
      "MessageType": "Response",
      "DeviceID": "ABC123",
      "SaleID": "ECR123",
      "POIID": "AT12345"
    },
    "InputResponse": {
      "OutputResult": {
        "Device": "CustomerDisplay",
        "InfoQualify": "Display",
        "Response": {
          "Result": "Success"
        }
      },
      "InputResult": {
        "Device": "CustomerInput",
        "InfoQualify": "Input",
        "Response": {
          "Result": "Success"
        },
        "Input": {
          "InputCommand": "DigitString",
          "DigitInput": "11223344"
        }
      }
    }
  }
}

Field	Required	Description
`InputResponse`	Required	Contains the fields below
↳ `OutputResult`	Required	One per DisplayOutput item of the request, and in the same order
↳ `Device`	Required	Copy from request
↳ `InfoQualify`	Required	Copy from request
↳ `Response`	Required
↳ `InputResult`	Required	Contains the fields below
↳ `Device`	Required	Copy from request
↳ `InfoQualify`	Required	Copy from request
↳ `Response`	Required
↳ `Input`	Required	Contains the fields below
↳ `InputCommand`	Required	Copy from request
↳ `DigitInput`	Required	Mobile number entered by customer

BankAxept voice authorisation

For merchants subscribing to BankAxept backup solution voice authorisation is required if the amount exceeds the voice authorisation limit. currently NOK 2,500. If so, the terminal sends an Input request to the ECR that requests the cashier to call a number, inform the voice authorisation service about the BankAxept merchant-id (BAX-number), the amount and the account/card number. The details are displayed at the ECR's display. The cashier then enters the received 6-digit authorisation code in the input window or writes in on the paper receipt. If written on the receipt, there is no need to enter the code in the input window, i.e. an empty input response is accepted.

The prompt text to be displayed is.

Reserveløsning: Ring autorisasjonstelefon 24 17 43 91, oppgi brukerstedsnummer <BAX-number>, beløp <amount> og kontonummer <digits 7-17 from PAN> og skriv inn autorisasjonskoden nedenfor eller på kvitteringen.

The <xxx> strings are replaced by the actual values in each case.

Example Input request

{
  "SaleToPOIRequest": {
    "MessageHeader": {
      "ProtocolVersion": "3.1",
      "ServiceID": "2",
      "MessageClass": "Device",
      "MessageCategory": "Input",
      "MessageType": "Request",
      "DeviceID": "ABC123",
      "SaleID": "ECR123",
      "POIID": "AT12345"
    },
    "InputRequest": {
      "DisplayOutput": {
        "Device": "CashierDisplay",
        "InfoQualify": "Display",
        "OutputContent": {
          "OutputFormat": "Text",
          "OutputText": [
            {
              "Text": "Reserveløsning:"
            },
            {
              "Text": "Ring autorisasjonstelefon 24 17 43 91..."
            }
          ]
        }
      },
      "InputData": {
        "Device": "CashierInput",
        "InfoQualify": "Input",
        "InputCommand": "DigitString",
        "MaxInputTime": 300
      }
    }
  }
}

Field	Required	Description
`InputRequest`	Required	Contains the fields below
↳ `DisplayOutput`	Required	Contains the fields below
↳ `Device`	Required	Always "CashierDisplay"
↳ `InfoQualify`	Required	Always "Display"
↳ `OutputContent`	Required	Contains the fields below
↳ `OutputFormat`	Required	"Text" to indicate text format
↳ `OutputText`	Required	List, one per text row
↳ `Text`	Required	Row text
↳ `InputData`	Required	Contains the fields below
↳ `Device`	Required	Always "CashierInput"
↳ `InfoQualify`	Required	Always "Input"
↳ `InputCommand`	Required	"DigitString" (requesting digit input like a phone number)
↳ `MaxInputTime`	Required	Number of seconds the terminal will wait for input response before timing out and aborting the flow

Example Input response

{
  "SaleToPOIResponse": {
    "MessageHeader": {
      "ProtocolVersion": "3.1",
      "ServiceID": "2",
      "MessageClass": "Device",
      "MessageCategory": "Input",
      "MessageType": "Response",
      "DeviceID": "ABC123",
      "SaleID": "ECR123",
      "POIID": "AT12345"
    },
    "InputResponse": {
      "OutputResult": {
        "Device": "CashierDisplay",
        "InfoQualify": "Display",
        "Response": {
          "Result": "Success"
        }
      },
      "InputResult": {
        "Device": "CashierInput",
        "InfoQualify": "Input",
        "Response": {
          "Result": "Success"
        },
        "Input": {
          "InputCommand": "DigitString",
          "DigitInput": "123456"
        }
      }
    }
  }
}

Field	Required	Description
`InputResponse`	Required	Contains the fields below
↳ `OutputResult`	Required	One per DisplayOutput item of the request, and in the same order
↳ `Device`	Required	Copy from request
↳ `InfoQualify`	Required	Copy from request
↳ `Response`	Required	Contains the fields below
↳ `Result`	Required	"Success" if successful, "Failure" if display message failed
↳ `InputResult`	Required	Contains the fields below
↳ `Device`	Required	Copy from request
↳ `InfoQualify`	Required	Copy from request
↳ `Response`	Required	Contains the fields below
↳ `Result`	Required	"Success" if successful, "Failure" if failed or cancelled by the cashier
↳ `ErrorCondition`	Optional	Not present if "Success", "Cancel" if cancelled by the cashier, "Failure" if other errors
↳ `Input`	Required	Contains the fields below
↳ `InputCommand`	Required	Copy from request
↳ `DigitInput`	Required	Authorisation code (6 digits) entered by the cashier