Skip to content

Withdraw from the fund to the community bank​

POST
/communities/{id}/fund/withdrawals

Owner only, signed-in session. A payout from the community's Stripe account to its bank, with a reason (at most 120 characters) and the emailed code. Blocked while a dispute is open or the balance is negative. Audit-logged; publishes community.fund_withdrawn after commit.

Authorizations​

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)

Parameters​

Path Parameters

id*

The community's uuid or slug.

Type
string
Required

Request Body​

application/json
JSON
{
"amount_cents": 0,
"reason": "string",
"code": "string",
"additionalProperties": "string"
}

Responses​

OK

application/json
JSON
{
"data": {
"withdrawal_id": "string",
"entry_id": "string",
"payout_id": "string",
"amount_cents": 0,
"arrival_date": "string",
"available_cents_after": 0,
"additionalProperties": "string"
},
"additionalProperties": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress