PostDepositBatch

Method

PostDepositBatch(PostDepositBatchRequest)

Required? Yes

Overview: PostDepositBatch method is used to complete a deposit.

If the Financial Institution is posting deposits in real time, this is also the step we will attempt to post the transaction; a failure in posting will result in an error in the PostDepositBatch response depending on the method of posting used by the Financial Institution.

As described in GetSessionInfo, if your app allowed the End-User to proceed with the deposit with an amount that exceeds their limits, you will receive an error in the PostDepositBatch response.

Sequence Requirements: The PostDepositBatch request may be sent in a couple different scenarios:

1. Either after the optional GetCheckImage step or GetDepositItem step if no issues were presented in the GetDepositItem step (see Happy Day and GetDepositItem)

2. Either after the optional GetCheckImage step or UpdateDepositItems step if no issues were presented in the UpdateDepositItems step (see IsConfirmable and UpdateDepositItems)

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
PostDepositBatchRequest	request

Returns

TYPE	DESCRIPTION
PostDepositBatchResponse

Example Request

<PostDepositBatch>
 <request>
	<PartnerId>8257</PartnerId>
	<LanguageId>9</LanguageId>
	<DepositorIpAddress>203.0.113.0</DepositorIpAddress>
	<DeviceIdentifier>21d182e6-10b1-48e2-8c53-1b72674836c1</DeviceIdentifier>
	<LocalDateTime>2018-08-08T08:46:00.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>
	<ItemNumbers>
	   <int>1</int>
	</ItemNumbers>
 </request>
</PostDepositBatch>

Example Response

<PostDepositBatchResponse>
	<PostDepositBatchResult>
		<ResponseCode>00</ResponseCode>
		<ErrorResponseText/>
		<LocalizedMessageText/>
		<TransactionSummary>
			<TransactionId>9f189395-620d-4c08-9e3e-b37f39b85f0c</TransactionId>
			<TransactionDate>2018-08-08T08:46:00.53</TransactionDate>
			<Description>Birthday Check</Description>
			<ReceiptNumber>82202037</ReceiptNumber>
			<SubmittedAmount>2.11</SubmittedAmount>
			<AdjustmentAmount>0.00</AdjustmentAmount>
			<CurrentAmount>2.11</CurrentAmount>
			<NumberofChecks>1</NumberofChecks>
			<Status>Submitted</Status>
			<AccountNumber>x3456</AccountNumber>
			<AccountHolderNumber/>
			<TransactionType>Deposit</TransactionType>
			<AcceptedByDescription>Test FI</AcceptedByDescription>
			<ChannelType>7</ChannelType>
			<ChannelTypeDescription>Mobile</ChannelTypeDescription>
			<StatusId>0</StatusId>
			<StatusDescription>Submitted</StatusDescription>
			<StatusChangeDate>2018-08-08T08:46:00.53</StatusChangeDate>
			<Username/>
			<DepositItems>
				<DepositHistoryItem>
					<ItemNumber>1</ItemNumber>
					<CheckNumber>900024</CheckNumber>
					<AdjustmentAmount>0.00</AdjustmentAmount>
					<SubmittedAmount>2.11</SubmittedAmount>
					<CurrentAmount>2.11</CurrentAmount>
					<StatusDescription>Submitted</StatusDescription>
					<Check21ReturnReasonDescription>Not Applicable / Other</Check21ReturnReasonDescription>
					<StatusId>0</StatusId>
				</DepositHistoryItem>
			</DepositItems>
			<RedeemedDtTm xsi:nil="true"/>
			<PayerAccountNumber/>
			<TransactionTypeId>0</TransactionTypeId>
		</TransactionSummary>
	</PostDepositBatchResult>
</PostDepositBatchResponse>