| GET | /api/v1/status/host | Get host status. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| HostStatus | body | string | No | The status of the connection between triPOS and the host.Allowable Values
|
| MerchantId | body | string | No | The merchant ID. |
| Processor | body | Processor | No | Response information from the processor. |
| TransactionDateTime | body | string | No | Transaction date/time in ISO8601 format |
| 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. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ProcessorLogs | body | List<string> | No | [DEPRECATED] Use logs. |
| ProcessorRawResponse | body | string | No | [DEPRECATED] Use rawResponse. |
| ProcessorReferenceNumber | body | string | No | [DEPRECATED] Use the same reference number passed in the request. |
| ProcessorRequestFailed | body | bool | No | [DEPRECATED] Use top level properties (e.g. hasErrors). |
| ProcessorRequestWasApproved | body | bool | No | [DEPRECATED] Use top level properties (e.g isApproved). |
| ProcessorResponseCode | body | ProcessorResponseCode | No | [DEPRECATED] Use expressResponseCode.Allowable Values
|
| ProcessorResponseMessage | body | string | No | [DEPRECATED] Use expressResponseMessage. |
| ExpressResponseCode | body | string | No | The response code received from Express. |
| ExpressResponseMessage | body | string | No | The response message received from Express. |
| HostResponseCode | body | string | No | The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host. |
| HostResponseMessage | body | string | No | The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host. |
| Logs | body | List<string> | No | A list of messages pertaining processing the transaction. |
| RawResponse | body | string | No | The 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 .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/HostStatusRequest HTTP/1.1
Host: booking.pufferdayspa.com
Content-Type: application/json
Content-Length: length
{}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"hostStatus":"String","merchantId":"String","_processor":{"processorLogs":["String"],"processorRawResponse":"String","processorReferenceNumber":"String","processorRequestFailed":false,"processorRequestWasApproved":false,"processorResponseCode":"Unknown","processorResponseMessage":"String","expressResponseCode":"String","expressResponseMessage":"String","hostResponseCode":"String","hostResponseMessage":"String","logs":["String"],"rawResponse":"String"},"transactionDateTime":"String","_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"}]}