Below you will find information on all of the available endpoint actions, fields, requirements, and responses.
Note: This endpoint is intended for use with signature capable terminals only. On POST, if a device is not signature capable and
require_signature is true, the API should return a 422 with the message "Device is not signature capable."
Note: A POST request with a device_terms_api_id that matches an existing declined record will be treated as an update and allow the prompt to be tried again.
View Single Record
View Record List
Note: Filters can be used to search for Device Terms by including the columns you want to filter on as URL parameters. i.e.
|Name||Min||Max||Format||POST Required||POST Allowed||PUT Allowed||Comments|
|id||24||36||string||System generated id|
System generated timestamp
|created_user_id||string||System generated id for user who created record|
|device_terms_api_id||36||string||✔||Can be used for associating record to external systems. Must be unique per location.|
|location_id||36||string||✔||The id for the location that this record should be associated with|
|require_signature||boolean||✔||Set to true or 1 to require a signature from the customer|
|terminal_id||36||string||✔||The id for a terminal that is attached to the location identified by location_id in the request.|
|terms_conditions||1||4096||string||✔||This is the message that is displayed on the screen when prompting for a signature.|
|signature||JSON||A JSON object containing all the info about and including the signature blob (base64).|
Expands (Related Records)
For detail on how to use Expands on an Endpoint, please visit the Expands (Related Records) page.
|Related Record||Filter Name|
An example of “expanding” this endpoint to one of the above related records would look like this:
To use multiple expands on this endpoint, simply include them both separated by a comma like so:
In contrast to using expands to get extra data, you can use filters to limit record results. The following fields can be used for filtering on this endpoint:
Say, for example, that you only wanted to find records from a specific location, you could include that filter in the URL of the GET request like so:
Say, for example, that you only wanted to find records that were created by a specific terminal, you could include that filter in the URL of the GET request like so:
Filtering by Date Created
There is additional functionality that allows searching and filtering on timestamp fields. If you are looking for a record from today, you can simply search on the created_ts field as follows:
For yesterday you could do the following:
If you need more flexibility on dates, you can set the timestamp filter to
custom and supply a custom from and to date like so:
When searching on timestamp fields, the list below contains all the predefined values that can be used:
- this week
- last week
- last 30 days
- last 90 days
- this month
- last month