Skip to content

Give from the fund to a Fundly​

POST
/communities/{id}/fund/allocations

Owner only, signed-in session. A Stripe Account Debit moves the money from the community account to the platform, then a donation from " fund" (no tip, no card fee, never anonymous, no receipt) lands on the Fundly and pays out through its normal path. Refused for a Fundly the owner organizes, co-organizes or benefits from; labelled when it is a leader's. Send an Idempotency-Key header (or idempotency_key): the same key returns the first result; with a different body, 409 IDEMPOTENCY_CONFLICT. Publishes community.fund_allocated 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​

Header Parameters

Idempotency-Key
Type
string
Max Length
200

Path Parameters

id*

The community's uuid or slug.

Type
string
Required

Request Body​

application/json
JSON
{
"fundraiser_id": "string",
"amount_cents": 0,
"note": "string",
"idempotency_key": "string",
"additionalProperties": "string"
}

Responses​

OK

application/json
JSON
{
"data": {
"allocation_id": "string",
"entry_id": "string",
"donation_id": "string",
"amount_cents": 0,
"available_cents_after": 0,
"to_leader_fundly": true,
"additionalProperties": "string"
},
"additionalProperties": "string"
}

Playground​

Server
Authorization
Headers
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress