HPP Settings | Clearent Developer Center

Get HPP Settings

get

Header parameters

api-keyanyRequired

apiKeyValue

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get

GET //rest/v2/settings/terminal/hpp 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>

Create HPP Settings

post

Header parameters

api-keyanyRequired

apiKeyValue

Body

enabledbooleanOptional

Key is enabled or disabled

Example: true

hpp-domainstringOptional

must match the domain of the page the pay button will be used on

Example: https://example.com

hpp-public-keystringOptional

public key used for client side storage

Responses

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

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

"<?xml version=1.0?>
<enabled>true</enabled>
<hpp-domain>https://example.com</hpp-domain>
<hpp-public-key>text</hpp-public-key>
"

<?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 HPP Settings

put

Header parameters

api-keyanyRequired

apiKeyValue

Body

enabledbooleanOptional

Key is enabled or disabled

Example: true

hpp-domainstringOptional

must match the domain of the page the pay button will be used on

Example: https://example.com

hpp-public-keystringOptional

public key used for client side storage

Responses

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

put

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

"<?xml version=1.0?>
<enabled>true</enabled>
<hpp-domain>https://example.com</hpp-domain>
<hpp-public-key>text</hpp-public-key>
"

<?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>

Delete HPP Settings

delete

Header parameters

api-keyanyRequired

apiKeyValue

Responses

200

OK

204

No Content

401

Unauthorized

403

Forbidden

delete

DELETE //rest/v2/settings/terminal/hpp 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>