Get Stripe Connect status

GET

/org-admin/{slug}/payouts/status

Whether the organization can take charges and receive payouts. Reads the account live from Stripe and refreshes the stored flags. If Stripe cannot be reached, the last stored flags are returned instead and the Stripe-only fields (defaultCurrency, country, businessType, requirementsCurrentlyDue) are absent. With no account yet the body is { "data": { "connected": false } }.

Requires permission: org.read_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*

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

Connect status

Content-Type

application/json

{

"data": "string"

}

GET

/org-admin/{slug}/payouts/status

Playground

Server

Authorization

BearerAuth

Variables

Key

Value

slug*

Samples

Powered by VitePress OpenAPI