adyen_api library
Classes
- AcsWebhooksHandler
- Handler for ACS (Access Control Server) webhooks.
- AdyenApi
- Base class for the Adyen API library.
- AdyenRequestOptions
- Additional options for HTTP requests to Adyen APIs.
- ApiConstants
- Adyen API constant strings.
- ApiError
- Represents a parsed API error response from Adyen.
- ApiService
- Abstract base class for API services using Dio for HTTP requests.
- BalanceControlAPI
- API service for Balance Control operations.
- BalancePlatformAPI
- API service for Balance Platform operations.
- BalanceWebhooksHandler
- Handler for balance platform webhooks.
- BinLookupAPI
- API service for BIN (Bank Identification Number) lookup operations.
- CheckoutAPI
- API service for Checkout operations.
- Client
- Adyen API client managing config, HTTP clients, and endpoints.
- ClientInterface
- Abstract interface for HTTP clients used to communicate with Adyen APIs.
- Config
- Configuration for the Adyen API client.
- ConfigurationWebhooksHandler
- Handler for configuration webhooks.
- DataProtectionAPI
- API service for Data Protection operations.
- DefaultHttpClient
- Default HTTP client implementation for Adyen API requests.
- DioClientFactory
- Factory for creating configured Dio HTTP clients for Adyen API requests.
- DisputesAPI
- API service for Disputes operations.
- DisputeWebhooksHandler
- Handler for dispute webhooks.
- HmacValidator
- Validator for HMAC signatures on Adyen webhooks and API responses.
- LegalEntityManagementAPI
- API service for Legal Entity Management operations.
- LibraryConstants
- Library metadata constants.
- ManagementAPI
- API service for Account Management operations.
- ManagementWebhooksHandler
- Handler for management webhooks.
- NegativeBalanceWarningWebhooksHandler
- Handler for negative balance warning webhooks.
- NexoConstants
- Cryptographic constants for NEXO protocol implementation.
- NexoCrypto
- Cryptographic utilities for NEXO protocol encryption and decryption.
- NexoDerivedKeyGenerator
- Generates cryptographic keys for NEXO protocol encryption.
- NotificationRequest
- Represents an Adyen webhook notification containing one or more items.
- NotificationRequestItem
- Represents a single item in an Adyen webhook notification.
- OpenBankingAPI
- API service for Open Banking operations.
- PaymentAPI
- API service for Payment operations.
- PaymentsAppAPI
- API service for Payments App operations.
- PayoutAPI
- API service for Payout operations.
- Platforms
- Container for all Platforms-related APIs.
- PlatformsAccountAPI
- API service for Platforms Account operations.
- PlatformsFundAPI
- API service for Platforms Fund operations.
- PlatformsHostedOnboardingAPI
- API service for Platforms Hosted Onboarding operations.
- PlatformsNotificationConfigurationAPI
- API service for Platforms Notification Configuration operations.
- PosMobileAPI
- API service for POS Mobile operations.
- PredefinedContentHelper
- Helper for parsing predefined content from terminal notifications.
- RecurringAPI
- API service for Recurring operations.
- ReportWebhooksHandler
- Handler for report webhooks.
- Resource
- Represents a REST API resource/endpoint.
- Service
- Base class for Adyen API services.
- SessionAuthenticationAPI
- API service for Session Authentication operations.
- StoredValueAPI
- API service for Stored Value operations.
- TerminalCloudAPI
- API for communicating with Adyen payment terminals over the cloud.
- TerminalLocalAPI
- API for communicating with Adyen payment terminals over a local network.
- TerminalLocalHttpClient
- HTTP client for Adyen Terminal Local API.
- TerminalManagementAPI
- API service for Terminal Management operations.
- TokenizationWebhooksHandler
- Handler for tokenization webhooks.
- TransactionWebhooksHandler
- Handler for transaction webhooks.
- TransfersAPI
- API service for Transfers operations.
- TransferWebhooksHandler
- Handler for transfer webhooks.
Enums
- DisplayNotificationEvent
- Display notification events from terminals.
- EnvironmentEnum
- Adyen API environment (test for development, live for production).
- NotificationEventCode
- Event codes for webhook notifications.
- NotificationSuccess
- Success status for webhook notifications.
- RegionEnum
- Geographical region for Adyen API endpoints.
Constants
- terminalApiEndpointApseLive → const String
- The Asia-Pacific live environment endpoint for Terminal API.
- terminalApiEndpointAuLive → const String
- The Australia live environment endpoint for Terminal API.
- terminalApiEndpointLive → const String
- The live environment endpoint for Terminal API.
- terminalApiEndpointTest → const String
- The test environment endpoint for Terminal API.
- terminalApiEndpointUsLive → const String
- The United States live environment endpoint for Terminal API.
Functions
-
buildBaseUrl(
Config config, String url) → String -
Builds a base URL for API requests based on
configandurl.
Exceptions / Errors
- ApiException
- Exception thrown when an API request fails.
- HttpClientException
- Exception thrown when an HTTP client request fails.
- InvalidSecurityKeyException
- Exception thrown when a security key is invalid for NEXO operations.
- NexoCryptoException
- Exception thrown when NEXO cryptographic operations fail.