triPOS REST API

<back to all web services

HostStatusRequest

The following routes are available for this service:
GET/api/v1/status/hostGet host status.
HostStatusResponse Parameters:
NameParameterData TypeRequiredDescription
HostStatusbodystringNoThe status of the connection between triPOS and the host.

Allowable Values

  • Online
  • HostUnreachable
  • Offline
MerchantIdbodystringNoThe merchant ID.
ProcessorbodyProcessorNoResponse information from the processor.
TransactionDateTimebodystringNoTransaction date/time in ISO8601 format
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.
Processor Parameters:
NameParameterData TypeRequiredDescription
ProcessorLogsbodyList<string>No[DEPRECATED] Use logs.
ProcessorRawResponsebodystringNo[DEPRECATED] Use rawResponse.
ProcessorReferenceNumberbodystringNo[DEPRECATED] Use the same reference number passed in the request.
ProcessorRequestFailedbodyboolNo[DEPRECATED] Use top level properties (e.g. hasErrors).
ProcessorRequestWasApprovedbodyboolNo[DEPRECATED] Use top level properties (e.g isApproved).
ProcessorResponseCodebodyProcessorResponseCodeNo[DEPRECATED] Use expressResponseCode.

Allowable Values

  • Unknown
  • Approved
  • PartialApproval
  • Decline
  • ExpiredCard
  • Duplicate
  • PickUpCard
  • ReferralCallIssuer
  • InvalidData
  • ApprovedExceptCashback
ProcessorResponseMessagebodystringNo[DEPRECATED] Use expressResponseMessage.
ExpressResponseCodebodystringNoThe response code received from Express.
ExpressResponseMessagebodystringNoThe response message received from Express.
HostResponseCodebodystringNoThe response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
HostResponseMessagebodystringNoThe response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host.
LogsbodyList<string>NoA list of messages pertaining processing the transaction.
RawResponsebodystringNoThe raw processor response. In the case of Express, this is the raw XML returned by the Express platform.

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

<hostStatusRequest 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

<hostStatusResponse 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>
  <_processor>
    <expressResponseCode>String</expressResponseCode>
    <expressResponseMessage>String</expressResponseMessage>
    <hostResponseCode>String</hostResponseCode>
    <hostResponseMessage>String</hostResponseMessage>
    <logs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </logs>
    <processorLogs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </processorLogs>
    <processorRawResponse>String</processorRawResponse>
    <processorReferenceNumber>String</processorReferenceNumber>
    <processorRequestFailed>false</processorRequestFailed>
    <processorRequestWasApproved>false</processorRequestWasApproved>
    <processorResponseCode>Unknown</processorResponseCode>
    <processorResponseMessage>String</processorResponseMessage>
    <rawResponse>String</rawResponse>
  </_processor>
  <hostStatus>String</hostStatus>
  <merchantId>String</merchantId>
  <transactionDateTime>String</transactionDateTime>
</hostStatusResponse>