Class UpdateDepositItemsRequest
Properties
| NAME | TYPE | LENGTH | REQUIRED | DESCRIPTION | EXAMPLES |
|---|---|---|---|---|---|
| PartnerId | Integer | 9 | Yes | The Partner ID is a unique ID assigned by Ensenta specific to each setup within Ensenta’s platform and will be different for each environment (UAT and Production). For more details, review the PartnerId parameter in Start Session request. | <PartnerId>8257</PartnerId> |
| LanguageId | Integer | 1 | Yes | Send integer 9 | <LanguageId>9</LanguageId> |
| DepositorIpAddress | String | 45 | Yes | IP address of End-User (NOT calling web service). IPv4 or IPv6 are accepted. This is optionally used to enable Geolocation functionality. Reach out to your Ensenta PM if there are any questions regarding Geolocation. | <DepositorIpAddress> 203.0.113.0 </DepositorIpAddress> |
| DeviceIdentifier | String | N/A | Yes | The unique UUID generated for the phone. | <DeviceIdentifier> 21d182e6-10b1-48e2-8c53-1b72674836c1 </DeviceIdentifier> |
| LocalDateTime | String | N/A | Yes | Date and time where the device End-User is. For example:
Note: You must include the colon in the offset | <LocalDateTime> 2018-08-08T10:52:47.000-07:00 </LocalDateTime> |
| TimeZone | String | N/A | Yes | Time zone of End-User. Required Format: Timezone{space}UTC offset{space} Area/Location Example: PDT -07:00 America/Los_Angeles Differentiate Day light savings, for ex, send PST (Pacific Standard Time) or PDT (Pacific Daylight Time). Note: Area/Location is optional. | <TimeZone> PST -8:00 America/Redwood_Shores </TimeZone> |
| Attributes | Attribute[] | Yes | An array containing attributes for utilizing miscellaneous optional functionality that may be added to over time. Attributes are defined Name/Value pairs. This is to support potential future functionality to easily expand on your integration. There is no functionality available for this parameter at this time; pass the Name and Value parameters below as empty. Note: You may have heard Ensenta make references to Attributes in the past; there is another type of Attributes named Account Holder Attributes which does have functionality available and is described below within the StartSession request. For more details, look at the AccountHolderAttributes parameter in StartSession request. | <Attributes> <Attribute> <Name></Name> <Value></Value> </Attribute> </Attributes> | |
| SessionStateId | String | 36 | Yes | The session state id from the SessionStateID parameter returned in the StartSession response. | <SessionStateId> 994be4fb-3dc5-4ceb-b13b-dccfd4c9768c </SessionStateId> |
| SessionToken | String | 36 | Yes | The session token from the SessionToken parameter returned in the StartSession response. | <SessionToken> 52269818-4f3e-410c-87ad-1f5922f0b4d6 </SessionToken> |
| DepositBatchId | String | 36 | Yes | The deposit batch id from the DepositBatchId parameter returned in the CreateDepositBatch response. | <DepositBatchId> 9dae3f3a-d8b0-451e-88cc-ecc33dfefe48 </DepositBatchId> |
| DepositItemCorrections | DepositItemCorrection[] | Yes | Contains the DepositItemCorrections details. Contains the DepositItemCorrection details. | <DepositItemCorrections> <DepositItemCorrection> ... </DepositItemCorrection> </DepositItemCorrections> | |
| DepositItemStatus | Integer | 2 | Yes | Send integer -1 | <DepositItemStatus>-1</DepositItemStatus> |
Attribute
| NAME | TYPE | LENGTH | REQUIRED | DESCRIPTION | EXAMPLES |
|---|---|---|---|---|---|
| Name | String | N/A | Yes | Not applicable, leave empty. | <Name></Name> |
| Value | String | N/A | Yes | Not applicable, leave empty. | <Value></Value> |
DepositItemCorrection
| NAME | TYPE | LENGTH | REQUIRED | DESCRIPTION | EXAMPLES |
|---|---|---|---|---|---|
| ItemNumber | Integer | 2 | Yes | Send integer 1 | <ItemNumber>1</ItemNumber> |
| Amount | Decimal | 19 | Yes | If the End-User updated the check amount, provide in decimal form. If the End-User did not update the check amount, send the original amount submitted within the Amount parameter from the AddDepositItem request. | <Amount>2.11</Amount> |
| Micr | String | 80 | No | Leave empty | <Micr></Micr> |
| IsConfirmed | Boolean | N/A | No | This has been deprecated. Send boolean value of 'false' | <IsConfirmed>true</IsConfirmed> |
| FixedRiskFactorIds | Int[] | N/A | No | Leave empty | <FixedRiskFactorIds></FixedRiskFactorIds> |
| IsDeleted | Boolean | N/A | No | Send “False” | <IsDeleted>false</IsDeleted> |
| CheckImageCategory | Integer | N/A | Yes | Send integer 1 | <CheckImageCategory>1</CheckImageCategory> |
| ImagePreprocessState | Integer | N/A | Yes | Send integer 2 | <ImagePreprocessState>2</ImagePreprocessState> |
| FrontBase64Image | String | N/A | No | If the End-User retook the check images, this is the Base64 string of front image. Leave blank if the End-User did not retake the check images. Note: If sending an image, both the front and back images should be sent, even if just replacing one. Refer to the Mitek image guidelines document for details on formatting check images. | <FrontBase64Image> <!— Base64 Image --> </FrontBase64Image> |
| BackBase64Image | String | N/A | No | If the End-User retook the check images, this is the Base64 string of back image. Leave blank if the End-User did not retake the check images. Note: If sending an image, both the front and back images should be sent, even if just replacing one. Refer to the Mitek image guidelines document for details on formatting check images. | <BackBase64Image> <!— Base64 Image --> </BackBase64Image> |
Examples
<UpdateDepositItems>
<request>
<PartnerId>8257</PartnerId>
<LanguageId>9</LanguageId>
<DepositorIpAddress>203.0.113.0</DepositorIpAddress>
<DeviceIdentifier>21d182e6-10b1-48e2-8c53-1b72674836c1</DeviceIdentifier>
<LocalDateTime>2018-08-08T08:45:58.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>
<DepositItemCorrections>
<DepositItemCorrection>
<ItemNumber>1</ItemNumber>
<Amount>2.11</Amount>
<Micr></Micr>
<IsConfirmed>true</IsConfirmed>
<IsDeleted>false</IsDeleted>
<CheckImageCategory>1</CheckImageCategory>
<ImagePreprocessState>2</ImagePreprocessState>
<FrontBase64Image></FrontBase64Image>
<BackBase64Image></BackBase64Image>
</DepositItemCorrection>
</DepositItemCorrections>
<DepositItemStatus>-1</DepositItemStatus>
</request>
</UpdateDepositItems>