post_finance_payout_accounts_by_orgid_resume_payouts

Changes data · you confirm first

Calls POST /api/finance/payout-accounts/{orgId}/resume-payouts as the signed-in person · REST reference

Resume a service provider's payouts after a clawback closed without all of its cash (platform staff)

Records who resumed, when and why on every PARTIALLY_RECOVERED or WRITTEN_OFF clawback of the organization that still pauses its payouts. A clawback still APPROVED or EXECUTING keeps them paused, and stillPaused says so. When nothing pauses them any more, the clinic is emailed.

Arguments

ArgumentTypeDescription
orgIdpathstring (uuid)required
bodyJSONobjectrequiredThe request body, as a JSON object. Its fields are listed below.

Fields of body

FieldTypeDescription
reasonstringrequired

Example call

A client sends this over the MCP session; Claude and other agents build it for you. The values are placeholders — the shape is real.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "post_finance_payout_accounts_by_orgid_resume_payouts",
    "arguments": {
      "orgId": "11111111-1111-4111-8111-111111111111",
      "body": {
        "reason": "string"
      }
    }
  }
}
Confirmation
The client shows the person the exact request and waits. Nothing runs until they tick Make this change. See Reading and changing.

Result

On success (HTTP 200) the tool returns one text item holding the API's JSON, pretty-printed.

What the resume did

json
{
  "orgId": "11111111-1111-4111-8111-111111111111",
  "resumedCount": 1,
  "stillPaused": true
}

Fields

FieldTypeDescription
orgIdstring (uuid)
resumedCountintegerClawbacks the resume was recorded on.
stillPausedbooleanTrue when an APPROVED or EXECUTING clawback still pauses the payouts.

When it fails

A failed call returns isError: true with the API's message as text. A change the person declines, or lets time out, also comes back this way and nothing changes.

400

The request was malformed or failed a guard.

403

Authenticated, but the caller holds none of the required permissions.

404

No such organization. Carries the DAL's sentence.

What the model is shown

This is the tool exactly as the server lists it in tools/list. The description starts with the REST call it makes.

json
{
  "name": "post_finance_payout_accounts_by_orgid_resume_payouts",
  "description": "POST /api/finance/payout-accounts/{orgId}/resume-payouts — Records who resumed, when and why on every PARTIALLY_RECOVERED or WRITTEN_OFF clawback of the organization that still pauses its payouts. A clawback still APPROVED or EXECUTING keeps them paused, and `stillPaused` says so. When nothing pauses them any more, the clinic is emailed.\n\nThis changes data. The person is asked to confirm it before it runs, and nothing happens if they decline.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "orgId": {
        "type": "string"
      },
      "body": {
        "type": "string",
        "description": "The JSON request body: { reason*: string }"
      }
    },
    "required": [
      "orgId",
      "body"
    ]
  },
  "annotations": {
    "readOnlyHint": false,
    "destructiveHint": true,
    "idempotentHint": false,
    "openWorldHint": false
  }
}