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
submittedstatus - 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.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
id
The unique identifier for the disbursement
Request
The request body for stopping a disbursement payment
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:
Response
The stop payment request was accepted
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
412
Precondition Failed Error
500
Internal Server Error