Checks
Retrieve check images
In this tutorial, you'll learn how to use the Checks API to retrieve check images.
By the end of this tutorial, you'll know how to:
- Create a request to retrieve a single check image.
- Create a request to search for check images within a date or number range.
- Create a request to retrieve a list of check images from the search request.
Before you begin
To retrieve a check image, you need the following:
- A registered and fully onboarded Developer Account on the J.P. Morgan Payments Developer Portal.
- An active project that provides you with the credentials used to make a request.
Create a request to retrieve a single check image
Send a POST request with the account number, check number, and issue date to retrieve a single check image.
POST /checks/image/search
Json
{
"debtor": {
"accountNumber": "1234567"
},
"checks": {
"checkNumbers": [
"1005"
]
},
"issueDateLte": "2005-03-31",
"issueDateGte": "2005-01-01",
"imageFormat": "TIFF",
"limit": 1,
"offset": 0
}Create a request to search for check images within a date or number range
Send a POST request with the account number, a list of check numbers, and an issue date range to retrieve multiple check images.
POST /checks/images/search
Json
{
"debtor": {
"accountNumber": "1234567"
},
"checks": {
"checkRange": {
"start": "1000",
"end": "2000"
}
},
"issueDateLte": "2005-03-31",
"issueDateGte": "2005-01-01",
"imageFormat": "TIFF",
"limit": 5,
"offset": 0
}Create a request to retrieve a list of check images from the search request
Send a POST request with the account number, a list of check numbers, and an issue date range to retrieve multiple check images.
POST /checks/images/search
Json
{
"debtor": {
"accountNumber": "1234567"
},
"checks": {
"checkNumbers": [
"1005",
"1068"
]
},
"issueDateLte": "2005-03-31",
"issueDateGte": "2005-01-01",
"imageFormat": "TIFF",
"limit": 5,
"offset": 0
}Related
- For more information about check image parameters, see Parameters.
- For more information about the error codes supported by the Checks API, see Error Codes.
- Review available resources for check imaging.