Checks

Parameters

This page provides details about the required and optional parameters for check issuance and cancelling. To ensure a successful request, you must include all the required fields. The optional fields offer additional functionality but are not necessary for initiating a successful request.

Required fields

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

Required fields
Field	Description	Minimum	Maximum	Notes
`debtor.accountNumber`	The debtor’s account number associated with the check.	2	17	Maximum length supported for different instruments and markets.
`debtor.financialInstitutionIds[].id`	The debtor's financial institution identifier.	1	11	Must be a valid 8- or 11-character BIC or ABA value.
`debtor.financialInstitutionIds[].idType`	The classification of the debtor's financial institution identifier			Allowed values are: `USABA` `BIC` `SORT_CODE` `CLEARING_SYSTEM_ID`
`checkNumbers`	A list of check numbers to be included in the search.	1	10	1 to 5 items supported.
`amount`	A string representation of a (potentially) whole number or decimal positive number.	1	18
`currency`	A 3 letter ISO 4217 code representing the currency of the check amount.	3	3
`issueDate`	The date written on the face of the check, used to determine its issue date.	10	10	Must be in ISO date format: YYYY-MM-DD

Optional fields

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

Optional fields
Field	Description	Minimum	Maximum	Notes
`branchNumber`	The branch number of the bank or financial institution.
`checkType`	The type of check as assigned by the agent. Electronic checks do not have associated images. For detailed description of each type refer to the Check types table.			Supported values: `CUSTOMER_CHECK` `CERTIFIED_CUSTOMER_CHECK` `BANK_CHECK` `DRAFT` `ELECTRONIC_DRAFT`
`payee.name`	List of payee names.	0	50	Up to 3 items allowed.
`address.addressLine`	Unstructured addresses.	1	40	Each array can contain 1 to 3 items, with each item containing 1 to 40 characters.
`city`	City as part of the address.	1	35
`postalCode`	Postal code of the address.	1	20
`countrySubDivision`	ISO 3166-2 alphanumeric country subdivision code.	1	3
`country`	ISO 3166-1 alpha-2 country code.	2	2
`clientReference`	Reference identifier provided by the client, associated with the check.	1	50
`additionalInformation`	Array containing additional unstructured fields.			`ESCHEATMENT_PRODUCT_COD`E: Escheatment product code. Only valid for issuances. Maximum length: 6 characters. `ADDITIONAL_DATA`: Additional data to be included in the issuance or cancellation request. Only valid for issuances. Maximum length: 35 characters.
`limit`	Specifies the maximum number of results to return in the response. This parameter is used for pagination and limits the number of checks included. The default value is 5. The maximum is 5 for list searches and 10 for range searches.	1	10
`offset`	Specifies the page number for pagination, using a zero-based index. The default value is set to 0. To access subsequent pages, increment by 1 for each additional page (e.g., 0 for the first page, 1 for the second, and so on). Do not change any other parameters during pagination.

Check types

The following table describes the different types of checks supported by the API, along with their definitions and applicable countries.

Check types
Check Type	Description	Supported Countries
`CUSTOMER_CHECK`	A check issued by a customer from their corporate or business account. Default for US and CA.	US CA
`CERTIFIED_CUSTOMER_CHECK`	A check guaranteed by the bank, ensuring funds are available.
`BANK_CHECK`	A check drawn directly from the bank’s funds, often used for large payments.
`DRAFT`	A check drawn against funds in a bank account, similar to a bill of exchange.
`ELECTRONIC_DRAFT`	A digital version of a draft check, processed electronically. Not supported for check issuance or cancellation requests.	US CA

Next steps

Learn more about available resources for check issuance and cancellation.