Transaction Alert Controller | Clearent Developer Center

getSettings

get

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get

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

<?xml version="1.0"?>
<object>
	<code>200</code>
	<emvUrl>text</emvUrl>
	<exchange-id>ID_38839393-3938383-484848484</exchange-id>
	<gatewayUrl>text</gatewayUrl>
	<links>
		<href>/rest/v2/transactions?id=846512</href>
		<id>846512</id>
		<rel>transaction</rel>
	</links>
	<page>
		<first>false</first>
		<last>false</last>
		<number>4</number>
		<number-of-elements>102</number-of-elements>
		<size>4</size>
		<sort>
			<field>
				<ANY_ADDITIONAL_PROPERTY>text</ANY_ADDITIONAL_PROPERTY>
			</field>
		</sort>
		<total-elements>102</total-elements>
		<total-pages>4</total-pages>
	</page>
	<payload>
		<payloadType>text</payloadType>
	</payload>
	<signature>text</signature>
	<status>SUCCESS</status>
	<urls>
		<ANY_ADDITIONAL_PROPERTY>text</ANY_ADDITIONAL_PROPERTY>
	</urls>
	<vaultUrl>text</vaultUrl>
</object>

createSetting

post

Body

callbackUrlstringOptional

Url that success or failure transaction data will be POSTed to

emailsstringOptional

List of email addresses that will receive the alert

merchantIdstringOptional

Merchant id that has alert settings

terminalIdstringOptional

Terminal id that has alert settings

Responses

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

POST //rest/v2/settings/merchant/transaction-alert HTTP/1.1
Host: gateway-sb.clearent.net
Content-Type: application/xml
Accept: */*
Content-Length: 78

"<?xml version=1.0?>
<callbackUrl>text</callbackUrl>
<emails>text</emails>
<merchantId>text</merchantId>
<terminalId>text</terminalId>
"

<?xml version="1.0"?>
<object>
	<code>200</code>
	<emvUrl>text</emvUrl>
	<exchange-id>ID_38839393-3938383-484848484</exchange-id>
	<gatewayUrl>text</gatewayUrl>
	<links>
		<href>/rest/v2/transactions?id=846512</href>
		<id>846512</id>
		<rel>transaction</rel>
	</links>
	<page>
		<first>false</first>
		<last>false</last>
		<number>4</number>
		<number-of-elements>102</number-of-elements>
		<size>4</size>
		<sort>
			<field>
				<ANY_ADDITIONAL_PROPERTY>text</ANY_ADDITIONAL_PROPERTY>
			</field>
		</sort>
		<total-elements>102</total-elements>
		<total-pages>4</total-pages>
	</page>
	<payload>
		<payloadType>text</payloadType>
	</payload>
	<signature>text</signature>
	<status>SUCCESS</status>
	<urls>
		<ANY_ADDITIONAL_PROPERTY>text</ANY_ADDITIONAL_PROPERTY>
	</urls>
	<vaultUrl>text</vaultUrl>
</object>

deleteSetting

delete

Responses

200

OK

204

No Content

401

Unauthorized

403

Forbidden

delete

DELETE //rest/v2/settings/merchant/transaction-alert HTTP/1.1
Host: gateway-sb.clearent.net
Accept: */*

<?xml version="1.0"?>
<object>
	<code>200</code>
	<emvUrl>text</emvUrl>
	<exchange-id>ID_38839393-3938383-484848484</exchange-id>
	<gatewayUrl>text</gatewayUrl>
	<links>
		<href>/rest/v2/transactions?id=846512</href>
		<id>846512</id>
		<rel>transaction</rel>
	</links>
	<page>
		<first>false</first>
		<last>false</last>
		<number>4</number>
		<number-of-elements>102</number-of-elements>
		<size>4</size>
		<sort>
			<field>
				<ANY_ADDITIONAL_PROPERTY>text</ANY_ADDITIONAL_PROPERTY>
			</field>
		</sort>
		<total-elements>102</total-elements>
		<total-pages>4</total-pages>
	</page>
	<payload>
		<payloadType>text</payloadType>
	</payload>
	<signature>text</signature>
	<status>SUCCESS</status>
	<urls>
		<ANY_ADDITIONAL_PROPERTY>text</ANY_ADDITIONAL_PROPERTY>
	</urls>
	<vaultUrl>text</vaultUrl>
</object>