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.
checkNumberMaximumintegerApplies only when paymentType=Check. The upper bound of check number range.
checkNumberMinimumintegerApplies 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.
commentstringInformational only. Miscellaneous info collected at the time the stop pay is placed.
companyIdstringApplies only when paymentType=ACH. A unique alphanumeric value to identify originators operating on the ACH network.
createdDatedatetimeThe date the stop pay was created

Format: yyyy-MM-ddT00:00:00.000+00:00
Example: 2020-07-04T00:00:00.000+00:00
customerIdintegerThe Helix-assigned unique ID for the customer who owns the account
expireDatedatetimeThe date the stop pay will expire

Format: yyyy-MM-ddT00:00:00.000+00:00
Example: 2020-07-04T00:00:00.000+00:00
payeeNamestringThe entity the check was written to or the merchant name (if ACH)
paymentTypeenumPayment type

Valid values include:
- Check
stopPayIdintegerThe Helix-assigned unique ID for the stop pay
stopPayTypeenumOnly 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