Package com.adyen.service.legalentitymanagement

Class HostedOnboardingApi

java.lang.Object

com.adyen.Service

com.adyen.service.legalentitymanagement.HostedOnboardingApi

public class HostedOnboardingApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
HostedOnboardingApi(Client client)	Hosted Onboarding constructor in package.
HostedOnboardingApi(Client client, String baseURL)	Hosted Onboarding constructor in package.

Method Summary

Modifier and Type	Method	Description
OnboardingLink	getLinkToAdyenhostedOnboardingPage(String id, OnboardingLinkInfo onboardingLinkInfo)	Get a link to an Adyen-hosted onboarding page
OnboardingLink	getLinkToAdyenhostedOnboardingPage(String id, OnboardingLinkInfo onboardingLinkInfo, RequestOptions requestOptions)	Get a link to an Adyen-hosted onboarding page
OnboardingTheme	getOnboardingLinkTheme(String id)	Get an onboarding link theme
OnboardingTheme	getOnboardingLinkTheme(String id, RequestOptions requestOptions)	Get an onboarding link theme
OnboardingThemes	listHostedOnboardingPageThemes()	Get a list of hosted onboarding page themes
OnboardingThemes	listHostedOnboardingPageThemes(RequestOptions requestOptions)	Get a list of hosted onboarding page themes

Methods inherited from class com.adyen.Service

createBaseURL, getClient, isApiKeyRequired, setApiKeyRequired, setClient

Methods inherited from class java.lang.Object

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

Field Detail

API_VERSION

public static final String API_VERSION

See Also:

Constant Field Values

baseURL

protected String baseURL

Constructor Detail

HostedOnboardingApi

public HostedOnboardingApi(Client client)

Hosted Onboarding constructor in package.

Parameters:

client - Client (required)

HostedOnboardingApi

public HostedOnboardingApi(Client client,
                           String baseURL)

Hosted Onboarding constructor in package. Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant.

Parameters:

client - Client (required)

baseURL - String (required)

Method Detail

getLinkToAdyenhostedOnboardingPage

public OnboardingLink getLinkToAdyenhostedOnboardingPage(String id,
                                                         OnboardingLinkInfo onboardingLinkInfo)
                                                  throws ApiException,
                                                         IOException

Get a link to an Adyen-hosted onboarding page

Parameters:

id - String The unique identifier of the legal entity (required)

onboardingLinkInfo - OnboardingLinkInfo (required)

Returns:

OnboardingLink

Throws:

ApiException - if fails to make API call

IOException

getLinkToAdyenhostedOnboardingPage

public OnboardingLink getLinkToAdyenhostedOnboardingPage(String id,
                                                         OnboardingLinkInfo onboardingLinkInfo,
                                                         RequestOptions requestOptions)
                                                  throws ApiException,
                                                         IOException

Get a link to an Adyen-hosted onboarding page

Parameters:

id - String The unique identifier of the legal entity (required)

onboardingLinkInfo - OnboardingLinkInfo (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

OnboardingLink

Throws:

ApiException - if fails to make API call

IOException

getOnboardingLinkTheme

public OnboardingTheme getOnboardingLinkTheme(String id)
                                       throws ApiException,
                                              IOException

Get an onboarding link theme

Parameters:

id - String The unique identifier of the theme (required)

Returns:

OnboardingTheme

Throws:

ApiException - if fails to make API call

IOException

getOnboardingLinkTheme

public OnboardingTheme getOnboardingLinkTheme(String id,
                                              RequestOptions requestOptions)
                                       throws ApiException,
                                              IOException

Get an onboarding link theme

Parameters:

id - String The unique identifier of the theme (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

OnboardingTheme

Throws:

ApiException - if fails to make API call

IOException

listHostedOnboardingPageThemes

public OnboardingThemes listHostedOnboardingPageThemes()
                                                throws ApiException,
                                                       IOException

Get a list of hosted onboarding page themes

Returns:

OnboardingThemes

Throws:

ApiException - if fails to make API call

IOException

listHostedOnboardingPageThemes

public OnboardingThemes listHostedOnboardingPageThemes(RequestOptions requestOptions)
                                                throws ApiException,
                                                       IOException

Get a list of hosted onboarding page themes

Parameters:

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

OnboardingThemes

Throws:

ApiException - if fails to make API call

IOException