Class UpdateDepositItemsResponse
Properties
| NAME | TYPE | 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/> |
| UpdateItemStatusList | UpdateDepositItemStatus[] | Contains the UpdateItemStatusList details. Contains the UpdateDepositItemStatus details. | <UpdateItemStatusList> <UpdateDepositItemStatus> <ItemNumber>1</ItemNumber> <ResponseCode>00</ResponseCode> </UpdateDepositItemStatus> </UpdateItemStatusList> |
| DepositItems | DepositItem[] | Contains the DepositItems details. Contains the DepositItem details. | <DepositItems> <DepositItem> ... </DepositItem> </DepositItems> |
UpdateDepositItemStatus
| NAME | TYPE | DESCRIPTION | EXAMPLES |
|---|---|---|---|
| ItemNumber | Integer | The number of the item within the batch as sent in the ItemNumber parameter in the original AddDepositItem Request | <ItemNumber>1</ItemNumber> |
| ResponseCode | String | Response status. For a successful response, the code will be '00'. A subset of possible response codes:
| <ResponseCode>00</ResponseCode> |
| ErrorResponseText | String | This will not be returned if the *ResponseCode *above for this item was '00'. 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. Note: While the *ResponseCode *for the UpdateDepositItems response may be '00', the *ResponseCode *for the *UpdateDepositStatusItem *object could return something else meaning there is an issue with the specific item that was being updated. | <ErrorResponseText> Timeout Logout </ErrorResponseText> |
| LocalizedMessageText | String | This will not be returned if the *ResponseCode *above for this item was '00'. 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. Important! In this rare scenario, the error may be unrecoverable. The mobile application should start over and re-submit the check by calling GetSessionInfo, CreateDepositBatch, and AddDepositItem. Note: While the *ResponseCode *for the UpdateDepositItems response may be '00', the *ResponseCode *for the *UpdateDepositStatusItem *object could return something else meaning there is an issue with the specific item that was being updated. | <LocalizedMessageText> You have timed out. </LocalizedMessageText> |
RiskFactors
| NAME | TYPE | DESCRIPTION | EXAMPLES |
|---|---|---|---|
| RiskFactorId | Integer | The ID number representing the specific risk factor. This is intended to be internal facing only. | <RiskFactorId>12</RiskFactorId> |
| RiskFactorDescription | String | This is a developer/app level description of the risk factor and is intended to be internal facing only. | <RiskFactorDescription> Date Not Recognized By OCR </RiskFactorDescription> |
| RiskFactorLocalizedDescription | String | The messaging for each risk factor can be customized by the Financial Institution by request. This message is intended to be external facing within the app; typically displayed in an unordered list. | <RiskFactorLocalizedDescription> The check date is between 11/28/2018 and 5/28/2019. </RiskFactorLocalizedDescription> |
| Severity | Integer | Severity of the risk factor. Possible values:
| <Severity>1</Severity> |
| IsFixable | Boolean | This has been deprecated. Should always return 'false' but ignore if either true or false. | <IsFixable>false</IsFixable> |
| IsConfirmable | Boolean | If 'true', this condition indicates that there is something on the check that we would like the End-User to either confirm/validate is present and correct on the check or to be allowed to go back and fix either the amount or re-take the images after fixing something on the check (example being back endorsement). | <IsConfirmable>true</IsConfirmable> |
| DepositFields | Int[] | Value indicating the element of the check that the risk factor is associated with/triggered by. This is typically internal facing only but is sometimes used for targeting messaging within the app. Depending on the risk factor that was triggered, one or multiple deposit fields will be provided in the array.
| <DepositFields> <int>16</int> </DepositFields> |
DepositItem
| NAME | TYPE | DESCRIPTION | EXAMPLES |
|---|---|---|---|
| ItemNumber | Integer | The number of the item within the batch as sent in the ItemNumber parameter in the original AddDepositItem request. | <ItemNumber>2</ItemNumber> |
| Micr | String | The MICR of the check as read by Ensenta's OCR system. Important! For this integration, if the End-User updates the amount or retakes the check images, you will need to return this value as-is in the Micr parameter within the UpdateDepositItems request. | <Micr> V000003V T121143260T333222444V </Micr> |
| CheckNumber | String | The check number of the check as read by Ensenta's OCR system. Note: This value may be empty if OCR failed to read the check number or if the check did not have a check number in the MICR. | <CheckNumber>000003</CheckNumber> |
| OcrAmount | Decimal | The amount of the check as read by Ensenta's OCR system. Note: This value will be '0.00' if OCR failed to read amount. | <OcrAmount>5.55</OcrAmount> |
| UserAmount | Decimal | Amount of the check as submitted by the End-User. For more details, see UpdateDepositItems request. | <UserAmount>5.55</UserAmount> |
| Amount | Decimal | This is the current amount of the check. This will be the same as the UserAmount value from above. | <Amount>5.55</Amount> |
| Status | Integer | Status of item. Possible Values:
| <Status>1</Status> |
| FundsAvailabilityText | String | End-User facing text with Financial Institution's (FI) funds availability messaging; typically displayed at the end of the transaction prior to the End-User completing. This message is customizable by the FI and has a max character length of 275 characters (not including 'Funds availability:'). | <FundsAvailabilityText> Funds availability: Availability of your deposited funds is based on your Financial Institutions hold policies. Please retain your deposited check for 60 days and then securely destroy it. </FundsAvailabilityText> |
| RiskFactors | RiskFactor[] | Contains an array of _RiskFactors _(if any are returned) with details for each. Note: If there are no applicable risk factors, this array will not be returned. Contains the RiskFactor details. | <RiskFactors> <RiskFactor> ... </RiskFactor> </RiskFactors> |
Examples
<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>