Class AddDepositItemRequest
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> 2019-05-28T15:21:29.0000452-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 -7: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> 00f4a870-6e5b-4163-86ce-b4e80acfddfb </SessionStateId> |
| SessionToken | String | 36 | Yes | The session token from the SessionToken parameter returned in the StartSession response. | <SessionToken> 7bdb9860-dcd5-4f75-8629-61c8d18cbfed </SessionToken> |
| DepositBatchId | String | 36 | Yes | The deposit batch id from the DepositBatchId parameter returned in the CreateDepositBatch response. | <DepositBatchId> 91d8ce29-25ef-42a5-88a1-dafc9d216036 </DepositBatchId> |
| ItemNumber | Integer | N/A | Yes | Item number representing the check. For the first item, send integer 1, for the second item send integer 2, etc. Each item added to the batch must have an incremented ItemNumber. Unique user ID generated by EPS. (See - UpdateDepositItems) does not actually remove it from the back-end but merely marks it as deleted, so any additional items still need to have an incremented ItemNumber. If you include item number in the UI, pay extra attention to the item number displayed to the End-User versus the item number used on the back-end. In general we do not recommend displaying item number within the UI due to the additional complexity. | <ItemNumber>1</ItemNumber> |
| IsFirstItem | Boolean | N/A | Yes | Send 'true' for first item, 'false' for all other items. | <IsFirstItem>true</IsFirstItem> |
| TenderType | Integer | 1 | Yes | Send integer 1 | <TenderType>1</TenderType> |
| Micr | String | 80 | No | Leave empty | <Micr> </Micr> |
| Amount | Decimal | 19 | Yes | User-entered amount of the check in decimal form. | <Amount>20.11</Amount> |
| 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 | Yes | This is the Base64 string of front image. Refer to the Mitek image guidelines document for details on formatting check images. | <FrontBase64Image> <!-- Base64 Image --> </FrontBase64Image> |
| BackBase64Image | String | N/A | Yes | This is the Base64 string of back image. Refer to the Mitek image guidelines document for details on formatting check images. | <BackBase64Image> <!-- Base64 Image --> </BackBase64Image> |
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> |
Examples
<AddDepositItem>
<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:29.0000452-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>
<ItemNumber>1</ItemNumber>
<IsFirstItem>true</IsFirstItem>
<Micr></Micr>
<TenderType>1</TenderType>
<Amount>20.11</Amount>
<CheckImageCategory>1</CheckImageCategory>
<ImagePreprocessState>2</ImagePreprocessState>
<FrontBase64Image> <!-- Base64 Image --> </FrontBase64Image>
<BackBase64Image> <!-- Base64 Image --> </BackBase64Image>
</request>
</AddDepositItem>