BlueForge Docs

client.wallet.startConnectOnboarding

Start Stripe Connect onboarding for a workspace

Signature

class Client {
  wallet: {
    startConnectOnboarding(workspaceId: string, input: ConnectOnboardingInput): Promise<ConnectOnboardingResult>
  }
}

Parameters

NameTypeRequiredNotes
workspaceId
string
YesWorkspace ID
input
ConnectOnboardingInput
YesOnboarding params (returnUrl, refreshUrl, country?)

Throws

  • NotFoundError
    — workspace not found

Examples

import { Client } from '@blueforge/client'

const bf = new Client({ apiKey: process.env.BF_API_KEY!, url: 'https://your-project.blueforge.dev' })

const { url, accountId } = await bf.wallet.startConnectOnboarding('ws_abc', {
  returnUrl: 'https://app.com/settings',
})

Pitfalls

  • Redirect-based — the user must complete Stripe's onboarding flow; webhook confirms readiness

See also

  • client.wallet.createRefillSession

Tested against

  • Unit: 
    packages/client/src/__tests__/wallet.test.ts