Skip to content

Start or resume Stripe Connect onboarding​

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

Creates the organization's Stripe Express account (business type company) if it has none, or reuses the existing one, and returns a fresh single-use onboarding link. Safe to call repeatedly — each call returns a new link. If the stored account no longer exists on Stripe a new one is created in its place.

The organization must have verification_status: verified, and the features.org_level_stripe_connect flag must be on (503 otherwise).

Requires permission: org.manage_payouts (organization owners only)

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*

The organization's slug (not its UUID).

Type
string
Required
Example"local-food-bank-a1b2c3"
Pattern
"^[a-z0-9][a-z0-9-]{0,254}$"

Responses​

Onboarding link created

application/json
JSON
{
"data": {
"accountId": "acct_1Nv0FGQ9RKHgCVdK",
"onboardingUrl": "string",
"status": "string"
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress