Terminal Settings

Terminal Settings

Get Terminal Settings

get

Header parameters

api-keyanyRequired

apiKeyValue

Responses

200

OK

application/xmlapplication/json

401

Unauthorized

403

Forbidden

404

Not Found

get

/rest/v2/settings/terminal

HTTPcURLJavaScriptPython

GET /rest/v2/settings/terminal HTTP/1.1
Host: gateway-sb.clearent.net/
Accept: */*

<?xml version="1.0"?>
<object>
	<payloadType>text</payloadType>
	<terminal-settings>
		<batch-time-utc>09:30</batch-time-utc>
		<business-phone>text</business-phone>
		<commerce-type>ECOMMERCE</commerce-type>
		<enable-auto-close-batch>true</enable-auto-close-batch>
		<enable-tip>true</enable-tip>
		<merchant-id>000000843334</merchant-id>
		<merchant-name>Test Merchant</merchant-name>
		<service-fee>text</service-fee>
		<service-fee-program-type>text</service-fee-program-type>
		<service-fee-state>text</service-fee-state>
		<service-fee-type>text</service-fee-type>
		<terminal-id>10018001</terminal-id>
		<terminal-name>Waterloo location 1</terminal-name>
		<time-zone>Central/US</time-zone>
	</terminal-settings>
</object>

Update Terminal Settings

put

Header parameters

api-keyanyRequired

apiKeyValue

Body

application/xmlapplication/json

batch-time-utcstringOptional

Time you want your terminal to be autobatched. Must be in 5 min increments, 0 or 5.

Example: 09:30

business-phonestringOptional

commerce-typestringOptional

Commerce type of terminal; RETAIL or ECOMMERCE.

Example: ECOMMERCE

enable-auto-close-batchbooleanOptional

Is autobatch enabled/disabled on the terminal

Example: true

enable-tipbooleanOptional

Is tip enabled/disabled on the terminal

Example: true

merchant-idstringOptional

Merchant ID, display only cannot edit. Must be edited from Compass

Example: 000000843334

merchant-namestringOptional

Merchant name, display only cannot edit. Must be edited from Compass

Example: Test Merchant

service-feestringOptional

service-fee-program-typestringOptional

service-fee-statestringOptional

service-fee-typestringOptional

terminal-idstringOptional

Terminal Identication number, not editable must be set in Compass

Example: 10018001

terminal-namestringOptional

friendly name of the terminal

Example: Waterloo location 1

time-zonestringOptional

timezone you want your terminal to display in. API will always return UTC

Example: Central/US

Responses

200

OK

application/xmlapplication/json

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

put

/rest/v2/settings/terminal

HTTPcURLJavaScriptPython

PUT /rest/v2/settings/terminal HTTP/1.1
Host: gateway-sb.clearent.net/
Content-Type: application/xml
Accept: */*
Content-Length: 384

"<?xml version=1.0?>
<batch-time-utc>09:30</batch-time-utc>
<business-phone>text</business-phone>
<commerce-type>ECOMMERCE</commerce-type>
<enable-auto-close-batch>true</enable-auto-close-batch>
<enable-tip>true</enable-tip>
<merchant-id>000000843334</merchant-id>
<merchant-name>Test Merchant</merchant-name>
<service-fee>text</service-fee>
<service-fee-program-type>text</service-fee-program-type>
<service-fee-state>text</service-fee-state>
<service-fee-type>text</service-fee-type>
<terminal-id>10018001</terminal-id>
<terminal-name>Waterloo location 1</terminal-name>
<time-zone>Central/US</time-zone>
"

application/xmlapplication/json

<?xml version="1.0"?>
<object>
	<payloadType>text</payloadType>
	<terminal-settings>
		<batch-time-utc>09:30</batch-time-utc>
		<business-phone>text</business-phone>
		<commerce-type>ECOMMERCE</commerce-type>
		<enable-auto-close-batch>true</enable-auto-close-batch>
		<enable-tip>true</enable-tip>
		<merchant-id>000000843334</merchant-id>
		<merchant-name>Test Merchant</merchant-name>
		<service-fee>text</service-fee>
		<service-fee-program-type>text</service-fee-program-type>
		<service-fee-state>text</service-fee-state>
		<service-fee-type>text</service-fee-type>
		<terminal-id>10018001</terminal-id>
		<terminal-name>Waterloo location 1</terminal-name>
		<time-zone>Central/US</time-zone>
	</terminal-settings>
</object>