POST/v1/accounting/payouts/{id}/paid

Mark a payout paid

Records that the money for an approved payout actually left, stamping the moment and, optionally, the bank line it went out on. The admin seat. Body: bankTransactionId, optional. This states a fact about money that has already moved — sending it is not this service's job, so there is no disbursement here. There is no failed state on a request either: a settlement that failed leaves the request owed, so cancel it or leave it in the queue.

Access class: workspace:admin.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

idpath · stringrequired

Request body

application/jsonrequired

bodyoptional

paramsoptional

queryobjectoptional

Responses

201application/json

the action's answer

{
  "data": {
    "availableAtRequestMinor": 1,
    "bankTransactionId": 1,
    "createdAt": "string",
    "currency": "string",
    "dealId": 1,
    "decidedAt": "string",
    "decidedBy": "string",
    "decisionReason": "string",
    "detail": {},
    "id": 1,
    "notes": "string",
    "paidAt": "string",
    "requestedAmountMinor": 1,
    "requestedAt": "string",
    "requestedBy": "string",
    "splitId": 1,
    "status": "string",
    "updatedAt": "string"
  }
}

dataoptional

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired