| GET | /api/v1 | Returns an array of links for accessing version 1.0 of the triPOS API | DO NOT use as a regular-interval health status check. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Errors | form | List<ApiError> | No | A list of errors that occurred. |
| HasErrors | form | bool | No | Indicates if there are errors. |
| Links | form | IEnumerable<ApiLink> | No | A list of resource links |
| Logs | form | 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 | form | string | No | The type of object held in the result. |
| Warnings | form | List<ApiWarning> | No | A list of warnings that occurred. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserMessage | form | string | No | An error message targeted at the end user of the integrated business application. |
| DeveloperMessage | form | string | No | An error message targeted at the developer of the integrated business application. |
| ErrorType | form | string | No | Code associated with the error if it exists. |
| ExceptionMessage | form | string | No | The body of the exception message. |
| ExceptionTypeFullName | form | string | No | The full name of the exception. |
| ExceptionTypeShortName | form | string | No | The short name of the exception. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Href | form | string | No | A target (a URI) |
| Method | form | string | No | The HTTP method to access the HREF target |
| Relation | form | string | No | The relation aka. 'rel' (the name of the link) |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DeveloperMessage | form | string | No | A warning message targeted at the developer of the integrated business application. |
| UserMessage | form | string | No | A warning message targeted at the end user of the integrated business application. |
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/GetServicesRequest HTTP/1.1
Host: triposqa.vantiv.com
Content-Type: application/json
Content-Length: length
{}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"_errors":[{"userMessage":"String","developerMessage":"String","errorType":"String","exceptionMessage":"String","exceptionTypeFullName":"String","exceptionTypeShortName":"String"}],"_hasErrors":true,"_links":[{"href":"/api/v1/authorization","method":"POST","rel":"authorization"},{"href":"/api/v1/balance","method":"POST","rel":"balance"},{"href":"/api/v1/card","method":"GET","rel":"card"},{"href":"/api/v1/display","method":"POST","rel":"display"},{"href":"/api/v1/force","method":"GET","rel":"force"},{"href":"/api/v1/gift","method":"GET","rel":"gift"},{"href":"/api/v1/idle","method":"POST","rel":"idle"},{"href":"/api/v1/input/{laneId}","method":"GET","rel":"input"},{"href":"/api/v1/paymentAccount","method":"POST","rel":"paymentAccountCredit"},{"href":"/api/v1/refund","method":"POST","rel":"refund"},{"href":"/api/v1/refund/{paymentAccountId}","method":"POST","rel":"paymentAccountRefund"},{"href":"/api/v1/sale","method":"POST","rel":"sale"},{"href":"/api/v1/selection","method":"GET","rel":"selection"},{"href":"/api/v1/signature","method":"GET","rel":"signature"},{"href":"/api/v1/status","method":"GET","rel":"status"},{"href":"/api/v1/cancel","method":"POST","rel":"cancelTransaction"}],"_logs":["String"],"_type":"String","_warnings":[{"developerMessage":"String","userMessage":"String"}]}