Stop payment for a disbursement
Stop payment for a disbursement sent via check.
This prevents the recipient from depositing the check. If the check has already been deposited, the stop payment request will fail.
**Requirements:**
- Disbursement must be in `submitted` status
- Disbursement must be sent via check
- Check must not have already been deposited
After successfully stopping payment, the disbursement status will be updated to `stopped`.
Path parameters
id
The unique identifier for the disbursement
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
reason
The reason for stopping a disbursement payment.
Possible values include:
- `mail_delivery_failure`: The check could not be delivered.
- `not_authorized`: The check was not authorized.
- `voided`: The check was stopped and voided.
- `unknown`: The reason for stopping the disbursement payment is unknown.
Allowed values:
