UserChoice

UserChoice prompts the customer to select an option from a list displayed 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.

Lengthlength <= 250

ChoiceOptions*array<string>

List of selectable option labels presented to the customer.

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/UserChoice" \  -H "Content-Type: application/json" \  -d '{    "Title": "",    "ChoiceOptions": [      ""    ],    "Tpn": "",    "RegisterId": "",    "Authkey": "",    "SPInProxyTimeout": null,    "CustomFields": {}  }'

{
  "SelectedOption": "",
  "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`