Skip to content

Transfer available organization funds to its bank​

POST
/org-admin/{slug}/funds/payouts

Creates a bank payout from the organization's own connected account and writes its payout ledger mapping. Reusing requestId retains the fixed amount and Stripe idempotency key. Requests must be fresh and within the available bank balance; held processing funds are not transferable. Impersonation is rejected. Requires organization permission org.manage_payouts.

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

slug*

Organization slug; middleware resolves and authorizes this organization before any read or write.

Type
string
Required

Request Body​

application/json
JSON
{
"amountCents": 0,
"currency": "string",
"requestId": "string",
"requestedAt": 0
}

Responses​

Successful organization-scoped response

application/json
JSON
{
"data": {
"id": "string",
"amountCents": 0,
"currency": "string",
"status": "string"
}
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress