Adyen
raw JSON → 14.0.0 verified Mon May 11 auth: yes python install: verified quickstart: verified
Official Python API library for Adyen payment processing. Auto-generated from OpenAPI spec. PyPI package name is 'Adyen' (capital A). Uses X-API-Key auth, not OAuth. Each major version pins updated API versions and may contain breaking changes from codegen corrections.
pip install Adyen Common errors
error ModuleNotFoundError: No module named 'Adyen' ↓
cause The Adyen package is not installed or the import statement uses incorrect capitalization.
fix
Ensure the package is installed using 'pip install Adyen' and import it with 'import Adyen'.
error AttributeError: module 'Adyen' has no attribute 'Client' ↓
cause The Adyen module does not contain a 'Client' attribute; the correct attribute is 'AdyenClient'.
fix
Use 'from Adyen.client import AdyenClient' to import the correct class.
error TypeError: 'Adyen' object is not callable ↓
cause Attempting to call the 'Adyen' module as a function, which is not supported.
fix
Instantiate the client correctly using 'adyen = Adyen.Adyen()'.
error ImportError: cannot import name 'Adyen' from 'adyen' ↓
cause The package name is case-sensitive; 'Adyen' should be capitalized.
fix
Use 'import Adyen' instead of 'import adyen'.
error AdyenAPIAuthenticationError: HTTP Status 401 Unauthorized ↓
cause The API key provided is invalid or missing.
fix
Verify that the correct API key is set using 'adyen.client.xapikey = "YourXapikey"'.
Warnings
breaking v13.0 introduced a codegen fix: service methods that previously duplicated required path parameters as separate unused method arguments were corrected. Code that was passing those extra args (e.g. method(entity_id, entity_id, request)) now receives TypeError for unexpected arguments. ↓
fix Review method signatures for services you use and remove any duplicated path parameter arguments. Only the request object and explicit path params (e.g. psp_reference) should be passed.
breaking POS Terminal Management API deprecated. All terminal fleet management must migrate to the Management API. Calls to terminal management endpoints via the old API return deprecation errors. ↓
fix Use adyen.management.terminal_management to manage terminal fleet via the Management API.
gotcha Package name is 'Adyen' (capital A). pip install adyen (lowercase) installs a different, unrelated package. import adyen fails with ModuleNotFoundError. ↓
fix pip install Adyen && import Adyen
gotcha All payment amounts are in minor currency units. 1000 = $10.00 USD, £10.00 GBP, €10.00 EUR. Passing major units (e.g. value: 10) results in processing 10 cents/pence. ↓
fix Multiply by 100 for 2-decimal currencies. Check Adyen docs for currencies with different decimal places (e.g. JPY has 0 decimals).
gotcha adyen.client.platform must be set to 'test' or 'live'. Default is 'test'. Forgetting to set 'live' in production sends requests to the test environment, resulting in no real charges. ↓
fix Set adyen.client.platform = 'live' in production. Test and live environments use separate API keys.
gotcha Live environment endpoints require a live URL prefix specific to your account (e.g. {YOUR-UNIQUE-LIVE-PREFIX}-checkout-live.adyenpayments.com). The SDK default live URL will fail for checkout endpoints without this prefix. ↓
fix Set adyen.client.live_endpoint_prefix to your unique live prefix from Adyen Customer Area when using the live environment.
gotcha Pip warnings or notices related to running pip as root, not using a virtual environment, or available pip updates are observed in the test output. These are general advisories from the pip package manager and do not indicate a failure or issue with the Adyen SDK itself. ↓
fix Review and address pip's recommendations regarding environment setup (e.g., use virtual environments, avoid running pip as root) and keep pip updated. These messages are external to the Adyen SDK's functionality.
gotcha Pip displays warnings about running as a root user, which can cause permission issues, and often notifies about available updates. These are general pip environment issues, not specific to the Adyen library. ↓
fix It is recommended to use a virtual environment for package installations to avoid permission issues and conflicts with the system package manager. Consider updating pip if a notice is displayed, using 'pip install --upgrade pip'.
Install compatibility verified last tested: 2026-05-11
python os / libc status wheel install import disk
3.10 alpine (musl) - - 0.23s 28.9M
3.10 slim (glibc) - - 0.10s 29M
3.11 alpine (musl) - - 0.23s 31.6M
3.11 slim (glibc) - - 0.27s 31M
3.12 alpine (musl) - - 0.23s 23.2M
3.12 slim (glibc) - - 0.29s 23M
3.13 alpine (musl) - - 0.14s 22.8M
3.13 slim (glibc) - - 0.24s 23M
3.9 alpine (musl) - - 0.23s 28.4M
3.9 slim (glibc) - - 0.12s 28M
Imports
- Adyen wrong
import adyen from adyen import Adyencorrectimport Adyen adyen = Adyen.Adyen() adyen.client.xapikey = 'YOUR_X_API_KEY' adyen.client.platform = 'test' # or 'live' - Service-specific client wrong
adyen.payment.client.hmac = '...'correctfrom Adyen import checkout checkout.client.xapikey = 'YOUR_X_API_KEY' checkout.client.platform = 'test'
Quickstart verified last tested: 2026-05-11
import Adyen
adyen = Adyen.Adyen()
adyen.client.xapikey = 'YOUR_X_API_KEY'
adyen.client.platform = 'test' # change to 'live' for production
request = {
'merchantAccount': 'YOUR_MERCHANT_ACCOUNT',
'amount': {'currency': 'USD', 'value': 1000}, # value in minor units (cents)
'reference': 'order-12345',
'paymentMethod': {
'type': 'scheme',
'encryptedCardNumber': 'test_4111111111111111',
'encryptedExpiryMonth': 'test_03',
'encryptedExpiryYear': 'test_2030',
'encryptedSecurityCode': 'test_737'
},
'returnUrl': 'https://your-company.com/checkout/return'
}
result = adyen.checkout.payments_api.payments(request)
print(result.message)