Package com.adyen.model.hop

Class GetOnboardingUrlRequest

java.lang.Object

com.adyen.model.hop.GetOnboardingUrlRequest

public class GetOnboardingUrlRequest
extends Object

GetOnboardingUrlRequest

Constructor Summary

Constructors

Constructor	Description
GetOnboardingUrlRequest()

Method Summary

Modifier and Type	Method	Description
GetOnboardingUrlRequest	accountHolderCode(String accountHolderCode)
GetOnboardingUrlRequest	collectInformation(OnboardingCollectInformation collectInformation)
GetOnboardingUrlRequest	editMode(Boolean editMode)
boolean	equals(Object o)
String	getAccountHolderCode()	The account holder code you provided when you created the account holder.
OnboardingCollectInformation	getCollectInformation()	What information should be collected on the hosted onboarding page
String	getPlatformName()	The platform name which will show up in the welcome page.
String	getReturnUrl()	The URL where the sub-merchant 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.
OnboardingShowPages	getShowPages()	What pages should be shown on the hosted onbarding page
int	hashCode()
Boolean	isEditMode()	Allows editing checks even if all the checks have passed.
GetOnboardingUrlRequest	platformName(String platformName)
GetOnboardingUrlRequest	returnUrl(String returnUrl)
void	setAccountHolderCode(String accountHolderCode)
void	setCollectInformation(OnboardingCollectInformation collectInformation)
void	setEditMode(Boolean editMode)
void	setPlatformName(String platformName)
void	setReturnUrl(String returnUrl)
void	setShopperLocale(String shopperLocale)
void	setShowPages(OnboardingShowPages showPages)
GetOnboardingUrlRequest	shopperLocale(String shopperLocale)
GetOnboardingUrlRequest	showPages(OnboardingShowPages showPages)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetOnboardingUrlRequest

public GetOnboardingUrlRequest()

Method Detail

getAccountHolderCode

public String getAccountHolderCode()

The account holder code you provided when you created the account holder.

Returns:

accountHolderCode

setAccountHolderCode

public void setAccountHolderCode(String accountHolderCode)

accountHolderCode

public GetOnboardingUrlRequest accountHolderCode(String accountHolderCode)

isEditMode

public Boolean isEditMode()

Allows editing checks even if all the checks have passed.

Returns:

editMode

setEditMode

public void setEditMode(Boolean editMode)

editMode

public GetOnboardingUrlRequest editMode(Boolean editMode)

getPlatformName

public String getPlatformName()

The platform name which will show up in the welcome page.

Returns:

platformName

setPlatformName

public void setPlatformName(String platformName)

platformName

public GetOnboardingUrlRequest platformName(String platformName)

getReturnUrl

public String getReturnUrl()

The URL where the sub-merchant 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 sub-merchant will be redirected back to the default return URL configured in your platform account.

Returns:

returnUrl

setReturnUrl

public void setReturnUrl(String returnUrl)

returnUrl

public GetOnboardingUrlRequest returnUrl(String returnUrl)

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**. \n\nIf 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.\n\nFor a list supported languages, refer to [Change the page language](https://docs.adyen.com/platforms/onboarding-and-verification/hosted-onboarding-page#change-page-language).

Returns:

accountHolderCode

setShopperLocale

public void setShopperLocale(String shopperLocale)

shopperLocale

public GetOnboardingUrlRequest shopperLocale(String shopperLocale)

getShowPages

public OnboardingShowPages getShowPages()

What pages should be shown on the hosted onbarding page

Returns:

setShowPages

public void setShowPages(OnboardingShowPages showPages)

showPages

public GetOnboardingUrlRequest showPages(OnboardingShowPages showPages)

getCollectInformation

public OnboardingCollectInformation getCollectInformation()

What information should be collected on the hosted onboarding page

Returns:

setCollectInformation

public void setCollectInformation(OnboardingCollectInformation collectInformation)

collectInformation

public GetOnboardingUrlRequest collectInformation(OnboardingCollectInformation collectInformation)

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