UpdateDepositItems
- Method
- Example Request
- Example Response
UpdateDepositItems(UpdateDepositItemsRequest)
Required? Yes
Overview: UpdateDepositItems method is used when the End-User has updated the amount of an item deposit and/or retaken the check images to resolve issues presented in the original GetDepositItem step
Similar to the GetDepositItem step, the UpdateDepositItems response will return a list of risk factors (could be as few as zero, but there could be several) with a handful of parameters that you will use to determine how to handle the End-User experience that includes: completing the deposit as is, stopping the deposit from proceeding and displaying related information to the End-User, or displaying details related to the deposit that the End-User must either confirm is correct or allow them to update/fix details before completing the deposit The How to Handle the RiskFactor Object covers this in more detail.
Sequence Requirements: As mentioned above, the UpdateDepositItems request may be sent after the optional GetCheckImage step if being used or if not being used, after the GetDepositItem step when fixing an issue presented by updating the amount of an item and/or submit new check images.
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 |
|---|---|---|
| UpdateDepositItemsRequest | request |
Returns
| TYPE | DESCRIPTION |
|---|---|
| UpdateDepositItemsResponse |
<UpdateDepositItems>
<request>
<PartnerId>8257</PartnerId>
<LanguageId>9</LanguageId>
<DepositorIpAddress>203.0.113.0</DepositorIpAddress>
<DeviceIdentifier>21d182e6-10b1-48e2-8c53-1b72674836c1</DeviceIdentifier>
<LocalDateTime>2019-05-28T15:21:48.0000208-07:00</LocalDateTime>
<TimeZone>PST -7:00 America/Redwood_Shores</TimeZone>
<Attributes>
<Attribute>
<Name></Name>
<Value></Value>
</Attribute>
</Attributes>
<SessionStateId>00f4a870-6e5b-4163-86ce-b4e80acfddfb</SessionStateId>
<SessionToken>7bdb9860-dcd5-4f75-8629-61c8d18cbfed</SessionToken>
<DepositBatchId>91d8ce29-25ef-42a5-88a1-dafc9d216036</DepositBatchId>
<DepositItemCorrections>
<DepositItemCorrection>
<ItemNumber>1</ItemNumber>
<Amount>2.11</Amount>
<Micr><Micr>
<IsConfirmed>true</IsConfirmed>
<FixedRiskFactorIds></FixedRiskFactorIds>
<IsDeleted>false</IsDeleted>
<CheckImageCategory>1</CheckImageCategory>
<ImagePreprocessState>2</ImagePreprocessState>
</DepositItemCorrection>
</DepositItemCorrections>
<DepositItemStatus>-1</DepositItemStatus>
</request>
</UpdateDepositItems>
<UpdateDepositItemsResponse>
<UpdateDepositItemsResult>
<ResponseCode>00</ResponseCode>
<ErrorResponseText/>
<LocalizedMessageText/>
<UpdateItemStatusList>
<UpdateDepositItemStatus>
<ItemNumber>1</ItemNumber>
<ResponseCode>00</ResponseCode>
</UpdateDepositItemStatus>
</UpdateItemStatusList>
<DepositItems>
<DepositItem>
<ItemNumber>1</ItemNumber>
<Micr>V900024V T121143260T333222444V</Micr>
<CheckNumber>900024</CheckNumber>
<OcrAmount>701.00</OcrAmount>
<UserAmount>2.11</UserAmount>
<Amount>2.11</Amount>
<Status>0</Status>
<FundsAvailabilityText>Funds availability: Availability (2nd) of your deposited funds is based on your financial institution's hold policies. Please retain your deposited check for 60 days and then securely destroy it.</FundsAvailabilityText>
</DepositItem>
<DepositItem>
<ItemNumber>2</ItemNumber>
<Micr>V000003V T121143260T333222444V</Micr>
<CheckNumber>000003</CheckNumber>
<OcrAmount>5.55</OcrAmount>
<UserAmount>5.55</UserAmount>
<Amount>5.55</Amount>
<Status>1</Status>
<FundsAvailabilityText>Funds availability: Availability (2nd) of your deposited funds is based on your financial institution's hold policies. Please retain your deposited check for 60 days and then securely destroy it.</FundsAvailabilityText>
<RiskFactors>
<RiskFactor>
<RiskFactorId>12</RiskFactorId>
<RiskFactorDescription>Date Not Recognized By OCR</RiskFactorDescription>
<RiskFactorLocalizedDescription>The check date is between 11/28/2018 and 5/28/2019.</RiskFactorLocalizedDescription>
<Severity>1</Severity>
<IsFixable>false</IsFixable>
<IsConfirmable>true</IsConfirmable>
<DepositFields>
<int>16</int>
</DepositFields>
</RiskFactor>
<RiskFactor>
<RiskFactorId>11</RiskFactorId>
<RiskFactorDescription>Payee Does Not Match Acct Holder or Institution</RiskFactorDescription>
<RiskFactorLocalizedDescription>Payee Does Not Match Acct Holder or Institution</RiskFactorLocalizedDescription>
<Severity>1</Severity>
<IsFixable>false</IsFixable>
<IsConfirmable>true</IsConfirmable>
<DepositFields>
<int>5</int>
</DepositFields>
</RiskFactor>
</RiskFactors>
</DepositItem>
</DepositItems>
</UpdateDepositItemsResult>
</UpdateDepositItemsResponse>