Checks

Parameters

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

Check stop parameters

Use all required parameters to help achieve a successful check stop request.

Required fields

Use the following table to help achieve a successful check stop request:

Conditional fields
Field	Description	Minimum	Maximum	Notes
`debtor.accountNumber`	Specifies the account number associated with the check.	2	17
`type`	Indicates whether the stop payment is for a single check or a range of checks.			Allowed values: SINGLE RANGE
`check.checkNumber`	Specifies the check number for the inquiry. Supports range filtering.	1	10
`stopReason`	Specifies the reason for stopping or revoking the check.	1	10	Use stop reason codes to categorize and track the business justification for placing or revoking stop payments. Some codes apply to specific countries, while others are available in both markets. Refer to the stop reason table for all supported values.

Optional fields

Include optional parameters from the following table in a check stop request to add additional functionality:

Optional
Field	Description	Minimum	Maximum	Notes
`debtor.financialInstitutionId.branchNumber`	Specifies the branch of the bank or financial institution.	1	99
`payees`	Specifies the payee name.	0	50	Payee name can support up to 3 payee names. Each array can contain 1 to 3 items, with each item containing 0 to 50 characters.
`payees.priority`	Specifies the priority of the payee.	1	1

Conditional fields

The following table lists the conditional parameters that are required based on specific scenarios:

Conditional fields
Field	Description	Minimum	Maximum	Notes
`checkAmount.amount`	Specifies the check amount as a decimal positive number.	1	11	Required only if `checkAmount` is selected.
`checkAmount.currency`	Specifies the ISO 4217 Alpha-3 currency code representing the currency of the check amount.			Required only if `checkAmount` is selected.
`debtor.financialInstitutionId.id`	A unique identifier for the bank or financial institution.			Example values: 021000021 CHASUS33
`debtor.financialInstitutionId.idType`	Indicates whether the stop payment is for a single check or a range of checks.			Allowed values: SINGLE RANGE

Stop reason codes and descriptions

The following table lists the stop reason codes, their descriptions, and the countries where they are supported:

Stop reason codes and descriptions
Stop Reason	Description	Supported Countries
`CHECKS_LOST`	Physical checks have been lost or misplaced.	US
`CHECKS_DAMAGED`	Physical checks have been damaged.	US
`WRONG_AMOUNT`	Incorrect amount written on the check.	US
`WRONG_PAYEE`	Incorrect payee name on the check.	US
`CHECKS_POST_DATED`	Checks with future dates.	US
`CHECKS_ALTERED`	Checks have been modified after issuance.	US
`CHECKS_FORGED`	Fraudulent or counterfeit checks.	US
`SIGNER_OR_MAKER`	Missing or incorrect signer or maker on front of the check.	US
`CHECKS_STOLEN`	Checks have been stolen.	US
`OTHER`	General category for reasons not covered above.	US
`CLIENT_INSTRUCTION`	Stop payment requested per specific client directive or instruction.	CA
`CHEQUE_LOST`	Physical cheques have been lost or misplaced.	CA
`CHEQUE_EXPIRED`	Cheques have passed their expiration date and are no longer valid.	CA
`CHEQUE_DESTROYED`	Physical cheques have been intentionally destroyed or damaged beyond use.	CA

Checks revoke parameters

Required fields

The following table lists the required parameters to help achieve a successful check revoke request:

Required fields
Field	Description	Minimum	Maximum	Notes
`operationType`	Specifies the type of stop payment revocation operation.			Use `ID` to revoke a stop using the stop ID. Use `DETAIL` to revoke a stop using stop detail.
`debtor.accountNumber`	Specifies the account number associated with the check.	2	17
`debtor.idType`	Contains debtor information.

Conditional fields

Use the following table to identify the conditional parameters required for specific scenarios:

Conditional fields
Field	Description	Minimum	Maximum	Notes
`debtor`	Contains debtor information.
`debtor.financialInstitutionId`	Unique identifier for the bank or financial institution.
`check.checkNumber`	Specifies the check number for a single check.			You must choose only one of the following search options per request: Use `check.checkNumber` to search for one specific check. Use `checkRange` to search across a range of check numbers. Use `checkNumbers` (array of strings, 1 to 5 items) to search for multiple specific checks.
`check.checkRange.start`	Specifies the starting check number in a range.			Provide either check range start and end, or neither, but not both in the same request.
`check.checkRange.end`	Specifies the ending check number in a range.			Provide either check range start and end, or neither, but not both in the same request.
`checkAmount.amount`	Specifies the check amount as a whole number or decimal positive number.	1	18	Required only if checkAmount is selected.
`checkAmount.currency`	ISO 4217 Alpha-3 currency code			Required only if checkAmount is selected.
`stopId`	Unique identifier for the stop payment request.	1	99

`type`	Indicates whether the stop payment is for a single check or a range of checks.			Supported values: SINGLE RANGE

Optional fields

Include optional parameters from the following table in a check revoke request to add additional functionality:

Optional fields
Field	Description	Minimum	Maximum	Notes
`debtor.financialInstitutionId`	Unique identifier for the bank or financial institution.
`payees`	Lists the recipient details, including payee name and payee priority.	1	3

Next Steps

Learn more about the available resources for check stop and revoke.