DisbursementsDisbursements

Stop payment for a disbursement

Stop payment for a disbursement. This only applies for disbursements that are submitted as check transfers. If the disbursement is not in a submitted state, this will return a 412 Precondition Failed error.

Path parameters

idstringRequired

The unique identifier for the disbursement

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
reasonenumRequired

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:

Errors