triPOS REST API

<back to all web services

GetLanesConfigurationRequest

The following routes are available for this service:
GET/api/v1/configuration/lanesRetrieve all lanes settings.
GetLanesConfigurationResponse Parameters:
NameParameterData TypeRequiredDescription
IpLanesbodyList<IpLane>NoList of IP lanes.
SerialLanesbodyList<SerialLane>NoList of serial lanes.
ApiResponse Parameters:
NameParameterData TypeRequiredDescription
ErrorsbodyList<ApiError>NoA list of errors that occurred.
HasErrorsbodyboolNoIndicates if there are errors.
LinksbodyIEnumerable<ApiLink>NoA list of resource links
LogsbodyList<string>NoA list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
TypebodystringNoThe type of object held in the result.
WarningsbodyList<ApiWarning>NoA list of warnings that occurred.
IpLane Parameters:
NameParameterData TypeRequiredDescription
IpbodyIpNoIP device properties.
Lane Parameters:
NameParameterData TypeRequiredDescription
LaneIdbodyintNoLane ID for lane setting.
DescriptionbodystringNoDescription for lane setting.
InitializeOnStartupbodystringNoIf set to 'true', the lane will initialize when triPOS is started. If set to 'false', the lane will initialize when the first request to this lane is recieved by triPOS.
TerminalTypebodyTerminalTypes?Noterminal type

Allowable Values

  • Unknown
  • PointOfSale
  • ECommerce
  • Moto
  • FuelPump
  • Atm
  • Voice
DriverbodyDriverTypes?NoDriver value

Allowable Values

  • Null
  • VeriFoneXpi
  • VeriFoneFormAgent
  • VeriFoneFormAgentXpi
  • Virtual
  • IngenicoRba
  • DebitNull
  • GiftNull
  • FinancialCardReadNull
  • NullPinPadDoesNotSupportSignature
  • NullPinPadReturnsContactlessMsd
  • NullPinPadReturnsEncryptedContactlessMsd
  • ConfigurableNull
IsManualEntryAllowedbodystringNoIf set to 'true' then manual entry of card account numbers on the PIN pad is allowed
IsContactlessMsdEntryAllowedbodystringNoIf set to 'true' then contactless entry is allowed via the PIN pad.
TerminalIdbodystringNoTerminal ID of PIN pad.
Ip Parameters:
NameParameterData TypeRequiredDescription
AddressbodystringNoIP address of PIN pad if not connected via serial device.
PortbodystringNoIP port of PIN pad if not connected via serial device.
SerialLane Parameters:
NameParameterData TypeRequiredDescription
SerialbodySerialNoSerial device properties.
Serial Parameters:
NameParameterData TypeRequiredDescription
ComPortbodystringNoName of serial device to which the PIN pad is attached (e.g. COM1, /dev/tty1, etc).
DataBitsbodystringNoIf the PIN pad is connected via serial device, the data bit setting.
ParitybodystringNoIf the PIN pad is connected via serial device, the parity setting.
StopBitsbodyStopBitTypes?NoIf the PIN pad is connected via serial device, the stop bits setting: None, One, OnePointFive, Two.

Allowable Values

  • None
  • One
  • OnePointFive
  • Two
HandshakebodyHandshakeTypes?NoIf the PIN pad is connected via serial device, the handshake setting: 'None', 'RequestToSend', 'XonXoff'.

Allowable Values

  • None
  • XonXoff
  • RequestToSend
BaudRatebodystringNoBaud rate of serial communications.

Allowable Values

  • 75
  • 110
  • 300
  • 1200
  • 2400
  • 4800
  • 9600
  • 19200
  • 38400
  • 57600
  • 115200

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/GetLanesConfigurationRequest HTTP/1.1 
Host: booking.pufferdayspa.com 
Content-Type: application/xml
Content-Length: length

<getLanesConfigurationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://tripos.vantiv.com/2014/09/TriPos.Api" />

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

<getLanesConfigurationResponse 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>
    <link>
      <href>/api/v1/configuration/lanes/ip</href>
      <method>POST</method>
      <rel>ipLane</rel>
    </link>
    <link>
      <href>/api/v1/configuration/lanes/serial</href>
      <method>POST</method>
      <rel>serialLane</rel>
    </link>
    <link>
      <href>/api/v1/configuration/lanes/ip</href>
      <method>GET</method>
      <rel>ipLanesConfiguration</rel>
    </link>
    <link>
      <href>/api/v1/configuration/lanes/serial</href>
      <method>GET</method>
      <rel>serialLanesConfiguration</rel>
    </link>
  </_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>
  <ipLanes>
    <ipLane i:nil="true" />
  </ipLanes>
  <serialLanes>
    <serialLane i:nil="true" />
  </serialLanes>
</getLanesConfigurationResponse>