triPOS REST API

PinPadSelectionRequest

The following routes are available for this service:
GET	/api/v1/pinPadSelectionPrompt	Displays a custom PIN pad prompt with custom selection options.

**PinPadSelectionRequest** Parameters:
Name	Parameter	Data Type	Required	Description
LaneId	query	string	Yes	The lane ID.
PromptText	query	string	Yes	The text to display to the cardholder.
Options	query	string	Yes	The options to provide to the cardholder. Separate each option with a pipe '\|' (e.g. options=one\|two\|three)

**PinPadSelectionResponse** Parameters:
Name	Parameter	Data Type	Required	Description
SelectionIndex	body	int	No	The zero-based index of the option that the cardholder selected. The first option you pass in will be considered option 0.

**ApiResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Errors	body	List<ApiError>	No	A list of errors that occurred.
HasErrors	body	bool	No	Indicates if there are errors.
Links	body	IEnumerable<ApiLink>	No	A list of resource links
Logs	body	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	body	string	No	The type of object held in the result.
Warnings	body	List<ApiWarning>	No	A list of warnings that occurred.

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/PinPadSelectionRequest HTTP/1.1 
Host: booking.pufferdayspa.com 
Content-Type: application/xml
Content-Length: length

<pinPadSelectionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://tripos.vantiv.com/2014/09/TriPos.Api">
  <laneId>0</laneId>
  <options>String</options>
  <promptText>String</promptText>
</pinPadSelectionRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<pinPadSelectionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://tripos.vantiv.com/2014/09/TriPos.Api">
  <_errors>
    <error>
      <developerMessage>String</developerMessage>
      <errorType>String</errorType>
      <exceptionMessage>String</exceptionMessage>
      <exceptionTypeFullName>String</exceptionTypeFullName>
      <exceptionTypeShortName>String</exceptionTypeShortName>
      <userMessage>String</userMessage>
    </error>
  </_errors>
  <_hasErrors>true</_hasErrors>
  <_links />
  <_logs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </_logs>
  <_type>String</_type>
  <_warnings>
    <warning>
      <developerMessage>String</developerMessage>
      <userMessage>String</userMessage>
    </warning>
  </_warnings>
  <selectionIndex>0</selectionIndex>
</pinPadSelectionResponse>