Adyen

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.

Install

• pip install Adyen Python (note capital A)

Imports

• Adyen

  import Adyen
  
  adyen = Adyen.Adyen()
  adyen.client.xapikey = 'YOUR_X_API_KEY'
  adyen.client.platform = 'test'  # or 'live'

  Package name is 'Adyen' with capital A. 'import adyen' (lowercase) fails with ModuleNotFoundError.
• Service-specific client

  from Adyen import checkout
  checkout.client.xapikey = 'YOUR_X_API_KEY'
  checkout.client.platform = 'test'

  For multi-credential setups, use service-specific clients. The hmac field on adyen.payment.client is for webhook HMAC verification, not API auth.

Quickstart

Amounts are always in minor units (cents, pence). 1000 = $10.00 USD.

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)