GetDepositBatchSummary

Method

GetDepositBatchSummary(GetDepositBatchSummaryRequest)

Required? Yes

Overview: GetDepositBatchSummary method is used to validate that the check submitted from the AddDepositItem step has been processed by Ensenta’s agile risk platform and is ready for you to proceed with the GetDepositItem step.

Since this integration is for a single check per transaction, you will be looking in the GetDepositBatchSummary response for the ItemNumbers parameter with a value of "1", meaning that the single deposit in the batch has been processed and ready for you to proceed with the GetDepositItem step. If the ItemNumbers parameter came back with a value of "0", then the deposit is still being processed and not ready for you to proceed yet; in this scenario, we recommend waiting 2-5 seconds and submitting another GetDepositBatchSummary request. You need to continue submitting the GetDepositBatchSummary request until *ItemNumbers *is passed back as a "1" before you can proceed further with the deposit.

Sequence Requirements: The GetDepositBatchSummary request may be sent after the AddDepositItem request.

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).

Parameters

TYPE	NAME	DESCRIPTION
GetDepositBatchSummaryRequest	request

Returns

TYPE	DESCRIPTION
GetDepositBatchSummaryResponse

Example Request

<GetDepositBatchSummary>
 <request>
	<PartnerId>8257</PartnerId>
	<LanguageId>9</LanguageId>
	<DepositorIpAddress>203.0.113.0</DepositorIpAddress>
	<DeviceIdentifier>21d182e6-10b1-48e2-8c53-1b72674836c1</DeviceIdentifier>
	<LocalDateTime>2018-08-08T08:45:55.000-07:00</LocalDateTime>
	<TimeZone>PST -8:00 America/Redwood_Shores</TimeZone>
	<Attributes>
	   <Attribute>
		  <Name></Name>
		  <Value></Value>
	   </Attribute>
	</Attributes>
	<SessionStateId>554196f0-02fb-438b-bd0a-9c07bed6f9f9</SessionStateId>
	<SessionToken>1337417d-db57-4c17-8f37-41c12e5933cd</SessionToken>
	<DepositBatchId>9dae3f3a-d8b0-451e-88cc-ecc33dfefe48</DepositBatchId>
 </request>
</GetDepositBatchSummary>

Example Response

<GetDepositBatchSummaryResponse>
	<GetDepositBatchSummaryResult>
		<ResponseCode>00</ResponseCode>
		<ErrorResponseText/>
		<LocalizedMessageText/>
		<ItemCount>1</ItemCount>
		<OkItemCount>0</OkItemCount>
		<NeedReviewItemCount>1</NeedReviewItemCount>
		<ItemNumbers>
			<int>1</int>
		</ItemNumbers>
		<Amount>701.00</Amount>
		<UserItemCount>1</UserItemCount>
		<UserAmount>0.00</UserAmount>
		<UserDescription>Birthday Check</UserDescription>
		<DepositToAccountNumberIndex>0</DepositToAccountNumberIndex>
	</GetDepositBatchSummaryResult>
</GetDepositBatchSummaryResponse>