Class GetAccountTransactionCheckImageRequest
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:22:49.0000184-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> |
| TransactionId | Integer | 36 | Yes | This is the value passed in the TransactionId parameter from the GetAccountTransactionHistory response for the transaction the End-User would like to view the images. | <TransactionId> 7cb0b832-a05d-4ba4-8590-a2e65dffbf6e </TransactionId> |
| CheckImageType | Integer | N/A | Yes | The requested format of the image. The only supported format is png. Send integer 2 | <CheckImageType>2</CheckImageType> |
| CheckImageViewType | Integer | N/A | Yes | The requested side of the check to be returned in the response. Values supported include:
| <CheckImageViewType>2</CheckImageViewType> |
| ReceiptNumber | Integer | 12 | Yes | This is the value passed in the ReceiptNumber parameter from the GetAccountTransactionHistory response for the transaction the End-User would like to view the images. | <ReceiptNumber>91482843</ReceiptNumber> |
| ItemNumber | Integer | N/A | Yes | This is the value passed in the ItemNumber parameter from the GetAccountTransactionHistory response for the item within the transaction the End-User would like to view the images. If only supporting history from deposits made within this integration for mobile where there is only ever a single check per transaction, Send integer 1. If supporting shared history where deposits may have been made through a product supporting multiple checks within a transaction, you will need to send the value in the ItemNumber parameter from the GetAccountTransactionHistory response for the specific check in the transaction the End-User would like to view the images. | <ItemNumber>1</ItemNumber> |
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
<GetAccountTransactionCheckImage>
<request>
<PartnerId>8257</PartnerId>
<LanguageId>9</LanguageId>
<DepositorIpAddress>203.0.113.0</DepositorIpAddress>
<DeviceIdentifier>21d182e6-10b1-48e2-8c53-1b72674836c1</DeviceIdentifier>
<LocalDateTime>2019-05-28T15:22:49.0000184-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>
<TransactionId>7cb0b832-a05d-4ba4-8590-a2e65dffbf6e</TransactionId>
<CheckImageType>2</CheckImageType>
<CheckImageViewType>2</CheckImageViewType>
<ReceiptNumber>91482843</ReceiptNumber>
<ItemNumber>1</ItemNumber>
</request>
</GetAccountTransactionCheckImage>