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.

Path Parameters

• id string required

  ID of the disbursement

Responses

• 200
• 400
• 401
• 403
• 404

---

Message Response

application/json

• Schema
• Example (from schema)
• response

---

Schema

• message string required

{
  "message": "string"
}

{
  "message": "Disbursement started"
}

Bad Request

Response Headers

application/json

• Schema
• Example (from schema)
• response

---

Schema

• error string
• extras object

  status number

  message string

{
  "error": "Bad request",
  "extras": {
    "status": 400,
    "message": "Disbursement is not ready to be started"
  }
}

{
  "error": "Bad request",
  "extras": {
    "status": 400,
    "message": "Disbursement is not ready to be started"
  }
}

Unauthorized

Response Headers

application/json

• Schema
• Example (from schema)
• response

---

Schema

• error string
• extras object

  status number

  message string

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

Forbidden

Response Headers

application/json

• Schema
• Example (from schema)
• response

---

Schema

• error string

{
  "error": "Forbidden"
}

{
  "error": "Forbidden"
}

Not Found

Response Headers

application/json

• Schema
• Example (from schema)
• response

---

Schema

• error string
• extras object

  status number

  message string

{
  "error": "Not found",
  "extras": {
    "status": 404,
    "message": "Disbursement not found"
  }
}

{
  "error": "Not found",
  "extras": {
    "status": 404,
    "message": "Disbursement not found"
  }
}

Loading...