Skip to main content
Checks

Retrieve check information

In this tutorial, you'll learn how to use the Checks API to retrieve check information.

By the end of this tutorial, you'll know how to:

  • Create a single check search request
  • Create a check range search request
  • Create a check list search request
  • Create a check stop range search request

Before you begin

To retrieve check information, 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 single check search request

To retrieve information for a single check, send a POST request to the /checks/search endpoint and provide the account number, check number, issue date range, and status. The response will return details for the check that matches your specified criteria.

POST /checks/search
Json
{
  "debtor": {
    "accountNumber": "1234567"
  },
  "checks": {
    "checkNumbers": [
      "1005"
    ]
  },
  "issueDateLte": "2005-03-31",
  "issueDateGte": "2005-01-01",
  "limit": 1,
  "offset": 0
}

Create a check range search request

This example shows how to search for checks by a check number range, using the check search API. You can specify criteria such as an account number, a check number range, an issue date range, and status. To perform the search, send a POST request to the /checks/search endpoint.

Create check range search request
Json
{
  "debtor": {
    "accountNumber": "1234567"
  },
  "checks": {
    "checkRange": {
      "start": "1000",
      "end": "2000"
    }
  },
  "issueDateLte": "2005-03-31",
  "issueDateGte": "2005-01-01",
  "limit": 5,
  "offset": 0
}

Create a check list search request

This example demonstrates how to search for multiple checks using the check search API. Specify criteria such as an account number, a list of check numbers, issue date range, and status in your request. To perform the search, send a POST request to the /checks/search endpoint.

Create a check list search request
Json
{
  "debtor": {
    "accountNumber": "1234567"
  },
  "checks": {
    "checkNumbers": [
      "1005",
      "1068"
    ]
  },
  "issueDateLte": "2005-03-31",
  "issueDateGte": "2005-01-01",
  "limit": 5,
  "offset": 0
}

Create a check stop range search request

This example demonstrates how to search for stopped checks within a specific range of check numbers using the check search API. Specify criteria such as an account number, check number range, an issue date range, and status in your request, and send a POST request to the /checks/search endpoint to perform the search.

Example request to search for stopped checks within a specific range
Json
{
  "debtor": {
    "accountNumber": "1234567"
  },
  "checks": {
    "checkRange": {
      "start": "5000",
      "end": "10000"
    }
  },
  "postedDateLte": "2005-03-31",
  "postedDateGte": "2005-01-01",
  "status": "STOP_ON_FILE",
  "limit": 5,
  "offset": 0
}
  • For more information about check inquiry parameters, see Parameters.
  • For more information about check inquiry resources, see Resources.
  • For more information about the error codes supported by the Checks API, see Error Codes.
Is this page helpful?