Class GetAccountTransactionHistoryRequest
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> |
| NumberOfDays | Integer | N/A | Yes | Send integer 0 Note: Ensenta can configure the maximum number of days for history to return up to a max of 180 days. Typically, the Financial Institution defines the max number of days desired. | <NumberOfDays>0</NumberOfDays> |
| MaxNumberOfTransactions | Integer | N/A | Yes | The number of transactions desired as part of the response. Ensenta recommends a max of 50 transactions for optimal mobile performance. History is also capped at a max of 180 days, configured on the server during the implementation process. Note: While not recommended, “0” will include all transactions within the number of days configured on the server. | <MaxNumberOfTransactions>50</MaxNumberOfTransactions> |
| ViewType | Integer | N/A | Yes | Send integer 0 | <ViewType>0</ViewType> |
| RequestType | Integer | N/A | Yes | Send integer 1 | <RequestType>1</RequestType> |
| CheckImageViewType | Integer | N/A | Yes | Send integer -1 | <CheckImageViewType>-1</CheckImageViewType> |
| CheckImageType | Integer | N/A | Yes | Send integer -1 | <CheckImageType>-1</CheckImageType> |
| ReceiptNumber | Integer | N/A | No | Leave empty | <ReceiptNumber></ReceiptNumber> |
| StatusList | Int[] | Yes | Filters the transaction history response based on the status of the deposit. Send all the following values in this array:
| <StatusList> <int>0</int> <int>1</int> <int>2</int> <int>3</int> </StatusList> |
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
<GetAccountTransactionHistory>
<request>
<PartnerId>8257</PartnerId>
<LanguageId>9</LanguageId>
<DepositorIpAddress>203.0.113.0</DepositorIpAddress>
<DeviceIdentifier>21d182e6-10b1-48e2-8c53-1b72674836c1</DeviceIdentifier>
<LocalDateTime>2018-08-08T08:46:00.0000880-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>
<NumberOfDays>0</NumberOfDays>
<MaxNumberOfTransactions>50</MaxNumberOfTransactions>
<ViewType>0</ViewType>
<RequestType>1</RequestType>
<CheckImageViewType>-1</CheckImageViewType>
<CheckImageType>-1</CheckImageType>
<StatusList>
<int>0</int>
<int>1</int>
<int>2</int>
<int>3</int>
</StatusList>
</request>
</GetAccountTransactionHistory>