Cancel Disbursement

delete

https://api.branchapp.com/v2/organizations/{orgId}/workers/{workerId}/disbursements

Cancels a disbursement.

Disbursements already in CANCELED status are accepted as a no-op. Disbursements in SCHEDULED or FAILED status will be transitioned to CANCELED. Attempts to cancel a disbursement with any other status returns a 409 response. Successful cancellation returns a 204 response.

A CANCELED disbursement can be retried by calling Create Disbursement using the same (external_id, type) and retry: true.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

204

Disbursement successfully canceled.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

404Disbursement not found for the given organization and worker.

409Disbursement is not in a cancelable status. The error message will indicate whether the disbursement is already completed, already reversed, or otherwise not eligible for cancellation.