Skip to content

Release a creator's held funds

POST
/admin/users/{id}/release-held-funds

Releases all of one creator's settled held funds to their connected account. The operator MUST assert expectedAmountCents; the backend computes the settled-held SUM and refuses to move money (returning the per-fundraiser breakdown with HTTP 409) if the two disagree. Only donations whose stripe_available_on <= NOW() are eligible. Requires manage_system_settings. Audit logged on success only.

Authorizations

BearerAuth

Authentication is handled automatically via httpOnly session cookies after signing in at /cognito/signin or via Google SSO at /cognito/oauth/google. For Swagger UI testing, paste a JWT token from the /cognito/signin response.

Type
HTTP (bearer)

Parameters

Path Parameters

id*

Target creator user id.

Type
string
Required
Format
"uuid"

Request Body

application/json
JSON
{
"expectedAmountCents": 0
}

Responses

Release result

application/json
JSON
{
"data": {
"totalTransferredCents": 0,
"totalFailedCents": 0,
"fundraisersTouched": 0,
"donationTransfers": [
{
"donationId": "string",
"fundraiserId": "string",
"amountCents": 0,
"stripeTransferId": "string",
"status": "string",
"error": "string"
}
]
}
}

Playground

Server
Authorization
Variables
Key
Value
Body

Samples

Powered by VitePress OpenAPI

Built with VitePress