Customer Input

API for retrieving input from consumer using SensePass Tags and EMV devices.

API Interface

Get customer input

POST https://api.sensepass.com/api/transactions/customer-input

For terminal agent invoke use this endpoint: http://localhost:8003/api/transactions/customer-input

Request Body

Name	Type	Description
deviceId*	string	unique device ID provided by SensePass
inputs*	array	Array of Customer Input Model

200: OK OK

See Transactions entity schema: #transaction-entity

{
  "success": true,
  "error": null,
  "results": [
    {
      "type": "email",
      "question": "Please input your email address",
      "input": "[e-mail]"
    },
    {
      "type": "phone",
      "minimumLength": 10,
      "question": "Please input your phone number",
      "input": "1234567890"
    }
  ]
}    

400: Bad Request Invalid Input

{
    // Response
}

500: Internal Server Error Internal Error

{
    // Response
}

Example - Simple Questions

{
  "deviceId": "Your-Device-ID",
  "inputs": [
    {
      "type": "email",
      "question": "Please input your email address"
    },
    {
      "type": "phone",
      "minimumLength": 10,
      "question": "Please input your phone number"
    }
  ]
}

Example - Yes/No Questions

{
  "deviceId": "Your-Device-ID",
  "inputs": [
    {
      "type": "boolean",
      "question": "Please verify your email address is a@b.c",
      "acceptText": "Yes",
      "rejectText": "No"
    }
  ]
}

Clear all questions on device

Clear customer input

POST https://api.sensepass.com/api/transactions/customer-input/reset

For terminal agent invoke use this endpoint:

http://localhost:8003/api/transactions/customer-input/reset

Request Body

Name	Type	Description
deviceId*	string	unique device ID provided by SensePass

200: OK OK

{
}

400: Bad Request Invalid Input

{
    // Response
}

500: Internal Server Error Internal Error

{
    // Response
}