About GetCheckImageData
This request provides a URL to download the image of the check that was sent to the vendor once the payment is disbursed. The check images are only displayed when the check clears.
Example
Request
<API_URL_EndPoint>/GetCheckImageData.json
data={
"sentPayId" : "stp01CLOIKTVMBNc6hjr"
}
Response
{
"response_status" : 0,
"response_message" : "Success",
"response_data" : {
"checkImageData" : [ {
"url" : "/is/CheckImageServlet?id=cki01OCVBAUAUPRxi6re"
}, {
"url" : "/is/CheckImageServlet?id=cki01AKAZRRZPRAxi6rh"
} ]
}
}
In order to download the images, you need to include the sessionId to the CheckImageServlet.
Resources
Parameters
Field Name | Description | Required? |
---|---|---|
sentPayId | The system generated ID of the payment that was made using a check. | Yes |