java.lang.Object
- com.adyen.model.marketpayhop.GetOnboardingUrlRequest

public class GetOnboardingUrlRequest
extends Object

GetOnboardingUrlRequest

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_ACCOUNT_HOLDER_CODE`
`static String`	`JSON_PROPERTY_COLLECT_INFORMATION`
`static String`	`JSON_PROPERTY_EDIT_MODE`
`static String`	`JSON_PROPERTY_MOBILE_O_AUTH_CALLBACK_URL`
`static String`	`JSON_PROPERTY_PLATFORM_NAME`
`static String`	`JSON_PROPERTY_RETURN_URL`
`static String`	`JSON_PROPERTY_SHOPPER_LOCALE`
`static String`	`JSON_PROPERTY_SHOW_PAGES`

Constructor Summary

Constructors
Constructor Description

GetOnboardingUrlRequest()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`GetOnboardingUrlRequest`	`accountHolderCode(String accountHolderCode)`
`GetOnboardingUrlRequest`	`collectInformation(CollectInformation collectInformation)`
`GetOnboardingUrlRequest`	`editMode(Boolean editMode)`
`boolean`	`equals(Object o)`	Return true if this GetOnboardingUrlRequest object is equal to o.
`static GetOnboardingUrlRequest`	`fromJson(String jsonString)`	Create an instance of GetOnboardingUrlRequest given an JSON string
`String`	`getAccountHolderCode()`	The account holder code you provided when you created the account holder.
`CollectInformation`	`getCollectInformation()`	Get collectInformation
`Boolean`	`getEditMode()`	Indicates if editing checks is allowed even if all the checks have passed.
`String`	`getMobileOAuthCallbackUrl()`	The URL to which the account holder is redirected after completing an OAuth authentication with a bank through Trustly/PayMyBank.
`String`	`getPlatformName()`	The platform name which will show up in the welcome page.
`String`	`getReturnUrl()`	The URL where the account holder will be redirected back to after they complete the onboarding, or if their session times out.
`String`	`getShopperLocale()`	The language to be used in the page, specified by a combination of a language and country code.
`ShowPages`	`getShowPages()`	Get showPages
`int`	`hashCode()`
`GetOnboardingUrlRequest`	`mobileOAuthCallbackUrl(String mobileOAuthCallbackUrl)`
`GetOnboardingUrlRequest`	`platformName(String platformName)`
`GetOnboardingUrlRequest`	`returnUrl(String returnUrl)`
`void`	`setAccountHolderCode(String accountHolderCode)`
`void`	`setCollectInformation(CollectInformation collectInformation)`
`void`	`setEditMode(Boolean editMode)`
`void`	`setMobileOAuthCallbackUrl(String mobileOAuthCallbackUrl)`
`void`	`setPlatformName(String platformName)`
`void`	`setReturnUrl(String returnUrl)`
`void`	`setShopperLocale(String shopperLocale)`
`void`	`setShowPages(ShowPages showPages)`
`GetOnboardingUrlRequest`	`shopperLocale(String shopperLocale)`
`GetOnboardingUrlRequest`	`showPages(ShowPages showPages)`
`String`	`toJson()`	Convert an instance of GetOnboardingUrlRequest to an JSON string
`String`	`toString()`

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

- Field Detail
  - JSON_PROPERTY_ACCOUNT_HOLDER_CODE
```
public static final String JSON_PROPERTY_ACCOUNT_HOLDER_CODE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_COLLECT_INFORMATION
```
public static final String JSON_PROPERTY_COLLECT_INFORMATION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_EDIT_MODE
```
public static final String JSON_PROPERTY_EDIT_MODE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MOBILE_O_AUTH_CALLBACK_URL
```
public static final String JSON_PROPERTY_MOBILE_O_AUTH_CALLBACK_URL
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PLATFORM_NAME
```
public static final String JSON_PROPERTY_PLATFORM_NAME
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_RETURN_URL
```
public static final String JSON_PROPERTY_RETURN_URL
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_LOCALE
```
public static final String JSON_PROPERTY_SHOPPER_LOCALE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOW_PAGES
```
public static final String JSON_PROPERTY_SHOW_PAGES
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GetOnboardingUrlRequest
```
public GetOnboardingUrlRequest()
```
- Method Detail
  - accountHolderCode
```
public GetOnboardingUrlRequest accountHolderCode(String accountHolderCode)
```
  - getAccountHolderCode
```
public String getAccountHolderCode()
```
    The account holder code you provided when you created the account holder.
    
    Returns:
    
    accountHolderCode
  - setAccountHolderCode
```
public void setAccountHolderCode(String accountHolderCode)
```
  - collectInformation
```
public GetOnboardingUrlRequest collectInformation(CollectInformation collectInformation)
```
  - getCollectInformation
```
public CollectInformation getCollectInformation()
```
    Get collectInformation
    
    Returns:
    
    collectInformation
  - setCollectInformation
```
public void setCollectInformation(CollectInformation collectInformation)
```
  - editMode
```
public GetOnboardingUrlRequest editMode(Boolean editMode)
```
  - getEditMode
```
public Boolean getEditMode()
```
    Indicates if editing checks is allowed even if all the checks have passed.
    
    Returns:
    
    editMode
  - setEditMode
```
public void setEditMode(Boolean editMode)
```
  - mobileOAuthCallbackUrl
```
public GetOnboardingUrlRequest mobileOAuthCallbackUrl(String mobileOAuthCallbackUrl)
```
  - getMobileOAuthCallbackUrl
```
public String getMobileOAuthCallbackUrl()
```
    The URL to which the account holder is redirected after completing an OAuth authentication with a bank through Trustly/PayMyBank.
    
    Returns:
    
    mobileOAuthCallbackUrl
  - setMobileOAuthCallbackUrl
```
public void setMobileOAuthCallbackUrl(String mobileOAuthCallbackUrl)
```
  - platformName
```
public GetOnboardingUrlRequest platformName(String platformName)
```
  - getPlatformName
```
public String getPlatformName()
```
    The platform name which will show up in the welcome page.
    
    Returns:
    
    platformName
  - setPlatformName
```
public void setPlatformName(String platformName)
```
  - returnUrl
```
public GetOnboardingUrlRequest returnUrl(String returnUrl)
```
  - getReturnUrl
```
public String getReturnUrl()
```
    The URL where the account holder will be redirected back to after they complete the onboarding, or if their session times out. Maximum length of 500 characters. If you don't provide this, the account holder will be redirected back to the default return URL configured in your platform account.
    
    Returns:
    
    returnUrl
  - setReturnUrl
```
public void setReturnUrl(String returnUrl)
```
  - shopperLocale
```
public GetOnboardingUrlRequest shopperLocale(String shopperLocale)
```
  - getShopperLocale
```
public String getShopperLocale()
```
    The language to be used in the page, specified by a combination of a language and country code. For example, **pt-BR**. If not specified in the request or if the language is not supported, the page uses the browser language. If the browser language is not supported, the page uses **en-US** by default. For a list of supported languages, refer to [Change the page language](https://docs.adyen.com/marketplaces-and-platforms/classic/hosted-onboarding-page/customize-experience#change-page-language).
    
    Returns:
    
    shopperLocale
  - setShopperLocale
```
public void setShopperLocale(String shopperLocale)
```
  - showPages
```
public GetOnboardingUrlRequest showPages(ShowPages showPages)
```
  - getShowPages
```
public ShowPages getShowPages()
```
    Get showPages
    
    Returns:
    
    showPages
  - setShowPages
```
public void setShowPages(ShowPages showPages)
```
  - equals
```
public boolean equals(Object o)
```
    Return true if this GetOnboardingUrlRequest object is equal to o.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - fromJson
```
public static GetOnboardingUrlRequest fromJson(String jsonString)
                                        throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of GetOnboardingUrlRequest given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of GetOnboardingUrlRequest
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to GetOnboardingUrlRequest
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of GetOnboardingUrlRequest to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class GetOnboardingUrlRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_ACCOUNT_HOLDER_CODE

JSON_PROPERTY_COLLECT_INFORMATION

JSON_PROPERTY_EDIT_MODE

JSON_PROPERTY_MOBILE_O_AUTH_CALLBACK_URL

JSON_PROPERTY_PLATFORM_NAME

JSON_PROPERTY_RETURN_URL

JSON_PROPERTY_SHOPPER_LOCALE

JSON_PROPERTY_SHOW_PAGES

Constructor Detail

GetOnboardingUrlRequest

Method Detail

accountHolderCode

getAccountHolderCode

setAccountHolderCode

collectInformation

getCollectInformation

setCollectInformation

editMode

getEditMode

setEditMode

mobileOAuthCallbackUrl

getMobileOAuthCallbackUrl

setMobileOAuthCallbackUrl

platformName

getPlatformName

setPlatformName

returnUrl

getReturnUrl

setReturnUrl

shopperLocale

getShopperLocale

setShopperLocale

showPages

getShowPages

setShowPages

equals

hashCode

toString

fromJson

toJson