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

200

Message Response

application/json

Schema

Schema

message stringrequired

Example (from schema)

{
  "message": "string"
}

response

{
  "message": "Disbursement started"
}

400

Bad Request

Response Headers

application/json

Schema

Schema

error string
extras object
status number
message string

Example (from schema)

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

response

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

401

Unauthorized

Response Headers

application/json

Schema

Schema

error string
extras object
status number
message string

Example (from schema)

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

response

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

403

Forbidden

Response Headers

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Forbidden"
}

response

{
  "error": "Forbidden"
}

404

Not Found

Response Headers

application/json

Schema

Schema

error string
extras object
status number
message string

Example (from schema)

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

response

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

Loading...