Class CreateDepositBatchRequest
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> |
| DepositToAccountNumberIndex | Integer | N/A | Yes | Account Index number chosen from provided list of possible accounts as returned in StartSession. Note: Accounts are zero-indexed, so first in array is 0, second is 1, etc. | <DepositToAccountNumberIndex>0</DepositToAccountNumberIndex> |
| ItemCount | Integer | 1 | Yes | This has been deprecated. Send integer 0 | <ItemCount>0</ItemCount> |
| Amount | Decimal | 4 | Yes | This has been deprecated. Send 0.00 | <Amount>0.00</Amount> |
| Description | String | 50 | No | Optional End-User description for the deposit. This description is returned in the Description parameter from the Get AccountTransactionHistory response and can be displayed to the End-User when viewing their transaction history. Note: Emojis are not accepted. | <Description>Birthday Check</Description> |
| Scanner | Scanner[] | Yes | While these fields are used for Ensenta’s scanner products, the fields are required for the API. Send values as defined below for mobile applications. Contains the Scanner details. | <Scanner> <SerialNumber>1</SerialNumber> <Make>Mobile</Make> <Model>Mobile</Model> <ScannerTypeId>34</ScannerTypeId> </Scanner> |
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> |
Scanner
| NAME | TYPE | LENGTH | REQUIRED | DESCRIPTION | EXAMPLES |
|---|---|---|---|---|---|
| SerialNumber | String | 1 | Yes | Send integer 1 | <SerialNumber>1</SerialNumber> |
| Make | String | 6 | Yes | Send “Mobile” | <Make>Mobile</Make> |
| Model | String | 6 | Yes | Send “Mobile” | <Model>Mobile</Model> |
| ScannerTypeId | Integer | 2 | No | Send integer 34 | <ScannerTypeId>34</ScannerTypeId> |
Examples
<CreateDepositBatch>
<request>
<PartnerId>8257</PartnerId>
<LanguageId>9</LanguageId>
<DepositorIpAddress>203.0.113.0</DepositorIpAddress>
<DeviceIdentifier>21d182e6-10b1-48e2-8c53-1b72674836c1</DeviceIdentifier>
<LocalDateTime>2018-08-08T08:43:55.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>
<DepositToAccountNumberIndex>0</DepositToAccountNumberIndex>
<ItemCount>0</ItemCount>
<Amount>0.00</Amount>
<Description>Birthday Check</Description>
<Scanner>
<SerialNumber>1</SerialNumber>
<Make>Mobile</Make>
<Model>Mobile</Model>
<ScannerTypeId>34</ScannerTypeId>
</Scanner>
</request>
</CreateDepositBatch>