# JPMC-PDP Documentation from https://developer.payments.jpmorgan.com

# Parameters

This page lists the required and optional parameters for check inquiry. Include all required parameters to help achieve a successful request. Optional fields offer additional functionality but are not required to initiate a request.

## Required fields

The following table includes the required parameters to initiate a successful request:

 
**Required fields**

| Field | Description | Minimum | Maximum | Notes | 
| --- | --- | --- | --- | --- | 
| accountNumber | Account number associated with the check. |  | 17 |  | 
| financialInstitution.id | Bank or institution ID. | 1 | 11 | For example: - ABA - BIC | 
| idType | The bank or institution ID type. |  |  | Allowed values: - USABA - BIC - SORT_CODE - CLEARING_SYSTEM_ID | 
| checkRange.start | Represents a greater-or-equal match to support range style filtering on check number. | 1 | 10 |  | 
| checkRange.end | Represents a lesser-or-equal match to support range style filtering on check number. | 1 | 10 |  | 
| checkNumbers | Allows for an array of check numbers to be utilized for a search. | 1 | 10 |  | 

## Optional fields

The following table includes optional parameters that can be used to customize the request:

 
**Optional**

| Field | Description | Minimum | Maximum | Notes | 
| --- | --- | --- | --- | --- | 
| branchNumber | Branch of the bank or financial institution. |  |  |  | 
| checkSeqNumber | A unique identifier for a specific check. Only numeric values are allowed. |  |  |  | 
| issueDateGte | Filters for checks with an issue date greater than or equal to the specified date. | 10 | 10 | - Defaults to searching the past 90 days if not specified. - The date must be within one year of the issueDateLte value. - Format: ISO-8601 | 
| issueDateLte | Filters for checks with an issue date less than or equal to the specified date. | 10 | 10 | - The date must be within one year of the issueDateGte value. - Format: ISO-8601 | 
| postedDateGte | Represents a greater-or-equal match to support range style filtering on posted date. | 10 | 10 | - The date must be within one year of the postedDateLte value. - Format: ISO-8601 | 
| postedDateLte | Filters for checks with a posted date less than or equal to the specified date. | 10 | 10 | - The date must be within one year of the postedDateGte value. - Format: ISO-8601 | 
| amountLte | Filters for checks with an amount less than or equal to the specified value. | 1 | 18 |  | 
| amountGte | Filters for checks with an amount greater than or equal to the specified value. | 1 | 18 |  | 
| status | Filters checks based on their status. - CANCELLED - OUTSTANDING - STOP_ON_FILE - DEBIT - PAID_RETURNED_CHECK - TELLER_CASHED - CASHIER_CHECK_OR_BANK_DRAFT_PRESENTED - ALL For details, refer to the [check types](/docs/treasury/checks/capabilities/check-inquiry/payment-parameters#check-types) tables. |  |  | ALL returns checks with all statuses except: - TELLER_CASHED - CASHIER_CHECK_OR_BANK_DRAFT_PRESENTED - ALL When using DEBIT as a filter, the checks with the following status is returned: - DEBIT - STOP_ON_FILE - PAID_RETURNED_CHECK | 
| payee.name | Filters checks by payee name. | 0 | 50 | Supports 1 to 3 payee names. | 
| priority | Filters checks based on the payee priority. | 1 | 1 |  | 
| clientReference | The client provided reference identifier associated with the check. | 1 | 50 |  | 
| limit | Sets the maximum number of results to return. Used for pagination. | 1 | 10 | Default: 5 | 
| offset | Page number for pagination. Zero-based. Use 0 for the first page and increment by 1 for subsequent pages. Do not change other parameters during pagination. |  |  | Default: 0 | 

## Check types

The following table lists the possible check statuses, along with their descriptions and supported countries.

 
**Check types**

| Status | Description | Supported countries | 
| --- | --- | --- | 
| CANCELLED | The check is cancelled before being sent out. | - US - CA | 
| PRESENTED | The check is presented for processing. |  | 
| DROPPED | The check print request is cancelled or a stale check is refunded. |  | 
| OUTSTANDING | The check is issued but not yet debited. | - US - CA | 
| PAID | The funds have been cleared and have been debited from the payor's account. | - US - CA | 
| REJECTED | The check is rejected and not processed. | - US - CA | 
| RETURNED | The paid check is returned. | - US - CA | 
| REQUESTED | The check is requested for printing. | - US - CA | 
| STALE | The check reaches its expiration date before being presented. |  | 
| STOP_ON_FILE | A stop is placed on the check, preventing it from being cashed. | - US - CA | 
| TELLER_CASHED | The check is cashed at a bank teller. | - US - CA | 
| CASHIER_CHECK_OR_BANK_DRAFT_PRESENTED | A cashier’s check or bank draft is presented, identified by a client-assigned identifier. | - US - CA | 

## Next steps

Review available [resources](/docs/treasury/checks/capabilities/check-inquiry/resources) for check inquiry.