A stop payment is a request to prevent a check or an ACH withdrawal from posting to an account. Reasons include stolen/lost checkbook, a merchant that won't stop debiting an account despite cancelled service, etc.

View the Stop Pay Endpoint Reference →

stopPay Object

Property	Data Type (length)	Description
`accountId`	integer	The Helix-assigned unique ID for the account to which this stop pay is associated
`amountMaximum`	decimal	The upper bound of payment amount range
`amountMinimum`	decimal	The lower bound of payment amount range. Note: This can be the same value as `amountMaximum` if trying to block a specific payment amount.
`checkNumberMaximum`	integer	Applies only when `paymentType=Check`. The upper bound of check number range.
`checkNumberMinimum`	integer	Applies only when `paymentType=Check`. The lower bound of check number range. Note: This can be the same value as `checkNumberMaximum` if trying to block a single check number.
`comment`	string	Informational only. Miscellaneous info collected at the time the stop pay is placed.
`companyId`	string	Applies only when `paymentType=ACH`. A unique alphanumeric value to identify originators operating on the ACH network.
`createdDate`	datetime	The date the stop pay was created Format: yyyy-MM-ddT00:00:00.000+00:00 Example: `2020-07-04T00:00:00.000+00:00`
`customerId`	integer	The Helix-assigned unique ID for the customer who owns the account
`expireDate`	datetime	The date the stop pay will expire Format: yyyy-MM-ddT00:00:00.000+00:00 Example: `2020-07-04T00:00:00.000+00:00`
`payeeName`	string	The entity the check was written to or the merchant name (if ACH)
`paymentType`	enum	Payment type Valid values include: `ACH` `Check`
`stopPayId`	integer	The Helix-assigned unique ID for the stop pay
`stopPayType`	enum	Only relevant when `paymentType=ACH`. Valid values include: `OneTime`: The stop pay will expire after a matching payment is blocked `Permanent`: The stop pay will continue to block matching payments until `expireDate`