request
abstract suspend fun requestOnlineOnboardingURL(userInfo: OnboardingUserInfo?, successRedirect: String, failureRedirect: String, abortRedirect: String): String
Function to provide user information details and obtain an URL to the 3rd party provider for importing the user's bank account.
Return
A URL string to the third-party provider for bank account import.
Parameters
user
the user information required for retrieving the bank verification url. If the user information was provided previously, this field can be null.
success
URI to redirect to on successful onboarding.
failure
URI to redirect to on onboarding failure.
abort
URI to redirect to if the 3rd party bank account import flow is aborted.
Throws
if the startOnlineOnboarding was not called
if the onboarding process was started more than 7 days ago, but was not finished yet
if URL cannot be generated.
if user info cannot be validated. The error provides the field that failed the validation process.