Adyen Ruby API Library v11.0.0

What's Changed

This release brings significant improvements, new features, and few breaking changes to the Adyen Ruby API Library. It marks a major milestone in aligning the library more closely with Adyen’s OpenAPI specifications and improving the ✨ Developer Experience ✨

⚠️ Find below what's new as well as a detailed summary of the Breaking Changes, and what you should do or consider.

🛠 Breaking Changes

Renaming files

BalanceControlService renamed to BalanceControl
This aligns the class name with the library’s naming conventions. There are no changes in functionality or behavior.

Service folder restructuring

To ensure a consistent directory structure across all services, several services have been moved from the services folder into their own subfolders:
balanceControl, binLookup, dataProtection, disputes, payment, paymentsApp, posMobile, recurring, storedValue.

Introducing service wrappers

To ensure a consistent way of accessing service functionality, several APIs now use a wrapper class that exposes their endpoints through the shared Adyen client.
This structure, already used by services (i.e. checkout, balancePlatform, etc..) now applies to:
balanceControl, binLookup, dataProtection, disputes, payment, paymentsApp, posMobile, recurring, storedValue.

Action required: update your code to call the API via the wrapper.
For example:

# Before
result = @shared_values[:client].bin_lookup.get_cost_estimate(request_body)

# After
result = @shared_values[:client].bin_lookup.bin_lookup_api.get_cost_estimate(request_body)

SessionAuthentication API

• remove unused authentication_session_request parameter in create_authentication_session

BalancePlatform API

• remove unused authorised_card_users parameter in create_authorised_card_users and update_authorised_card_users
• remove unused balance_webhook_setting_info parameter in create_webhook_setting
• remove unused balance_webhook_setting_info_update parameter in update_webhook_setting

💎 New Features

Improved error handling

Improved error handling: the Ruby client now raises specific exceptions (with a detailed error message) for common API errors (400, 422, 5xx) instead of returning generic results, providing clearer and more contextual error messages. #310

Legal Entity Management API v4

LEM v4 enhances the onboarding process and ensures compliance with evolving regulatory data requirements across regions and products.

See the Onboarding v4 documentation for details, and review the API changes from v3 to v4 to understand the impact on your integration.

Open Banking API

Add support for Open Banking API v1:

• Create a list of available account verification routes
• Verify bank account ownership

Balance Platform API

• Add Transfer limits - balance platform level
• Add Transfer limits - balance account level

Checkout API

• Add Validate Shopper Id

What's Changed

• OpenAPI Generator v7 by @gcatanese in #313
• Release Workflow: run only for PRs from maintainers by @gcatanese in #309
• Update CODEOWNERS by @gcatanese in #312
• Improve error handling by @gcatanese in #310
• Release v11.0.0 by @AdyenAutomationBot in #308

Full Changelog: v10.4.0...v11.0.0