A Stop Pay 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.


stopPay Object

PropertyData Type (length)Description
accountIdintegerThe Helix-assigned unique ID for the account to which this stop pay is associated
amountMaximumdecimalThe upper bound of payment amount range
amountMinimumdecimalThe lower bound of payment amount range.

Note: This can be the same value as amountMaximum if trying to block a specific payment amount.
checkNumberMaximumintegerThe upper bound of check number range. Only relevant when paymentType=Check
checkNumberMinimumintegerThe lower bound of check number range. Only relevant when paymentType=Check

Note: This can be the same value as checkNumberMaximum if trying to block a single check number.
commentstringMiscellaneous info collected at the time the stop pay is placed. Informational only.
createdDatedatetimeThe date the stop pay was created
customerIdintegerThe Helix-assigned unique ID for the customer who owns the account
expireDatedatetimeThe date the stop pay will expire
payeeNamestringThe entity the check was written to or the merchant name if ACH
paymentTypeenumPossible values:
- ACH
- Check
stopPayIdintegerThe Helix-assigned unique ID for the stop pay
stopPayTypeenumOnly relevant when paymentType=ACH.
Possible values:
- OneTime: The stop pay will expire after a matching payment is blocked
- Permanent: The stop pay will continue to block matching payments until expireDate