Package com.adyen

Class Service

java.lang.Object

com.adyen.Service

Direct Known Subclasses:

AccountCompanyLevelApi, AccountHoldersApi, AccountMerchantLevelApi, AccountStoreLevelApi, AccountVerificationApi, AllowedOriginsCompanyLevelApi, AllowedOriginsMerchantLevelApi, AndroidFilesCompanyLevelApi, ApiCredentialsCompanyLevelApi, ApiCredentialsMerchantLevelApi, ApiKeyAuthenticatedService, ApiKeyCompanyLevelApi, ApiKeyMerchantLevelApi, AuthorizedCardUsersApi, BalanceAccountsApi, BalanceControlApi, BalanceControlApi, BalancesApi, BankAccountValidationApi, BinLookupApi, BinLookupApi, BusinessLinesApi, CapitalApi, CardOrdersApi, ClassicPlatformAccountApi, ClassicPlatformConfigurationApi, ClassicPlatformFundApi, ClassicPlatformHopApi, ClientKeyCompanyLevelApi, ClientKeyMerchantLevelApi, DataProtectionApi, DataProtectionApi, DisputesApi, DisputesApi, DocumentsApi, DonationsApi, GrantAccountsApi, GrantOffersApi, HostedOnboardingApi, InitializationApi, InstantPayoutsApi, LegalEntitiesApi, ManageCardPinApi, ManageScaDevicesApi, ModificationsApi, ModificationsApi, MyApiCredentialApi, NetworkTokensApi, OrdersApi, PaymentApi, PaymentInstrumentGroupsApi, PaymentInstrumentsApi, PaymentLinksApi, PaymentMethodsMerchantLevelApi, PaymentsApi, PaymentsApi, PaymentsAppApi, PaymentsAppApi, PayoutSettingsMerchantLevelApi, PciQuestionnairesApi, PlatformApi, PosMobileApi, PosMobileApi, PosTerminalManagementApi, RecurringApi, RecurringApi, RecurringApi, ReviewingApi, ScaAssociationManagementApi, ScaDeviceManagementApi, SessionAuthenticationApi, SplitConfigurationMerchantLevelApi, StoredValueApi, StoredValueApi, TaxEDeliveryConsentApi, TerminalActionsCompanyLevelApi, TerminalActionsTerminalLevelApi, TerminalLocalAPI, TerminalLocalAPIUnencrypted, TerminalOrdersCompanyLevelApi, TerminalOrdersMerchantLevelApi, TerminalSettingsCompanyLevelApi, TerminalSettingsMerchantLevelApi, TerminalSettingsStoreLevelApi, TerminalSettingsTerminalLevelApi, TerminalsTerminalLevelApi, TermsOfServiceApi, TransactionRulesApi, TransactionsApi, TransferInstrumentsApi, TransferLimitsBalanceAccountLevelApi, TransferLimitsBalancePlatformLevelApi, TransferRoutesApi, TransfersApi, UsersCompanyLevelApi, UsersMerchantLevelApi, UtilityApi, WebhooksCompanyLevelApi, WebhooksMerchantLevelApi

public class Service
extends Object

A generic service that provides shared functionality for all API services. It handles client and configuration management.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Service(Client client)	Constructs a new Service.

Method Summary

Modifier and Type	Method	Description
protected String	createBaseURL(String url)	Creates the base URL for a specific API endpoint.
Client	getClient()	Gets the client used by this service.
boolean	isApiKeyRequired()	Returns true if the service requires an API key.
void	setApiKeyRequired(boolean apiKeyRequired)	Sets if the service requires an API key.
void	setClient(Client client)	Sets the client to be used by this service.

Methods inherited from class java.lang.Object

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

Constructor Detail

Service

protected Service(Client client)

Constructs a new Service.

Parameters:

client - The client used to make API calls.

Method Detail

getClient

public Client getClient()

Gets the client used by this service.

Returns:

The client.

setClient

public void setClient(Client client)

Sets the client to be used by this service.

Parameters:

client - The client.

isApiKeyRequired

public boolean isApiKeyRequired()

Returns true if the service requires an API key.

Returns:

A boolean indicating if an API key is required.

setApiKeyRequired

public void setApiKeyRequired(boolean apiKeyRequired)

Sets if the service requires an API key.

Parameters:

apiKeyRequired - A boolean indicating if an API key is required.

createBaseURL

protected String createBaseURL(String url)

Creates the base URL for a specific API endpoint. It dynamically constructs the URL based on the client's configured Environment.

Parameters:

url - The base URL template.

Returns:

The fully constructed base URL for the target environment.

Throws:

IllegalArgumentException - if the live URL prefix is required but not configured.