Skip to main content

GetDepositBatchSummary

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.

For the first AddDepositItem in each new batch, a successful 00 response indicates that all back-end processing has been completed for the first item. For subsequent AddDepositItem requests within the same batch, a successful 00 response indicates the request was successful but not that back-end processing for that item has been completed.

For each subsequent AddDepositItem requests, a GetDepositBatchSummary request needs to be made to see if the *ItemCount *from the response matches with your expected total number of items submitted.

  • If the ItemCount matches your expetected total number of items, then you know that all items have been successful completed the back-end processing.
  • If ItemCount does not match your expected total number of items, you need to make another GetDepositBatchSummary call until they do. You may need to to call GetDepositBatchSummary a couple times before the ItemCount returns the expected number of items; we recommend waiting 2-5 seconds and submitting another GetDepositBatchSummary request.

The mobile application can handle GetDepositBatchSummary in the background while the End-User is going through the MiSnap check capture process. The purpose of this is to allow the End-User to continuously add items to the batch without having to wait for back-end processing to be complete for each item.

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

TYPENAMEDESCRIPTION
GetDepositBatchSummaryRequestrequest

Returns

TYPEDESCRIPTION
GetDepositBatchSummaryResponse