Skip to content

Fund settings​

PATCH
/communities/{id}/fund

Owner only. On: the account pays out manually and the money collects; off: weekly payouts. Visibility changes are audit-logged (no event) and hide past activity too. accept_debit_terms: true records the Account Debit consent.

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
{
"enabled": true,
"visibility": "string",
"accept_gifts": true,
"accept_debit_terms": true
}

Responses​

OK

application/json
JSON
{
"data": {
"community_id": "string",
"enabled": true,
"visibility": "string",
"accept_gifts": true,
"viewer": {
"can_see": true,
"can_move_money": true,
"is_leader": true,
"can_give": true,
"additionalProperties": "string"
},
"balance": {
"available_cents": 0,
"pending_cents": 0,
"pending_available_on": "string",
"spendable_cents": 0,
"open_disputes_cents": 0,
"additionalProperties": "string"
},
"totals": {
"raised_cents": 0,
"dues_cents": 0,
"gifts_cents": 0,
"given_cents": 0,
"withdrawn_cents": 0,
"since": "string",
"additionalProperties": "string"
},
"given_to": [
{
"fundraiser_id": "string",
"slug": "string",
"title": "string",
"organizer_name": "string",
"image_url": "string",
"raised_cents": 0,
"from_fund_cents": 0,
"additionalProperties": "string"
}
],
"entries": [
{
"id": "string",
"kind": "string",
"amount_cents": 0,
"gross_cents": 0,
"created_at": "string",
"available_on": "string",
"fundraiser": {
"id": "string",
"slug": "string",
"title": "string",
"organizer_name": "string"
},
"to_leader_fundly": true,
"donor_name": "string",
"anonymous": true,
"note": "string",
"reason": "string",
"actor_name": "string",
"member_count": 0,
"period": "string",
"additionalProperties": "string"
}
],
"entries_total": 0,
"payout_account": {
"bank_name": "string",
"last4": "string"
},
"open_dispute": true,
"negative_balance": true,
"hold": {
"limit_days": 0,
"next_auto_payout_on": "string",
"next_auto_payout_cents": 0
},
"additionalProperties": "string"
},
"additionalProperties": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress