Skip to main content

Update a Disbursement Status

PATCH 

/disbursements/:id/status

Updates the status of a disbursement according to the state machine. The disbursement must move from draft to ready in order to start the disbursement and trigger payments. Payments will start as soon as this endpoint is hit. A disbursement can also be moved into paused state by an SDP user to prevent further payments from going out and restarted when they are ready.

Request

Path Parameters

    id stringrequired

    ID of the disbursement

Responses

Message Response

Schema

    message stringrequired
Loading...