Stop Pay
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.
Take me to 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 | The upper bound of check number range. Only relevant when paymentType=Check |
checkNumberMinimum | integer | The 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. |
comment | string | Miscellaneous info collected at the time the stop pay is placed. Informational only. |
createdDate | datetime | The date the stop pay was created |
customerId | integer | The Helix-assigned unique ID for the customer who owns the account |
expireDate | datetime | The date the stop pay will expire |
payeeName | string | The entity the check was written to or the merchant name if ACH |
paymentType | enum | Possible values: - ACH - Check |
stopPayId | integer | The Helix-assigned unique ID for the stop pay |
stopPayType | enum | Only 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 |
Updated 24 days ago