Adyen API library for Dart

A type-safe Dart library for Adyen's payment APIs, generated from official OpenAPI specifications.

Pure Dart HTTP client - no native dependencies. Unlike wrapping Java/Swift SDKs via MethodChannel, this library works across Flutter, web, server-side, and CLI without native platform bridging. Note: Terminal Local API is not available on web due to browser security model's limitation.

Why This Over Native SDKs?

	This Library	MethodChannel + Native SDKs
Platform Support	Flutter, web, server, CLI	Mobile only
Native Dependencies	None	Java/Swift SDKs
Bundle Size	Tree-shaken, only what you use	Full SDK bundled
Bridge Overhead	None	MethodChannel calls
Debugging	Pure Dart stack traces	Platform-specific debugging
Maintenance	Single codebase	Multi-language maintenance

Features

Pure Dart - No MethodChannel, FFI, or native code. Works on Flutter, web, server, and CLI.
Comprehensive API Coverage - Checkout, Payments, Terminal, Balance Platform, and more
Webhook Support - Complete handlers for all Adyen webhooks
Tested - Comprehensive test suite with mocking support

Installation

dependencies:
  adyen_api: ^0.4.0

fvm dart pub get

Quick Start

import 'package:adyen_api/adyen_api.dart';
import 'package:adyen_api/checkout_models.dart' as checkout;

void main() async {
  // Configure client
  final config = Config(
    apiKey: 'your-api-key',
    environment: EnvironmentEnum.test,
  );
  final client = Client(config);
  final checkoutApi = CheckoutAPI(client);

  // Create payment
  final paymentRequest = checkout.PaymentRequest(
    (b) => b
      ..amount.currency = 'USD'
      ..amount.value = 1000
      ..merchantAccount = 'your-merchant-account'
      ..reference = 'ORDER-1001'
      ..returnUrl = 'https://your-company.example/checkout/return',
  );

  final response = await checkoutApi.unwrap(
    checkoutApi.paymentsApi.postPayments(paymentRequest: paymentRequest),
  );

  print('Result: ${response?.resultCode}');
}

Supported APIs

Checkout & Payments

Checkout API, Payment API, Recurring API, Payout API

Terminal

Terminal Local API, Terminal Cloud API, Terminal Management API

Balance Platform

Balance Control API, Balance Platform API

Other Services

BinLookup, Disputes, Data Protection, Legal Entity, Open Banking,
Stored Value, Transfers, Platforms, POS Mobile, Payments App, Session Authentication

Webhooks

Complete support for all Adyen webhook types including transaction, balance, configuration, dispute, tokenization, transfer, and more.

Documentation

See the example/ directory for complete examples:

Basic checkout payment
Terminal management with NEXO encryption

Development and maintenance

The package supports Dart 3.10.3 and newer. Development uses the stable SDK pinned in .fvmrc; CI checks both the minimum supported SDK and the latest stable SDK.

fvm install
fvm dart pub get
fvm dart analyze --fatal-infos
fvm dart test

Generated clients live in lib/src/gen/. To update them, change the OpenAPI lock file or the scripts in tool/codegen/, then regenerate:

./tool/codegen/generate.sh
fvm dart run build_runner build
./tool/generate_model_exports.sh --check

Code generation requires Java and OpenAPI Generator 7.18.0 (the version used in CI), Python 3, jq, and ripgrep. The generation script fetches the Adyen specifications at the commit recorded in tool/openapi.lock.json.

The weekly openapi-codegen workflow opens an update PR after analysis and tests pass. Its AUTOMATION_PAT repository secret must be valid and grant Contents and Pull requests write access to this repository. For a classic PAT, use the repo scope. A personal token lets the generated PR trigger CI; renew the secret if the workflow reports invalid or expired credentials. If GitHub disables scheduled runs after repository inactivity, re-enable openapi-codegen in the Actions tab after renewing the token.

Maintenance check on 2026-10-25: the scheduled updater is disabled due to inactivity, and its most recent run failed with Bad credentials. Renew AUTOMATION_PAT and re-enable the workflow to resume automatic specification updates.

When releasing, keep pubspec.yaml, LibraryConstants.libVersion, and the installation example above in sync so request headers report the package version.

The OpenAPI lock tracks Adyen's 2026-10-22 specification release, including Checkout v72. Balance Platform sweep operations are now available through customPayoutSchedulesSweepsApi instead of balanceAccountsApi, matching the API groups in the upstream specification.