Sign in

v31

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-215985245.8 KB
disbursements

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.

post/v1/disbursements/{id}/stop

Path parameters

idstring required

The unique identifier for the disbursement

Request body

reason'mail_delivery_failure' | 'not_authorized' | 'voided' | 'unknown' required

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.

Example request

{
  "reason": "mail_delivery_failure"
}

Response

The stop payment request was accepted