STstellar
Disbursements

Update a Disbursement 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.

patch/disbursements/{id}/status

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header Authorization

Path parameters

idstring required

ID of the disbursement

Response

Message Response

messagestring required

Changes

No recorded changes to this operation across all 13 revisions of this API.