CancelDepositBatch

Method

CancelDepositBatch(CancelDepositBatchRequest)

Required? Yes

Overview: CancelDepositBatch is the method used to cancel a deposit

Sequence Requirements: The CancelDepositBatch request may be sent after the CreateDepositBatch step but must be prior to the PostDepositBatch. For more details on the methods that are used in between the batch being created and the deposited being completed, please review the supported sequences as listed in Supported Sequences.

note

Do not send fields as Null. All fields must be passed with a value or empty. Use basicHttpBinding, and don’t use message security, but only transport level security (SSL).

If the mobile application includes a Cancel option within the UI, the mobile application should call CancelDepositBatch. This will update the Ensenta database with an accurate status of the deposit. (Otherwise, Ensenta will consider it an abandoned deposit.)

Parameters

TYPE	NAME	DESCRIPTION
CancelDepositBatchRequest	request

Returns

TYPE	DESCRIPTION
CancelDepositBatchResponse

Example Request

<CancelDepositBatch>
 <request>
	<PartnerId>8257</PartnerId>
	<LanguageId>9</LanguageId>
	<DepositorIpAddress>203.0.113.0</DepositorIpAddress>
	<DeviceIdentifier>21d182e6-10b1-48e2-8c53-1b72674836c1</DeviceIdentifier>
	<LocalDateTime>2018-08-08T10:52:47.000-07:00</LocalDateTime>
	<TimeZone>PST -8:00 America/Redwood_Shores</TimeZone>
	<Attributes>
	   <Attribute>
		  <Name></Name>
		  <Value></Value>
	   </Attribute>
	</Attributes>
	<SessionStateId>994be4fb-3dc5-4ceb-b13b-dccfd4c9768c</SessionStateId>
	<SessionToken>52269818-4f3e-410c-87ad-1f5922f0b4d6</SessionToken>
	<DepositBatchId>9cecc694-1268-4e06-a651-b97f2ed56b9c</DepositBatchId>
 </request>
</CancelDepositBatch>

Example Response

<CancelDepositBatchResponse>
	<CancelDepositBatchResult>
		<ResponseCode>00</ResponseCode>
		<ErrorResponseText/>
		<LocalizedMessageText/>
	</CancelDepositBatchResult>
</CancelDepositBatchResponse>