Package api

Class OnboardingFormsApi

java.lang.Object

api.OnboardingFormsApi

public class OnboardingFormsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
OnboardingFormsApi()
OnboardingFormsApi(FinixClient finixClient)

Method Summary

Modifier and Type	Method	Description
OnboardingForm	create(CreateOnboardingFormRequest createOnboardingFormRequest)	Create an Onboarding Form Create an onboarding_form with the name of the processor you plan to onboard users to and the links they get redirected to when completing or moving away from the Finix Onboarding Form.
OnboardingFormLink	createLink(String onboardingFormId, CreateOnboardingFormLinkRequest createOnboardingFormLinkRequest)	Create an Onboarding Form Link You can use the `onboarding_forms` API to create a link that can return users to where they left off completing their Finix Onboarding Form.
okhttp3.Call	createOnboardingFormAsync(CreateOnboardingFormRequest createOnboardingFormRequest, ApiCallback<OnboardingForm> _callback)	Create an Onboarding Form (asynchronously) Create an onboarding_form with the name of the processor you plan to onboard users to and the links they get redirected to when completing or moving away from the Finix Onboarding Form.
okhttp3.Call	createOnboardingFormCall(CreateOnboardingFormRequest createOnboardingFormRequest, ApiCallback _callback)	Build call for createOnboardingForm
okhttp3.Call	createOnboardingFormLinkAsync(String onboardingFormId, CreateOnboardingFormLinkRequest createOnboardingFormLinkRequest, ApiCallback<OnboardingFormLink> _callback)	Create an Onboarding Form Link (asynchronously) You can use the `onboarding_forms` API to create a link that can return users to where they left off completing their Finix Onboarding Form.
okhttp3.Call	createOnboardingFormLinkCall(String onboardingFormId, CreateOnboardingFormLinkRequest createOnboardingFormLinkRequest, ApiCallback _callback)	Build call for createOnboardingFormLink
ApiResponse<OnboardingFormLink>	createOnboardingFormLinkWithHttpInfo(String onboardingFormId, CreateOnboardingFormLinkRequest createOnboardingFormLinkRequest)	Create an Onboarding Form Link You can use the `onboarding_forms` API to create a link that can return users to where they left off completing their Finix Onboarding Form.
ApiResponse<OnboardingForm>	createOnboardingFormWithHttpInfo(CreateOnboardingFormRequest createOnboardingFormRequest)	Create an Onboarding Form Create an onboarding_form with the name of the processor you plan to onboard users to and the links they get redirected to when completing or moving away from the Finix Onboarding Form.
OnboardingForm	get(String onboardingFormId)	Fetch an Onboarding Form Retrieve the details of an `onboarding_form`.
String	getCustomBaseUrl()
FinixClient	getFinixClient()
int	getHostIndex()
okhttp3.Call	getOnboardingFormAsync(String onboardingFormId, ApiCallback<OnboardingForm> _callback)	Fetch an Onboarding Form (asynchronously) Retrieve the details of an `onboarding_form`.
okhttp3.Call	getOnboardingFormCall(String onboardingFormId, ApiCallback _callback)	Build call for getOnboardingForm
ApiResponse<OnboardingForm>	getOnboardingFormWithHttpInfo(String onboardingFormId)	Fetch an Onboarding Form Retrieve the details of an `onboarding_form`.
void	setCustomBaseUrl(String customBaseUrl)
void	setFinixClient(FinixClient finixClient)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OnboardingFormsApi

public OnboardingFormsApi()

OnboardingFormsApi

public OnboardingFormsApi(FinixClient finixClient)

Method Detail

getFinixClient

public FinixClient getFinixClient()

setFinixClient

public void setFinixClient(FinixClient finixClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createOnboardingFormCall

public okhttp3.Call createOnboardingFormCall(CreateOnboardingFormRequest createOnboardingFormRequest,
                                             ApiCallback _callback)
                                      throws ApiException

Build call for createOnboardingForm

Parameters:

createOnboardingFormRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	A single `onboarding_from` objext.	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -

create

public OnboardingForm create(CreateOnboardingFormRequest createOnboardingFormRequest)
                      throws ApiException

Create an Onboarding Form Create an onboarding_form with the name of the processor you plan to onboard users to and the links they get redirected to when completing or moving away from the Finix Onboarding Form. > Use your **ROLE_PARTNER** credentials to create an `onboarding_form`.

Parameters:

createOnboardingFormRequest - (optional)

Returns:

OnboardingForm

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	A single `onboarding_from` objext.	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -

createOnboardingFormWithHttpInfo

public ApiResponse<OnboardingForm> createOnboardingFormWithHttpInfo(CreateOnboardingFormRequest createOnboardingFormRequest)
                                                             throws ApiException

Create an Onboarding Form Create an onboarding_form with the name of the processor you plan to onboard users to and the links they get redirected to when completing or moving away from the Finix Onboarding Form. > Use your **ROLE_PARTNER** credentials to create an `onboarding_form`.

Parameters:

createOnboardingFormRequest - (optional)

Returns:

ApiResponse<OnboardingForm>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	A single `onboarding_from` objext.	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -

createOnboardingFormAsync

public okhttp3.Call createOnboardingFormAsync(CreateOnboardingFormRequest createOnboardingFormRequest,
                                              ApiCallback<OnboardingForm> _callback)
                                       throws ApiException

Create an Onboarding Form (asynchronously) Create an onboarding_form with the name of the processor you plan to onboard users to and the links they get redirected to when completing or moving away from the Finix Onboarding Form. > Use your **ROLE_PARTNER** credentials to create an `onboarding_form`.

Parameters:

createOnboardingFormRequest - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	A single `onboarding_from` objext.	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -

createOnboardingFormLinkCall

public okhttp3.Call createOnboardingFormLinkCall(String onboardingFormId,
                                                 CreateOnboardingFormLinkRequest createOnboardingFormLinkRequest,
                                                 ApiCallback _callback)
                                          throws ApiException

Build call for createOnboardingFormLink

Parameters:

onboardingFormId - The ID of the `onboarding_form` resource. (required)

createOnboardingFormLinkRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	A link for users to return to their `onboarding_form` at any time.	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -

createLink

public OnboardingFormLink createLink(String onboardingFormId,
                                     CreateOnboardingFormLinkRequest createOnboardingFormLinkRequest)
                              throws ApiException

Create an Onboarding Form Link You can use the `onboarding_forms` API to create a link that can return users to where they left off completing their Finix Onboarding Form.

Parameters:

onboardingFormId - The ID of the `onboarding_form` resource. (required)

createOnboardingFormLinkRequest - (optional)

Returns:

OnboardingFormLink

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	A link for users to return to their `onboarding_form` at any time.	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -

createOnboardingFormLinkWithHttpInfo

public ApiResponse<OnboardingFormLink> createOnboardingFormLinkWithHttpInfo(String onboardingFormId,
                                                                            CreateOnboardingFormLinkRequest createOnboardingFormLinkRequest)
                                                                     throws ApiException

Create an Onboarding Form Link You can use the `onboarding_forms` API to create a link that can return users to where they left off completing their Finix Onboarding Form.

Parameters:

onboardingFormId - The ID of the `onboarding_form` resource. (required)

createOnboardingFormLinkRequest - (optional)

Returns:

ApiResponse<OnboardingFormLink>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	A link for users to return to their `onboarding_form` at any time.	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -

createOnboardingFormLinkAsync

public okhttp3.Call createOnboardingFormLinkAsync(String onboardingFormId,
                                                  CreateOnboardingFormLinkRequest createOnboardingFormLinkRequest,
                                                  ApiCallback<OnboardingFormLink> _callback)
                                           throws ApiException

Create an Onboarding Form Link (asynchronously) You can use the `onboarding_forms` API to create a link that can return users to where they left off completing their Finix Onboarding Form.

Parameters:

onboardingFormId - The ID of the `onboarding_form` resource. (required)

createOnboardingFormLinkRequest - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	A link for users to return to their `onboarding_form` at any time.	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -

getOnboardingFormCall

public okhttp3.Call getOnboardingFormCall(String onboardingFormId,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for getOnboardingForm

Parameters:

onboardingFormId - The id of the `onboarding_form`. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	A single `onboarding_from` objext.	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -

get

public OnboardingForm get(String onboardingFormId)
                   throws ApiException

Fetch an Onboarding Form Retrieve the details of an `onboarding_form`.

Parameters:

onboardingFormId - The id of the `onboarding_form`. (required)

Returns:

OnboardingForm

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	A single `onboarding_from` objext.	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -

getOnboardingFormWithHttpInfo

public ApiResponse<OnboardingForm> getOnboardingFormWithHttpInfo(String onboardingFormId)
                                                          throws ApiException

Fetch an Onboarding Form Retrieve the details of an `onboarding_form`.

Parameters:

onboardingFormId - The id of the `onboarding_form`. (required)

Returns:

ApiResponse<OnboardingForm>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	A single `onboarding_from` objext.	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -

getOnboardingFormAsync

public okhttp3.Call getOnboardingFormAsync(String onboardingFormId,
                                           ApiCallback<OnboardingForm> _callback)
                                    throws ApiException

Fetch an Onboarding Form (asynchronously) Retrieve the details of an `onboarding_form`.

Parameters:

onboardingFormId - The id of the `onboarding_form`. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	A single `onboarding_from` objext.	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -