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

Send an approved payout to the bank

Credits the workspace's own bank account at Finix for one approved payout request. This is the verb that MOVES the money, where payouts/:id/paid only records that somebody else moved it. Reach for it once a payout has been approved; it refuses anything not in approved, and refuses a second attempt while one is still with the rail. The payout becomes paid when the rail reports the credit succeeded.

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": {
    "amountMinor": 1,
    "appliedAt": "string",
    "createdAt": "string",
    "currency": "string",
    "dealId": 1,
    "direction": "string",
    "failureCode": "string",
    "failureMessage": "string",
    "id": 1,
    "idempotencyKey": "string",
    "paymentId": 1,
    "payoutId": 1,
    "resolvedAt": "string",
    "startedBy": 1,
    "state": "string",
    "traceNumber": "string",
    "transferId": "",
    "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