triPOS REST API

<back to all web services

CardRequest

The following routes are available for this service:
GET/api/v1/pinpad/card/{laneId}Get card info
CardRequest Parameters:
NameParameterData TypeRequiredDescription
LaneIdpathintYesThe lane ID.
CardResponse Parameters:
NameParameterData TypeRequiredDescription
CardTypebodyCardTypeNoIndidcates whether the card read was a financial or non-financial card.
FinancialCardbodyFinancialCardNoFields for a financial card response. These fields are populated if the card read was a financial card.
NonFinancialCardbodyNonFinancialCardNoFields for a non-financial card response. These fields are populated if the card read was a non-financial card.
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.
FinancialCard Parameters:
NameParameterData TypeRequiredDescription
AccountNumberbodystringNoThe card account number.
BinValuebodystringNoThe BIN entry that matched the account number.
ExpirationYearbodystringNoThe card's expiration year
ExpirationMonthbodystringNoThe card's expiration month
NonFinancialCard Parameters:
NameParameterData TypeRequiredDescription
Track1bodystringNoTrack 1 of the non-financial card
Track2bodystringNoTrack 2 of the non-financial card

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

<cardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://tripos.vantiv.com/2014/09/TriPos.Api">
  <laneId>0</laneId>
</cardRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<cardResponse 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/pinpad/card</href>
      <method>GET</method>
      <rel>card</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>
  <cardType>Unknown</cardType>
  <financialCard>
    <accountNumber>String</accountNumber>
    <binValue>String</binValue>
    <expirationMonth>String</expirationMonth>
    <expirationYear>String</expirationYear>
  </financialCard>
  <nonFinancialCard>
    <track1>String</track1>
    <track2>String</track2>
  </nonFinancialCard>
</cardResponse>