GET | /api/v1 | Returns an array of links for accessing version 1.0 of the triPOS API. |
---|
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /xml/reply/GetServicesRequest HTTP/1.1
Host: booking.pufferdayspa.com
Content-Type: application/xml
Content-Length: length
<getServicesRequest 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 <getServicesResponse 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/authorization</href> <method>POST</method> <rel>authorization</rel> </link> <link> <href>/api/v1/balance</href> <method>POST</method> <rel>balance</rel> </link> <link> <href>/api/v1/configuration</href> <method>GET</method> <rel>configuration</rel> </link> <link> <href>/api/v1/force</href> <method>GET</method> <rel>force</rel> </link> <link> <href>/api/v1/gift</href> <method>GET</method> <rel>gift</rel> </link> <link> <href>/api/v1/paymentAccount</href> <method>POST</method> <rel>paymentAccountCredit</rel> </link> <link> <href>/api/v1/passthrough</href> <method>POST</method> <rel>passthrough</rel> </link> <link> <href>/api/v1/refund</href> <method>POST</method> <rel>refund</rel> </link> <link> <href>/api/v1/refund/{paymentAccountId}</href> <method>POST</method> <rel>paymentAccountRefund</rel> </link> <link> <href>/api/v1/sale</href> <method>POST</method> <rel>sale</rel> </link> <link> <href>/api/v1/signature</href> <method>GET</method> <rel>signature</rel> </link> <link> <href>/api/v1/status</href> <method>GET</method> <rel>status</rel> </link> <link> <href>/api/v1/pinPadSelectionPrompt</href> <method>GET</method> <rel>pinPadSelectionPrompt</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> </getServicesResponse>