$deviceTermsController = $client->getDeviceTermsController();
DeviceTermsController
Create a new device term
function createANewDeviceTerm(V1DeviceTermsRequest $body): ResponseAsyncProcessing
Parameter | Type | Tags | Description |
---|---|---|---|
body |
V1DeviceTermsRequest |
Body, Required | - |
$body = V1DeviceTermsRequestBuilder::init(
'11e95f8ec39de8fbdb0a4f1a',
'11e95f8ec39de8fbdb0a4f1a',
true,
'FUNgib0Vh0B9c0Wbttvr50vNtGLOkTdFL0eFmhN1RJpKhK14IENeDa8irp2dEk9thEcVHvVEyriQeZLs5NjNsCzqNj9JDA4RSJwK647IFtYjrNPN1nBb9bw6hoQ71oT5kpsiXGt8HcqBFVBVeDA7psIzKAyDveAw2o1hfjipkOtXrPgWun0rYwyyFuvqkT1egQYKfYDj'
)
->deviceTermApiId('device_term134')
->build();
$result = $deviceTermsController->createANewDeviceTerm($body);
{
"type": "AsyncProcessing",
"data": {
"async": {
"code": "406c66c3-21cb-47fb-80fc-843bc42507fb",
"link": "/v1/async/status/406c66c3-21cb-47fb-80fc-843bc42507fb"
}
}
}
HTTP Status Code | Error Description | Exception Class |
---|---|---|
401 | Unauthorized | Response401tokenException |
412 | Precondition Failed | Response412Exception |
List all device terms related
function listAllDeviceTermsRelated(
?Page $page = null,
?Sort18 $sort = null,
?Filter2 $filter = null,
?array $expand = null
): ResponseDeviceTermsCollection
Parameter | Type | Tags | Description |
---|---|---|---|
page |
?Page |
Query, Optional | Use this field to specify paginate your results, by using page size and number. You can use one of the following methods: > /endpoint?page={ "number": 1, "size": 50 } > > /endpoint?page[number]=1&page[size]=50 |
sort |
?Sort18 |
Query, Optional | You can use any field_name from this endpoint results, and you can combine more than one field for more complex sorting. You can use one of the following methods:> /endpoint?sort={ "field_name": "asc", "field_name2": "desc" } > > /endpoint?sort[field_name]=asc&sort[field_name2]=desc |
filter |
?Filter2 |
Query, Optional | You can use any field_name from this endpoint results as a filter, and you can also use more than one field to create AND conditions. For date fields (ended with _ts ), you can also search for ranges using the $gte (Greater than or equal to) and/or $lte (Lower than or equal to). You can use one of the following methods:> /endpoint?filter={ "field_name": "Value" } > > /endpoint?filter[field_name]=Value > > /endpoint?filter={ "created_ts": "today" } > > /endpoint?filter[created_ts]=today > > /endpoint?filter={ "created_ts": { "$gte": "yesterday", "$lte": "today" } } > > /endpoint?filter[created_ts][$gte]=yesterday&filter[created_ts][$lte]=today > > /endpoint?filter[address][city]=memphis > > /endpoint?filter={ "address": { "city" : "memphis" } } |
expand |
?(string[]) (Expand5Enum) |
Query, Optional | Most endpoints in the API have a way to retrieve extra data related to the current record being retrieved. For example, if the API request is for the accountvaults endpoint, and the end user also needs to know which contact the token belongs to, this data can be returned in the accountvaults endpoint request. Constraints: Unique Items Required, Pattern: ^[\w]+$ |
$page = PageBuilder::init()
->number(1)
->size(50)
->build();
$result = $deviceTermsController->listAllDeviceTermsRelated($page);
{
"type": "DeviceTermsCollection",
"list": [
{
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"terminal_id": "11e95f8ec39de8fbdb0a4f1a",
"require_signature": true,
"device_term_api_id": "device_term134",
"terms_conditions": "FUNgib0Vh0B9c0Wbttvr50vNtGLOkTdFL0eFmhN1RJpKhK14IENeDa8irp2dEk9thEcVHvVEyriQeZLs5NjNsCzqNj9JDA4RSJwK647IFtYjrNPN1nBb9bw6hoQ71oT5kpsiXGt8HcqBFVBVeDA7psIzKAyDveAw2o1hfjipkOtXrPgWun0rYwyyFuvqkT1egQYKfYDj",
"id": "11e95f8ec39de8fbdb0a4f1a",
"reason_code_id": 1000,
"signature": {
"signature": "iVBORw0KGgoAAAANSUhEUgAAANwAAAAsCAYAAAAOyNaYAAACvklEQVR4nO3bLZOqUBjA8ScaNxqNRiKRaCQaiXwEG7cRiUajH8FINBqJRCKR+NxyD4OIXtaXw2H3/5s5MwZ39rgz/zkvuKKqgar+YTAYnx/y7wUACwgOsIjgAIsIznFlWerlcpl6GngTgnNYVVW6WCxURDTLsqmngzcgOMdtNhsVERURDYJA8zyfekp4AcE5oCgKzfN8cOvYNM1VdCKiURRNMEu8A8FNrCzLm5j68Q1Fx2o3TwTngCzLNAiCq6D6UTVNo0mS6NfXF+HNGME5or+KeZ7XxrVcLjWOY83zXOu6vnqfeQ/bzHkgOIf0VzHP83Sz2eh6vW4D831fy7JsowvDsH1NdO4jOAfVdX0VXhRFWhSFRlHUrmr7/b4NLU3T9jVbTLcRnMO620ezep1Op3bF832/3XIORQr3EJzjumc7E9HQBUoYhjdnPKJzD8E5xjyT647T6aSr1UpFRPf7ffveuq41TdOHZzyicwvBTeBeVGEY3jwaGBrmWV3/Z82K1z/jca5zB8F9wFBQY6JaLBYax7EmSXJ3DD2v624rzUpoVrsgCDjXOWRWwVVVNfUUrvTDGrNK3YsqTdNRn69pGs2y7NshssV0w2yCK4pCRUSPx+Okc/hfWI9WqbFRPaMbYjc+s7ptt1uic8BsgsvzXEVED4fDR3/P2PPVUFifDOo7THxmPiY03/fZXk7s1wR371z1zPnKlbDGuvc9TKKz78cE9yio3W436vbv1fOV6/oPx010/Ee5PbMLbrfbPRWU53kPb/9+SlRj9L8ALcJ/lNsym+DO5/PTQaVpqnVdT/0RnGLOed0LlikvpH6L2QSnqoPX4QT1mu4FC3/Dz5tVcMDcERxgEcEBFhEcYBHBARYRHGARwQEWERxgEcEBFhEcYBHBARYRHGARwQEWERxgEcEBFhEcYBHBARYRHGDRX+EC0ah++pNrAAAAAElFTkSuQmCC",
"resource": "Transaction",
"resource_id": "11e95f8ec39de8fbdb0a4f1a",
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992
},
"created_ts": 1422040992,
"modified_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"created_user": {
"account_number": "5454545454545454",
"branding_domain_url": "{branding_domain_url}",
"cell_phone": "3339998822",
"company_name": "Fortis Payment Systems, LLC",
"contact_id": "11e95f8ec39de8fbdb0a4f1a",
"date_of_birth": "2021-12-01",
"domain_id": "11e95f8ec39de8fbdb0a4f1a",
"email": "[email protected]",
"email_trx_receipt": true,
"home_phone": "3339998822",
"first_name": "John",
"last_name": "Smith",
"locale": "en-US",
"office_phone": "3339998822",
"office_ext_phone": "5",
"primary_location_id": "11e95f8ec39de8fbdb0a4f1a",
"requires_new_password": null,
"terms_condition_code": "20220308",
"tz": "America/New_York",
"ui_prefs": {
"entry_page": "dashboard",
"page_size": 2,
"report_export_type": "csv",
"process_method": "virtual_terminal",
"default_terminal": "11e95f8ec39de8fbdb0a4f1a"
},
"username": "{user_name}",
"user_api_key": "234bas8dfn8238f923w2",
"user_hash_key": null,
"user_type_code": 100,
"password": null,
"zip": "48375",
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"status_id": 1,
"api_only": false,
"is_invitation": false,
"address": {
"city": "Novi",
"state": "MI",
"postal_code": "48375",
"country": "US"
},
"id": "11e95f8ec39de8fbdb0a4f1a",
"status": true,
"login_attempts": 0,
"last_login_ts": 1422040992,
"created_ts": 1422040992,
"modified_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"terms_accepted_ts": 1422040992,
"terms_agree_ip": "192.168.0.10",
"current_date_time": "2019-03-11T10:38:26-0700"
},
"location": {
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992,
"account_number": "5454545454545454",
"address": {
"city": "Novi",
"state": "MI",
"postal_code": "48375",
"country": "US"
},
"branding_domain_id": "11e95f8ec39de8fbdb0a4f1a",
"contact_email_trx_receipt_default": true,
"default_ach": "11e608a7d515f1e093242bb2",
"default_cc": "11e608a442a5f1e092242dda",
"email_reply_to": "[email protected]",
"fax": "3339998822",
"location_api_id": "location-111111",
"location_api_key": "AE34BBCAADF4AE34BBCAADF4",
"location_c1": "custom 1",
"location_c2": "custom 2",
"location_c3": "custom data 3",
"name": "Sample Company Headquarters",
"office_phone": "2481234567",
"office_ext_phone": "1021021209",
"tz": "America/New_York",
"parent_id": "11e95f8ec39de8fbdb0a4f1a",
"show_contact_notes": true,
"show_contact_files": true,
"ticket_hash_key": "A5F443CADF4AE34BBCAADF4"
},
"terminal": {
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"default_product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"terminal_application_id": "11e95f8ec39de8fbdb0a4f1a",
"terminal_cvm_id": "11e95f8ec39de8fbdb0a4f1a",
"terminal_manufacturer_code": "1",
"title": "My terminal",
"mac_address": "3D:F2:C9:A6:B3:4F",
"local_ip_address": "192.168.0.10",
"port": 10009,
"serial_number": "1234567890",
"terminal_number": "973456789012367",
"terminal_timeouts": {
"card_entry_timeout": 47,
"device_terms_prompt_timeout": 30,
"overall_timeout": 125,
"pin_entry_timeout": 40,
"signature_input_timeout": 35,
"signature_submit_timeout": 38,
"status_display_time": 12,
"tip_cashback_timeout": 25,
"transaction_timeout": 17
},
"tip_percents": {
"percent_1": 0,
"percent_2": 2,
"percent_3": 99
},
"header_line_1": "line 1 sample",
"header_line_2": "line 2 sample",
"header_line_3": "line 3 sample",
"header_line_4": "line 4 sample",
"header_line_5": "line 5 sample",
"trailer_line_1": "trailer 1 sample",
"trailer_line_2": "trailer 2 sample",
"trailer_line_3": "trailer 3 sample",
"trailer_line_4": "trailer 4 sample",
"trailer_line_5": "trailer 5 sample",
"default_checkin": "2021-12-01",
"default_checkout": "2021-12-01",
"default_room_rate": 56,
"default_room_number": "303",
"debit": false,
"emv": false,
"cashback_enable": false,
"print_enable": false,
"sig_capture_enable": false,
"is_provisioned": false,
"tip_enable": false,
"validated_decryption": false,
"communication_type": "http",
"active": true,
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992,
"last_registration_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"modified_user_id": "11e95f8ec39de8fbdb0a4f1a"
},
"changelogs": [
{
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"action": "CREATE",
"model": "TransactionRequest",
"model_id": "11ec829598f0d4008be9aba4",
"user_id": "11e95f8ec39de8fbdb0a4f1a",
"changelog_details": [
{
"id": "11e95f8ec39de8fbdb0a4f1a",
"changelog_id": "11e95f8ec39de8fbdb0a4f1a",
"field": "next_run_ts",
"old_value": "1643616000"
}
],
"user": {
"id": "11e95f8ec39de8fbdb0a4f1a",
"username": "[email protected]",
"first_name": "Bob",
"last_name": "Fairview"
}
}
],
"reason_code": {
"id": 50,
"title": "Sample Title"
}
}
],
"links": {
"type": "Links",
"first": "/v1/endpoint?page[size]=10&page[number]=1",
"previous": "/v1/endpoint?page[size]=10&page[number]=5",
"last": "/v1/endpoint?page[size]=10&page[number]=42"
},
"pagination": {
"type": "Pagination",
"total_count": 423,
"page_count": 42,
"page_number": 6,
"page_size": 10
},
"sort": {
"type": "Sorting",
"fields": [
{
"field": "last_name",
"order": "asc"
}
]
}
}
HTTP Status Code | Error Description | Exception Class |
---|---|---|
401 | Unauthorized | Response401tokenException |
View single device term record
function viewSingleDeviceTermRecord(string $deviceTermsId, ?array $expand = null): ResponseDeviceTerm
Parameter | Type | Tags | Description |
---|---|---|---|
deviceTermsId |
string |
Template, Required | Device term ID Constraints: Pattern: ^(([0-9a-fA-F\-]{24,36})|(([0-9a-fA-F]{8})-(([0-9a-fA-F]{4}\-){3})([0-9a-fA-F]{12})))$ |
expand |
?(string[]) (Expand5Enum) |
Query, Optional | Most endpoints in the API have a way to retrieve extra data related to the current record being retrieved. For example, if the API request is for the accountvaults endpoint, and the end user also needs to know which contact the token belongs to, this data can be returned in the accountvaults endpoint request. Constraints: Unique Items Required, Pattern: ^[\w]+$ |
$deviceTermsId = '11e95f8ec39de8fbdb0a4f1a';
$result = $deviceTermsController->viewSingleDeviceTermRecord($deviceTermsId);
{
"type": "DeviceTerm",
"data": {
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"terminal_id": "11e95f8ec39de8fbdb0a4f1a",
"require_signature": true,
"device_term_api_id": "device_term134",
"terms_conditions": "FUNgib0Vh0B9c0Wbttvr50vNtGLOkTdFL0eFmhN1RJpKhK14IENeDa8irp2dEk9thEcVHvVEyriQeZLs5NjNsCzqNj9JDA4RSJwK647IFtYjrNPN1nBb9bw6hoQ71oT5kpsiXGt8HcqBFVBVeDA7psIzKAyDveAw2o1hfjipkOtXrPgWun0rYwyyFuvqkT1egQYKfYDj",
"id": "11e95f8ec39de8fbdb0a4f1a",
"reason_code_id": 1000,
"signature": {
"signature": "iVBORw0KGgoAAAANSUhEUgAAANwAAAAsCAYAAAAOyNaYAAACvklEQVR4nO3bLZOqUBjA8ScaNxqNRiKRaCQaiXwEG7cRiUajH8FINBqJRCKR+NxyD4OIXtaXw2H3/5s5MwZ39rgz/zkvuKKqgar+YTAYnx/y7wUACwgOsIjgAIsIznFlWerlcpl6GngTgnNYVVW6WCxURDTLsqmngzcgOMdtNhsVERURDYJA8zyfekp4AcE5oCgKzfN8cOvYNM1VdCKiURRNMEu8A8FNrCzLm5j68Q1Fx2o3TwTngCzLNAiCq6D6UTVNo0mS6NfXF+HNGME5or+KeZ7XxrVcLjWOY83zXOu6vnqfeQ/bzHkgOIf0VzHP83Sz2eh6vW4D831fy7JsowvDsH1NdO4jOAfVdX0VXhRFWhSFRlHUrmr7/b4NLU3T9jVbTLcRnMO620ezep1Op3bF832/3XIORQr3EJzjumc7E9HQBUoYhjdnPKJzD8E5xjyT647T6aSr1UpFRPf7ffveuq41TdOHZzyicwvBTeBeVGEY3jwaGBrmWV3/Z82K1z/jca5zB8F9wFBQY6JaLBYax7EmSXJ3DD2v624rzUpoVrsgCDjXOWRWwVVVNfUUrvTDGrNK3YsqTdNRn69pGs2y7NshssV0w2yCK4pCRUSPx+Okc/hfWI9WqbFRPaMbYjc+s7ptt1uic8BsgsvzXEVED4fDR3/P2PPVUFifDOo7THxmPiY03/fZXk7s1wR371z1zPnKlbDGuvc9TKKz78cE9yio3W436vbv1fOV6/oPx010/Ee5PbMLbrfbPRWU53kPb/9+SlRj9L8ALcJ/lNsym+DO5/PTQaVpqnVdT/0RnGLOed0LlikvpH6L2QSnqoPX4QT1mu4FC3/Dz5tVcMDcERxgEcEBFhEcYBHBARYRHGARwQEWERxgEcEBFhEcYBHBARYRHGARwQEWERxgEcEBFhEcYBHBARYRHGDRX+EC0ah++pNrAAAAAElFTkSuQmCC",
"resource": "Transaction",
"resource_id": "11e95f8ec39de8fbdb0a4f1a",
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992
},
"created_ts": 1422040992,
"modified_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"created_user": {
"account_number": "5454545454545454",
"branding_domain_url": "{branding_domain_url}",
"cell_phone": "3339998822",
"company_name": "Fortis Payment Systems, LLC",
"contact_id": "11e95f8ec39de8fbdb0a4f1a",
"date_of_birth": "2021-12-01",
"domain_id": "11e95f8ec39de8fbdb0a4f1a",
"email": "[email protected]",
"email_trx_receipt": true,
"home_phone": "3339998822",
"first_name": "John",
"last_name": "Smith",
"locale": "en-US",
"office_phone": "3339998822",
"office_ext_phone": "5",
"primary_location_id": "11e95f8ec39de8fbdb0a4f1a",
"requires_new_password": null,
"terms_condition_code": "20220308",
"tz": "America/New_York",
"ui_prefs": {
"entry_page": "dashboard",
"page_size": 2,
"report_export_type": "csv",
"process_method": "virtual_terminal",
"default_terminal": "11e95f8ec39de8fbdb0a4f1a"
},
"username": "{user_name}",
"user_api_key": "234bas8dfn8238f923w2",
"user_hash_key": null,
"user_type_code": 100,
"password": null,
"zip": "48375",
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"status_id": 1,
"api_only": false,
"is_invitation": false,
"address": {
"city": "Novi",
"state": "MI",
"postal_code": "48375",
"country": "US"
},
"id": "11e95f8ec39de8fbdb0a4f1a",
"status": true,
"login_attempts": 0,
"last_login_ts": 1422040992,
"created_ts": 1422040992,
"modified_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"terms_accepted_ts": 1422040992,
"terms_agree_ip": "192.168.0.10",
"current_date_time": "2019-03-11T10:38:26-0700"
},
"location": {
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992,
"account_number": "5454545454545454",
"address": {
"city": "Novi",
"state": "MI",
"postal_code": "48375",
"country": "US"
},
"branding_domain_id": "11e95f8ec39de8fbdb0a4f1a",
"contact_email_trx_receipt_default": true,
"default_ach": "11e608a7d515f1e093242bb2",
"default_cc": "11e608a442a5f1e092242dda",
"email_reply_to": "[email protected]",
"fax": "3339998822",
"location_api_id": "location-111111",
"location_api_key": "AE34BBCAADF4AE34BBCAADF4",
"location_c1": "custom 1",
"location_c2": "custom 2",
"location_c3": "custom data 3",
"name": "Sample Company Headquarters",
"office_phone": "2481234567",
"office_ext_phone": "1021021209",
"tz": "America/New_York",
"parent_id": "11e95f8ec39de8fbdb0a4f1a",
"show_contact_notes": true,
"show_contact_files": true,
"ticket_hash_key": "A5F443CADF4AE34BBCAADF4"
},
"terminal": {
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"default_product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"terminal_application_id": "11e95f8ec39de8fbdb0a4f1a",
"terminal_cvm_id": "11e95f8ec39de8fbdb0a4f1a",
"terminal_manufacturer_code": "1",
"title": "My terminal",
"mac_address": "3D:F2:C9:A6:B3:4F",
"local_ip_address": "192.168.0.10",
"port": 10009,
"serial_number": "1234567890",
"terminal_number": "973456789012367",
"terminal_timeouts": {
"card_entry_timeout": 47,
"device_terms_prompt_timeout": 30,
"overall_timeout": 125,
"pin_entry_timeout": 40,
"signature_input_timeout": 35,
"signature_submit_timeout": 38,
"status_display_time": 12,
"tip_cashback_timeout": 25,
"transaction_timeout": 17
},
"tip_percents": {
"percent_1": 0,
"percent_2": 2,
"percent_3": 99
},
"header_line_1": "line 1 sample",
"header_line_2": "line 2 sample",
"header_line_3": "line 3 sample",
"header_line_4": "line 4 sample",
"header_line_5": "line 5 sample",
"trailer_line_1": "trailer 1 sample",
"trailer_line_2": "trailer 2 sample",
"trailer_line_3": "trailer 3 sample",
"trailer_line_4": "trailer 4 sample",
"trailer_line_5": "trailer 5 sample",
"default_checkin": "2021-12-01",
"default_checkout": "2021-12-01",
"default_room_rate": 56,
"default_room_number": "303",
"debit": false,
"emv": false,
"cashback_enable": false,
"print_enable": false,
"sig_capture_enable": false,
"is_provisioned": false,
"tip_enable": false,
"validated_decryption": false,
"communication_type": "http",
"active": true,
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992,
"last_registration_ts": 1422040992,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"modified_user_id": "11e95f8ec39de8fbdb0a4f1a"
},
"changelogs": [
{
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"action": "CREATE",
"model": "TransactionRequest",
"model_id": "11ec829598f0d4008be9aba4",
"user_id": "11e95f8ec39de8fbdb0a4f1a",
"changelog_details": [
{
"id": "11e95f8ec39de8fbdb0a4f1a",
"changelog_id": "11e95f8ec39de8fbdb0a4f1a",
"field": "next_run_ts",
"old_value": "1643616000"
}
],
"user": {
"id": "11e95f8ec39de8fbdb0a4f1a",
"username": "[email protected]",
"first_name": "Bob",
"last_name": "Fairview"
}
}
],
"reason_code": {
"id": 50,
"title": "Sample Title"
}
}
}
HTTP Status Code | Error Description | Exception Class |
---|---|---|
401 | Unauthorized | Response401tokenException |