java.lang.Object
- model.CreateOnboardingFormRequestOnboardingLinkDetails

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class CreateOnboardingFormRequestOnboardingLinkDetails
extends Object

The information of the initial onboarding link. This is only provided when creating an `onboarding_form`.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class CreateOnboardingFormRequestOnboardingLinkDetails.CustomTypeAdapterFactory

Field Summary

Fields
Modifier and Type	Field	Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_EXPIRATION_IN_MINUTES`
`static String`	`SERIALIZED_NAME_EXPIRED_SESSION_URL`
`static String`	`SERIALIZED_NAME_FEE_DETAILS_URL`
`static String`	`SERIALIZED_NAME_RETURN_URL`
`static String`	`SERIALIZED_NAME_TERMS_OF_SERVICE_URL`

Constructor Summary

Constructors
Constructor Description

CreateOnboardingFormRequestOnboardingLinkDetails()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`CreateOnboardingFormRequestOnboardingLinkDetails`	`expirationInMinutes(String expirationInMinutes)`
`CreateOnboardingFormRequestOnboardingLinkDetails`	`expiredSessionUrl(String expiredSessionUrl)`
`CreateOnboardingFormRequestOnboardingLinkDetails`	`feeDetailsUrl(String feeDetailsUrl)`
`static CreateOnboardingFormRequestOnboardingLinkDetails`	`fromJson(String jsonString)`	Create an instance of CreateOnboardingFormRequestOnboardingLinkDetails given an JSON string
`String`	`getExpirationInMinutes()`	How long (in minutes) the link should be valid for.
`String`	`getExpiredSessionUrl()`	The URL users get sent to if the bearer token expires.
`String`	`getFeeDetailsUrl()`	The URL of the page where you display the fees related to processing payments (for more info, see [Displaying Processing Fees](/guides/onboarding/onboarding-form/#displaying-processing-fees)).
`String`	`getReturnUrl()`	The URL users get sent to after completing the onboarding flow.
`String`	`getTermsOfServiceUrl()`	Your Terms of Service URL.
`int`	`hashCode()`
`CreateOnboardingFormRequestOnboardingLinkDetails`	`returnUrl(String returnUrl)`
`void`	`setExpirationInMinutes(String expirationInMinutes)`
`void`	`setExpiredSessionUrl(String expiredSessionUrl)`
`void`	`setFeeDetailsUrl(String feeDetailsUrl)`
`void`	`setReturnUrl(String returnUrl)`
`void`	`setTermsOfServiceUrl(String termsOfServiceUrl)`
`CreateOnboardingFormRequestOnboardingLinkDetails`	`termsOfServiceUrl(String termsOfServiceUrl)`
`String`	`toJson()`	Convert an instance of CreateOnboardingFormRequestOnboardingLinkDetails to an JSON string
`String`	`toString()`
`static void`	`validateJsonObject(com.google.gson.JsonObject jsonObj)`	Validates the JSON Object and throws an exception if issues found

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_RETURN_URL
```
public static final String SERIALIZED_NAME_RETURN_URL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EXPIRED_SESSION_URL
```
public static final String SERIALIZED_NAME_EXPIRED_SESSION_URL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TERMS_OF_SERVICE_URL
```
public static final String SERIALIZED_NAME_TERMS_OF_SERVICE_URL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FEE_DETAILS_URL
```
public static final String SERIALIZED_NAME_FEE_DETAILS_URL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EXPIRATION_IN_MINUTES
```
public static final String SERIALIZED_NAME_EXPIRATION_IN_MINUTES
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - CreateOnboardingFormRequestOnboardingLinkDetails
```
public CreateOnboardingFormRequestOnboardingLinkDetails()
```
- Method Detail
  - returnUrl
```
public CreateOnboardingFormRequestOnboardingLinkDetails returnUrl(String returnUrl)
```
  - getReturnUrl
```
@Nullable
public String getReturnUrl()
```
    The URL users get sent to after completing the onboarding flow.
    
    Returns:
    
    returnUrl
  - setReturnUrl
```
public void setReturnUrl(String returnUrl)
```
  - expiredSessionUrl
```
public CreateOnboardingFormRequestOnboardingLinkDetails expiredSessionUrl(String expiredSessionUrl)
```
  - getExpiredSessionUrl
```
@Nullable
public String getExpiredSessionUrl()
```
    The URL users get sent to if the bearer token expires.
    
    Returns:
    
    expiredSessionUrl
  - setExpiredSessionUrl
```
public void setExpiredSessionUrl(String expiredSessionUrl)
```
  - termsOfServiceUrl
```
public CreateOnboardingFormRequestOnboardingLinkDetails termsOfServiceUrl(String termsOfServiceUrl)
```
  - getTermsOfServiceUrl
```
@Nullable
public String getTermsOfServiceUrl()
```
    Your Terms of Service URL. The URL is provided to users for consent along with [Finix's Terms of Service](https://finix-hosted-content.s3.amazonaws.com/flex/v2/finix-terms-of-service.html).
    
    Returns:
    
    termsOfServiceUrl
  - setTermsOfServiceUrl
```
public void setTermsOfServiceUrl(String termsOfServiceUrl)
```
  - feeDetailsUrl
```
public CreateOnboardingFormRequestOnboardingLinkDetails feeDetailsUrl(String feeDetailsUrl)
```
  - getFeeDetailsUrl
```
@Nullable
public String getFeeDetailsUrl()
```
    The URL of the page where you display the fees related to processing payments (for more info, see [Displaying Processing Fees](/guides/onboarding/onboarding-form/#displaying-processing-fees)).
    
    Returns:
    
    feeDetailsUrl
  - setFeeDetailsUrl
```
public void setFeeDetailsUrl(String feeDetailsUrl)
```
  - expirationInMinutes
```
public CreateOnboardingFormRequestOnboardingLinkDetails expirationInMinutes(String expirationInMinutes)
```
  - getExpirationInMinutes
```
@Nullable
public String getExpirationInMinutes()
```
    How long (in minutes) the link should be valid for. Defaults to 60 minutes.
    
    Returns:
    
    expirationInMinutes
  - setExpirationInMinutes
```
public void setExpirationInMinutes(String expirationInMinutes)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - validateJsonObject
```
public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws IOException
```
    Validates the JSON Object and throws an exception if issues found
    
    Parameters:
    
    jsonObj - JSON Object
    
    Throws:
    
    IOException - if the JSON Object is invalid with respect to CreateOnboardingFormRequestOnboardingLinkDetails
  - fromJson
```
public static CreateOnboardingFormRequestOnboardingLinkDetails fromJson(String jsonString)
                                                                 throws IOException
```
    Create an instance of CreateOnboardingFormRequestOnboardingLinkDetails given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of CreateOnboardingFormRequestOnboardingLinkDetails
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to CreateOnboardingFormRequestOnboardingLinkDetails
  - toJson
```
public String toJson()
```
    Convert an instance of CreateOnboardingFormRequestOnboardingLinkDetails to an JSON string
    
    Returns:
    
    JSON string

Class CreateOnboardingFormRequestOnboardingLinkDetails

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_RETURN_URL

SERIALIZED_NAME_EXPIRED_SESSION_URL

SERIALIZED_NAME_TERMS_OF_SERVICE_URL

SERIALIZED_NAME_FEE_DETAILS_URL

SERIALIZED_NAME_EXPIRATION_IN_MINUTES

openapiFields

openapiRequiredFields

Constructor Detail

CreateOnboardingFormRequestOnboardingLinkDetails

Method Detail

returnUrl

getReturnUrl

setReturnUrl

expiredSessionUrl

getExpiredSessionUrl

setExpiredSessionUrl

termsOfServiceUrl

getTermsOfServiceUrl

setTermsOfServiceUrl

feeDetailsUrl

getFeeDetailsUrl

setFeeDetailsUrl

expirationInMinutes

getExpirationInMinutes

setExpirationInMinutes

equals

hashCode

toString

validateJsonObject

fromJson

toJson