| GET | /api/v1/input/{laneId} | Displays the prompt associated to the promptType and accepts input text from the card holder | Use the input endpoint to prompt the cardholder for input. This endpoint returns an HTTP status code of 200 if the cardholder pressed the ok or cancel button. See input documentation for more information. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LaneId | path | string | Yes | The lane ID. |
| PromptType | query | string | Yes | The type of prompt to display on the PIN pad. more» |
| FormatType | query | string | No | The PIN pad uses this format to display the input on the PIN pad as the cardholder enters it. more» |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| InputText | form | string | No | The raw, unformatted text that the cardholder entered into the input field on the PIN pad. |
| CardholderAction | form | CardholderAction | No | The cardholder interaction with the PIN pad.Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Errors | form | List<ApiError> | No | A list of errors that occurred. |
| HasErrors | form | bool | No | Indicates if there are errors. |
| Links | form | IEnumerable<ApiLink> | No | A list of resource links |
| Logs | form | List<string> | No | A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose. |
| Type | form | string | No | The type of object held in the result. |
| Warnings | form | List<ApiWarning> | No | A list of warnings that occurred. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserMessage | form | string | No | An error message targeted at the end user of the integrated business application. |
| DeveloperMessage | form | string | No | An error message targeted at the developer of the integrated business application. |
| ErrorType | form | string | No | Code associated with the error if it exists. |
| ExceptionMessage | form | string | No | The body of the exception message. |
| ExceptionTypeFullName | form | string | No | The full name of the exception. |
| ExceptionTypeShortName | form | string | No | The short name of the exception. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Href | form | string | No | A target (a URI) |
| Method | form | string | No | The HTTP method to access the HREF target |
| Relation | form | string | No | The relation aka. 'rel' (the name of the link) |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DeveloperMessage | form | string | No | A warning message targeted at the developer of the integrated business application. |
| UserMessage | form | string | No | A warning message targeted at the end user of the integrated business application. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/InputRequest HTTP/1.1
Host: triposqa.vantiv.com
Content-Type: application/json
Content-Length: length
{"laneId":0,"promptType":"String","formatType":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"inputText":"String","cardholderAction":"OK","_errors":[{"userMessage":"String","developerMessage":"String","errorType":"String","exceptionMessage":"String","exceptionTypeFullName":"String","exceptionTypeShortName":"String"}],"_hasErrors":true,"_links":[],"_logs":["String"],"_type":"String","_warnings":[{"developerMessage":"String","userMessage":"String"}]}