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

Adyen Ruby API Library v10.4.0

What's Changed

New Features 💎

• Set the default HTTP client timeout, when the application doesn't provide a custom connection_options object #298.

BalancePlatform API

Configuration API / Payment Instruments

• Added new service AuthorizedCardUsersApi to manage (add, get, delete and update) authorized users to a given card.

• Added support for:

  • get_network_token_activation_data - Get the network token activation data for a payment instrument.
  • create_network_token_provisioning_data - Create provisioning data for a network token. Use the provisioning data to add a user's payment instrument to their digital wallet.

Other Changes 🖇️

• Default values for HTTP Client Timeout by @gcatanese in #298
• Code generation: update services and models by @AdyenAutomationBot in #299
• Code generation - rename create_network_token_activation_data to create_network_token_provisioning_data: update services and models by @AdyenAutomationBot in #304
• Release v10.4.0 by @AdyenAutomationBot in #300

Full Changelog: v10.3.0...v10.4.0

Adyen Ruby API Library v10.3.0

What's Changed

New Features 💎

• Added SessionAuthentication
• BalancePlatform:
  • Added balances_api
• SessionAuthentication:
  • Added session_authentication_api
• Code generation: update services and models by @AdyenAutomationBot in #293

Other Changes 🖇️

• Add close-issue-label flag to correctly label closed issues by @DjoykeAbyah in #294
• Update DisputesService in Client by @DjoykeAbyah in #296
• Release v10.3.0 by @AdyenAutomationBot in #295

Full Changelog: v10.2.0...v10.3.0

Adyen Ruby API Library v10.2.0

What's Changed

New Features 💎

• Code generation: update services and models by @AdyenAutomationBot in #291

Other Changes 🖇️

• Update README.md by @DjoykeAbyah in #289
• Add GitHub issue forms by @ayodejidev in #292
• Release v10.2.0 by @AdyenAutomationBot in #290

Full Changelog: v10.1.2...v10.2.0

Adyen Ruby API Library v10.1.2

What's Changed

• Added deprecation message to get_capital_account, get_grant_reference_details and request_grant_payout.

Other Changes 🖇️

• Code generation: update services and models by @AdyenAutomationBot in #287
• Release v10.1.2 by @AdyenAutomationBot in #288

Important

From January 1, 2025 POS Terminal Management API is deprecated and support stops on April 1, 2025. To automate the management of your terminal fleet, use our Management API.

Before: (deprecated) https://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalDetails We've moved the fields TerminalStatus to lastActivityAt and data.AssignmentStatus.
Note that your API-credentials requires the following permission: Management API — Terminal actions read.

Full Changelog: v10.1.1...v10.1.2

Adyen Ruby API Library v10.1.1

What's Changed

• ⚠️ Important ⚠️ PosTerminalManagement is effectively obsolete as all its methods are deprecated. Users are advised to migrate to the newer Management API for POS terminal management functionality. https://docs.adyen.com/api-explorer/Management/latest/overview

Other Changes 🖇️

• Update all services by @AdyenAutomationBot in #284
• Release v10.1.1 by @AdyenAutomationBot in #286

Full Changelog: v10.1.0...v10.1.1

Adyen Ruby API Library v10.1.0

What's Changed

New Features 💎

• LegalEntityManagement:
  • Added calculate_pci_status_of_legal_entity
• Update all services by @AdyenAutomationBot in #281

Other Changes 🖇️

• Release v10.1.0 by @AdyenAutomationBot in #282

Full Changelog: v10.0.1...v10.1.0

Adyen Ruby API Library v10.0.1

What's Changed

Other Changes 🖇️

• Code generation: add comments and deprecation note by @gcatanese in #277
• Add minimum required release age by @ayodejidev in #280
• Update all services by @AdyenAutomationBot in #279
• Fix PosMobile Live Service URL by @ollym in #276
• Release v10.0.1 by @AdyenAutomationBot in #278

New Contributors

• @ayodejidev made their first contribution in #280

Full Changelog: v10.0.0...v10.0.1

Adyen Ruby API Library v10.0.0

What's Changed

Breaking Changes 🛠

• Checkout API:
  • Removal of ClassicCheckoutSDKApi
• Update all services by @AdyenAutomationBot in #274

Other Changes 🖇️

• LegalEntityManagement API:
  • In terms_of_service_api added get_accepted_terms_of_service_document
• Release v10.0.0 by @AdyenAutomationBot in #275

Full Changelog: v9.9.0...v10.0.0

Adyen Ruby API Library v9.9.0

What's Changed

New Features 💎

• Transfers API:
  • In TransfersApi approve_initiated_transfers added and cancel_initiated_transfers in to initiate the approval of a list of transfers that triggered an additional review and initiate a cancellation of a list of transfers that triggered an additional review.
• Update all services by @AdyenAutomationBot in #271

Other Changes 🖇️

• fix: add require for Adyen::PosMobile by @davidjrice in #272
• Release v9.9.0 by @AdyenAutomationBot in #273

Full Changelog: v9.8.0...v9.9.0