GetCheckImage
- Method
- Example Request
- Example Response
GetCheckImage(GetCheckImageRequest)
Required? No
Overview: GetCheckImage method is optional and is used to display a preview of converted check image to the End-User before submitting the deposit. This method is typically used for stateless apps where they are unable to display the original images taken by the End-User but may also just be the preferred option on a stateful app as well. Alternatively, some vendors will present a generic success image like a green checkmark; see User Interface Examples for examples of the check image preview.
The check images retrieved from Ensenta via this method will not be the original images, but instead the binarized (black and white) image as stored on the Ensenta side.
Sequence Requirements: The GetCheckImage request may be sent after the GetDepositItem step.
Do not send fields as Null. All fields must be passed with a value or empty. Use basicHttpBinding, and don’t use message security, but only transport level security (SSL).
Parameters
| TYPE | NAME | DESCRIPTION |
|---|---|---|
| GetCheckImageRequest | request |
Returns
| TYPE | DESCRIPTION |
|---|---|
| GetCheckImageResponse |
<GetCheckImage>
<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:57.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>
<ItemNumber>1</ItemNumber>
<CheckImageViewType>2</CheckImageViewType>
<CheckImageType>2</CheckImageType>
</request>
</GetCheckImage>
<GetCheckImageResponse>
<GetCheckImageResult>
<ResponseCode>00</ResponseCode>
<ErrorResponseText/>
<LocalizedMessageText/>
<CheckImages>
<CheckImageInfo>
<CheckImage> <!-- Base64 Image --> </CheckImage>
<CheckImageViewType>0</CheckImageViewType>
</CheckImageInfo>
<CheckImageInfo>
<CheckImage> <!-- Base64 Image --> </CheckImage>
<CheckImageViewType>1</CheckImageViewType>
</CheckImageInfo>
</CheckImages>
</GetCheckImageResult>
</GetCheckImageResponse>