| GET | /api/v1/selection/{laneId} | Displays the specified selection form | Use the selection endpoint to get cardholder selections via the pinpad. See selection documentation for more information. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LaneId | path | string | Yes | The lane ID. |
| Form | query | string | Yes | The selection form to display. more»Allowable Values
|
| Header | query | string | No | The header text to display to the cardholder. This is only used for the YesNoTextArea or MultiOptionTextArea form. |
| SubHeader | query | string | No | The subheader text to display to the cardholder. This is only used for the YesNoTextArea or MultiOptionTextArea form. |
| Text | query | string | No | The text to display to the cardholder. For the MultiOption form, this is the prompt text. For the YesNoTextArea form, this is the text for the text area. Use | (pipe) for newline. |
| MultiLineText | query | string | No | The list of individual lines of text to be displayed on the PIN pad. Separate each text with a pipe '|' (e.g. multiLineText=promptLine1|promptLine2). For the MultiOption form, this is the prompt text. |
| Options | query | string | No | The selection options to provide to the cardholder. Separate each option with a pipe '|' (e.g. options=one|two|three). This is only used with the MultiOption and MultiOptionTextArea forms. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SelectionIndex | form | int | No | For the YesNoTextArea form, selectionIndex will be 0 when the cardholder selects No and 1 when the cardholder selects Yes. For the MultiOption form, selectionIndex is the zero-based index of the option that the cardholder selected. The first option specified will be considered option 0. |
| 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/SelectionRequest HTTP/1.1
Host: triposqa.vantiv.com
Content-Type: application/json
Content-Length: length
{"laneId":0,"form":"String","header":"String","subHeader":"String","text":"String","multiLineText":"String","options":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"selectionIndex":0,"_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"}]}