Skip to main content

Get bank account onboarding link

GET 
/company/payment/bank_account_link

Generate a Stripe Account Link for the company to complete or resume the process of linking their bank account.

Objective​

Initiate or continue the Stripe Connect onboarding flow to set up the bank account that will receive transfers.

Use Cases​

  • Initiate bank account linking for the first time
  • Resume an interrupted or expired onboarding process
  • Update existing bank account details
  • Complete pending Stripe requirements

Notes​

  • Requires JWT authentication (bearerAuth)
  • Generates an account_link of type account_onboarding
  • The link expires in ~5 minutes (Stripe default)
  • Requires stripe_account to be configured in payment_settings
  • Stripe redirects to /onboarding/return upon completion and to /onboarding/refresh if it expires

Request​

Responses​

Account Link generated link

Response Headers