Skip to content

Payouts

View .mdllms.txt

The seller’s payout setup with Stripe. Generated from the OpenAPI spec. Each endpoint says which key it needs; see Authentication.

Method Path What it does
GET /v1/me/payouts How far the seller’s payout setup has come
POST /v1/me/payouts/session Start or continue the seller’s payout setup

How far the seller’s payout setup has come

Section titled “How far the seller’s payout setup has come”

GET /v1/me/payouts · operation getMyPayouts

Auth: your secret key (Authorization: Bearer sk_…) and the user’s session (X-User-Session: …), from your server

Responses: 200 PayoutSetupBody · default a problem

Start or continue the seller’s payout setup

Section titled “Start or continue the seller’s payout setup”

POST /v1/me/payouts/session · operation startMyPayoutSetup

Returns a client secret for Stripe’s embedded onboarding component (account-onboarding). Configure it with collectionOptions {fields: ‘currently_due’, futureRequirements: ‘omit’} to ask only for what’s required now. Ask the seller first whether they sell as a private person or a company; the form then asks only that kind’s questions.

Auth: your secret key (Authorization: Bearer sk_…) and the user’s session (X-User-Session: …), from your server

Body (application/json): StartMyPayoutSetupRequest

Responses: 200 StartMyPayoutSetupResponse · default a problem

Fields marked * are always present in responses and required in requests.

Field Type Notes
due string[] What Stripe still needs, when action is required
status * string one of none, action_required, pending, ready
Field Type Notes
business_type string Private person (default) or company; used the first time. one of individual, company
country * string Where the seller lives (ISO 3166, e.g. SE); used the first time
Field Type Notes
client_secret * string