UserInput

UserInput prompts the customer to enter a value on the terminal screen. All the responses have GeneralResponse section that informs about successful result or error. See Error Codes and Messages.

Request Body

application/json

Title*string

Prompt title/message displayed to the customer on the terminal.

Timeout?|

Time (in seconds) to wait for customer input before the prompt times out. If null, the terminal's default timeout is used.

Formatint32

MaxLength?|

Maximum number of characters the customer may enter.

Formatint32

HiddenInput?boolean

Indicates whether the entered input should be masked on the terminal display.

Type*string

Indicates the type of input expected from the customer.

Value in"Number" | "Letters" | "NumberAndLetters" | "Currency" | "InfoOnly"

Tpn?string

Terminal profile number. Can be used to identify the terminal in SPIn Proxy environment.

Length10 <= length <= 12

RegisterId?string

Terminal identifier for register. [Obsolete] Can be used to identify the terminal instead of Tpn in SPIn Proxy environment. Required if no Tpn.

Length2 <= length <= 50

Authkey?string

Merchant's authorization password. Required if no SPInToken.

Length10 <= length <= 10

SPInProxyTimeout?|

Timeout for processing transaction with SPIn proxy. If null, the default timeout will be used.

Formatint32

Range1 <= value <= 720

CustomFields?

A collection of custom fields in key-value format.

Response Body

`application/json`

curl -X POST "https://example.com/v2/Common/UserInput" \  -H "Content-Type: application/json" \  -d '{    "Title": "",    "Timeout": null,    "MaxLength": null,    "HiddenInput": false,    "Type": "Number",    "Tpn": "",    "RegisterId": "",    "Authkey": "",    "SPInProxyTimeout": null,    "CustomFields": {}  }'

{
  "InputedString": "",
  "GeneralResponse": {
    "ResultCode": "0",
    "StatusCode": "0000",
    "Message": "",
    "DetailedMessage": "",
    "DelayBeforeNextRequest": null
  }
}

{
  "GeneralResponse": {
    "ResultCode": "0",
    "StatusCode": "0000",
    "Message": "",
    "DetailedMessage": "",
    "DelayBeforeNextRequest": null
  }
}

Request Body

Response Body

200application/json

400application/json

`application/json`

`application/json`