Class GetDepositBatchSummaryResponse
Properties
| NAME | TYPE | LENGTH | DESCRIPTION | EXAMPLES |
|---|---|---|---|---|
| ResponseCode | String | Response status. For a successful response, the code will be “00”. A subset of possible response codes:
Note: There are many possible error response codes and the list will continue to grow over time. Whenever you receive a response code other than “00”, your app should have a generic screen for handling errors where you can display the End-User facing text specific to the error response code provided in the LocalizedMessageText parameter below. | <ResponseCode>00</ResponseCode> | |
| ErrorResponseText | String | If the ResponseCode value is not “00”, ErrorResponseText will be populated with the name of the response code. This is a developer/app level description and is intended to be internal facing only. | <ErrorResponseText/> | |
| LocalizedMessageText | String | If the ResponseCode value is not “00”, LocalizedMessageText will be populated with messaging associated with the specific response code. The messaging for each error response code can be customized by the Financial Institution by request. This error message is intended to be external facing within the app. | <LocalizedMessageText/> | |
| ItemCount | Integer | Number of items in batch. For this integration, this will always be “1”. | <ItemCount>1</ItemCount> | |
| OkItemCount | Integer | Number of checks in the transaction that are okay to submit within requires no further interaction with the End-User. Additional details for the check will be provided within the GetDepositItem step. | <OkItemCount>0</OkItemCount> | |
| NeedReviewItemCount | Integer | Number of checks in the batch that have Reject and/or IsConfirmable risks which require interaction with the End-User. Additional details for the check will be provided within the GetDepositItem step. | <NeedReviewItemCount>1</NeedReviewItemCount> | |
| ItemNumbers | Int[] | Since this integration is for a single check per transaction, you will be looking for a value of “1”, meaning that the single check 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 check 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. Note: The item number passed back is based on the item number that was assigned within the ItemNumber parameter in the AddDepositItem request. | <ItemNumbers> <int>1</int> </ItemNumbers> | |
| Amount | Decimal | Total batch amount, in decimal form, as submitted by the enduser. | <Amount>701.00</Amount> | |
| UserItemCount | Integer | This has been deprecated. Will return 0 | <UserItemCount>1</UserItemCount> | |
| UserAmount | Decimal | This has been deprecated. Will return 0.00 | <UserAmount>0.00</UserAmount> | |
| UserDescription | String | The description provided by the End-User (if applicable/available) as originally sent in the Description parameter from the CreateDepositBatch request. | <UserDescription>Birthday Check</UserDescription> | |
| DepositToAccountNumberIndex | Integer | The account index number for the account the End-User selected to deposit into as originally sent in the DepositToAccountNumberIndex parameter from the CreateDepositBatch request. | <DepositToAccountNumberIndex> 0 </DepositToAccountNumberIndex> |
Examples
<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>