Skip to content

Adyen Node API Library v28.0.0

Choose a tag to compare

View all tags
@AdyenAutomationBot AdyenAutomationBot released this 14 Jul 08:40
· 268 commits to main since this release
v28.0.0
188715c
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

What's Changed

This release brings significant improvements, new features, and few breaking changes to the Adyen Node 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.

Please review the Breaking Changes and update your integrations accordingly. For any questions, feel free to open an issue or consult our API Explorer.

🚀 Highlights

  • Enhanced OpenAPI Code Generation: Source code is now more idiomatic, flexible, and better aligned with Adyen's OpenAPI specifications.
  • Automated Webhook Handler Generation: Webhook handlers and models are now automatically generated and updated with each release.
  • Refined Package Structure: Several APIs have been moved to more specific packages for better discoverability and maintainability.
  • Improved Error Handling: Make the API Error object available, alongside the raw JSON
  • Revised Enum Values Deserialization: During the response deserialization unknown enums are ignored, instead of causing an error affecting the integrations

🛠 Breaking Changes

🔒 Honouring required attributes

Mandatory attributes are no longer marked as optional, but are expected to be provided. Although this is the correct implementation, it is a ‼️ breaking change (previously the library didn't do that) #1502

🔁 Order of query parameters

A few method signatures have been updated to add the required query parameters before all optional parameters, to avoid causing an error (invalid order of parameters) #1515

This change affects only:

  • Transfers API getAllTransactions: the required params createdSince an createdUntil are the first 2 parameters, before all others.
  • Transfers API getAllTransfers: the required params createdSince an createdUntil are the first 2 parameters, before all others.

🔍 Important Changes

📦 Service Class Refactoring

The following services have been moved to their own folder.
Service classes in the old location are deprecated and will be removed in a future release.

Note: There are no changes in functionality (the same code is now available in the new location), please update your code accordingly.

Old Location New Location
services.storedValueApi services.storedvalue.storedValueApi
services.binLookupApi services.binlookup.binLookupApi
services.balanceControlApi services.balancecontrol.balanceControlApi
services.dataProtectionApi services.dataprotection.dataProtectionApi
services.disputesApi services.disputes.disputesApi
services.paymentsAppApi services.paymentsapp.paymentsAppApi
services.posMobileApi services.posmobile.posMobileApi

🪝 Webhook Handling

Webhook handling is now modernized and streamlined:

  • Automation: Auto-generated handlers ensure that webhook events and models stay aligned with the changes in the OpenAPI specs
  • Deprecated: Former bankingWebhookHandler and managementWebhooksHandler classes are now deprecated
  • Recommended: Use instead the dedicated handler in the Webhook package (AcsWebhooks, ReportWebhooksHandler, ConfigurationWebhooks, TransferWebhooks, TransactionWebhooks, etc..)
 const configurationWebhooksHandler = new ConfigurationWebhooksHandler(jsonString);
 const accountHolderNotificationRequest = configurationWebhooksHandler.getAccountHolderNotificationRequest();

⚠️ Deprecation of TerminalManagementAPI

Support for the "classic" POS Terminal Management API has stopped. To automate assigning terminals, you must use Management API.

☘️ Improved Error Handling

The APIError model is readily available in the HttpClientException object when an API call fails. This eliminates the need for manual parsing of the response body by library users. #1509
The library exports the HttpClientException class, allowing to try-catch the Adyen API exceptions without importing directly from the specific path within the library. #1526

💎 New Features & Enhancements

Session Authentication API

Add support for Session Authentication API to create the sessions required for integrating Adyen Platform components (#1435)

BalancePlatform

  • New: BalancesApi service now supports BalanceWebhookSetting for managing Balance Webhook criteria.

  • New: BalancesApi service now supports AuthorizedCardUsersApi to manage (add, get, delete and update) authorized users to a given card

  • Other changes:

    • In PaymentInstrumentsApi add methods createNetworkTokenActivationData and getNetworkTokenActivationData to create and retrieve network token activation data for a payment instrument.

  • In AdditionalBankIdentification add new enums auBsbCode and caRoutingNumber

  • In AccountHoldersApi.getTaxFormResponse add optional parameter legalEntityId

  • Add NetworkTokenRequestor to NetworkToken

  • Add dataMissing enum to VerificationError

  • Add walletProviderDeviceType in TransactionRuleRestrictions

  • Add enum INTEREST in TransferRoute.CategoryEnum

ACS Webhooks

  • In RelayedAuthenticationRequest add new attributes threeDSRequestorAppURL, environment, timestamp, type

Checkout

  • Add capturePspReference to PaymentRefundRequest
  • Add businessDayOnly to PixRecurring
  • In PaymentMethodRequest add attributes browserInfo, shopperEmail, shopperIP and telephoneNumber
  • In SessionResultResponse add attributes:
    • payments to provide a list of all authorised payments done for this session
    • reference to provide the unique reference in the original /sessions request
    • additionalData to provide additional information about the payment

Configuration Webhooks

  • Add NetworkTokenRequestor to NetworkTokenNotificationDataV2
  • Add Wallet class to provide information about the wallet for which the network token is provisioned.

Transfers API

  • New attribute: executionDate in TransferData
  • Add class BankAccountV3AccountIdentification

Transfers Webhooks

  • New attribute: executionDate in TransferData
  • Add class BankAccountV3AccountIdentification

Webhooks

  • In NotificationRequestItem add missing event codes INFORMATION_SUPPLIED, DISPUTE_DEFENSE_PERIOD_ENDED, ISSUER_RESPONSE_TIMEFRAME_EXPIRED, ISSUER_COMMENTS #1506

Changes in this release:

New Contributors

Full Changelog: v27.0.0...v28.0.0

Contributors

gcatanese, AdyenAutomationBot, and Kwok-he-Chu
Assets 2
Loading