Skip to content

Releases: Adyen/adyen-node-api-library

Adyen Node API Library v30.0.0

16 Oct 06:47
f8743c2

Choose a tag to compare

This release introduces major improvements, including support for LEM v4, OpenAPI Banking and many other changes across all APIs.
Make sure to review the highlights below and check the breaking changes that may require updates in your integration.

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.

⚠️ Critical changes:

  • BusinessLine: capability attribute has been removed
  • SourceOfFunds: acquiringBusinessLineId attribute has been removed
  • SourceOfFunds: adyenProcessedFunds attribute is now required

See new fields and other details in #1544

🛠 Breaking Changes

Checkout API

New ShopperName class has been introduced, to be used when defining the name of the shopper. This affects several classes: CreateCheckoutSessionRequest, CreateCheckoutSessionResponse, DonationPaymentRequest, PaymentRequest.

The attribute shopperName has changed from

"shopperName"?: Name | null;

to

"shopperName"?: ShopperName | null;

BalancePlatform API

In TransferLimitsBalanceAccountLevelApi the signatures of the methods deletePendingTransferLimit and getSpecificTransferLimit have been modified by inverting the order of the parameters (to align with the order defined in the OpenAPI specification).

From

deletePendingTransferLimit(transferLimitId: string, id: string, requestOptions?: IRequest.Options): Promise<void> 

getSpecificTransferLimit(transferLimitId: string, id: string, requestOptions?: IRequest.Options): Promise<TransferLimit>

to

public async deletePendingTransferLimit(id: string, transferLimitId: string, requestOptions?: IRequest.Options): Promise<void>

public async getSpecificTransferLimit(id: string, transferLimitId: string, requestOptions?: IRequest.Options): Promise<TransferLimit>

💎 New Features

Add support for Open Banking API v1:

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

Checkout API

  • Add support for UPI QR Code
  • In PaymentDetails add enum Iris
  • In UpiIntentDetails add attribute billingSequenceNumber
  • In UpiCollectDetails make attribute billingSequenceNumber optional
  • In PaymentRequest add attribute sdkData
  • Add encryptedPassword attribute in CardDetails
  • Add ResponseAdditionalDataSwish
  • Add bankTransfer enum value in PaymentDetails

Classic Payments

  • In Recurring add enum values External and Oneclickrecurring
  • Add ResponseAdditionalDataSwish

Payout API

  • Add ResponseAdditionalDataSwish

Recurring API

  • In External add enum values External and Oneclickrecurring

Balance Platform API

  • In BulkAddress add attributes line1, line2, line3
  • Add TransferLimitsBalanceAccountLevelApi to manage Transfer limits - balance account level
  • Add TransferLimitsBalancePlatformLevelApi to manage Transfer limits - balance platform level
  • Add enum value dataReview in VerificationError and VerificationErrorRecursive

Transfer API

  • Add enum value Accepted in ConfirmationTrackingData

Management API

  • Add CardRegionEnum enum in SplitConfigurationRule class
  • Add enum value BR_SCHEMES in PaymentMethodResponse and PaymentMethodSetupInfo
  • Add attribute unreferenced in Refunds

Configuration Webhooks

  • In BulkAddress add attributes line1, line2, line3
  • In NetworkTokenNotificationDataV2 add attribute schemeRiskScore
  • Add attribute deviceId in Device
  • Add enum value dataReview in VerificationError and VerificationErrorRecursive

Transfer Webhooks

  • Add enum value Accepted in ConfirmationTrackingData

Management Webhooks

  • In TerminalAssignmentNotificationRequest add attribute assignedToStoreId
  • Add enum values dataReview in VerificationError and VerificationErrorRecursive

Dispute Webhooks

  • Add other enum value in DisputeEventNotification

🖇️ Other Changes

🎉 New Contributors

Full Changelog: v29.1.0...v30.0.0

Adyen Node API Library v29.1.0

05 Sep 08:06
ef3387d

Choose a tag to compare

Critical Fix ⛑️

New Features 💎

Terminal API

Other Changes 🖇️

New Contributors

Full Changelog: v29.0.0...v29.1.0

Adyen Node API Library v29.0.0

18 Aug 15:47
6b76dac

Choose a tag to compare

What's Changed

Important

For Terminal API users please make sure to upgrade directly to v29.1.0, which contains a critical fix for the Terminal API live endpoints.

Breaking Changes 🛠

Client setup has been streamlined

The Client is instantiated directly with a Config object, simplifying setup and enforcing best practices by centralizing configuration management (supporting EnvironmentEnum and RegionEnum). #1534

const config = new Config({
    apiKey: "myApiKey",
    environment: EnvironmentEnum.LIVE,
    liveEndpointUrlPrefix: "myPrefix",
    region: RegionEnum.US
});
client = new Client(config);

Terminal Cloud API async

The async return type has been updated from Promise<string> to Promise<string | SaleToPOIRequest>. Consumers must now check the type of the response before using it. #1538

If you were assuming a string response, you now need to handle both string and SaleToPOIRequest:

const response = await terminalCloudAPI.async(paymentRequest);
// handle both `string` and `TerminalApiResponse`
if (typeof response === "string") {
  // Your previous logic
  ...
} else {
  // request failed: see details in the EventNotification object
  console.log("EventToNotify:", requestResponse.SaleToPOIRequest?.EventNotification?.EventToNotify);
  console.log("EventDetails:", requestResponse.SaleToPOIRequest?.EventNotification?.EventDetails);
}

Management API

  • Remove several attributes (countryCode, merchantCity, merchantLegalName, etc..) from PayByBankPlaidInfo

New Features 💎

Terminal API

  • Support for Regions #1534
  • Introduce PredefinedContentHelper for managing Display Events #1527

Checkout API

  • Added support for validateShopperId utility to validate the Shopper Id
  • Added support for PayToPaymentMethod and UPIPaymentMethod
  • Add action attribute (PaymentDetailsResponseAction) in PaymentDetailsResponse
  • Added enum RIVERTY_INSTALLMENTS in RivertyDetails

Balance Platform API

  • Added support for uSInternationalAchPriorityRequirement

Configuration Webhooks

  • Add support for ScoreNotification webhook

Management API

  • Added support for SepaDirectDebitInfo

Session Authentication API

  • Add Bank enum value to ProductType

Webhooks

  • Update the definition of NotificationRequestItem.additionalData to expect undefined values in the map #1541

Full Changelog: v28.1.0...v29.0.0

Adyen Node API Library v28.1.0

30 Jul 15:55
60ceb8c

Choose a tag to compare

What's Changed

Balance Platform API:

  • Added support for additionalbankIdentificationRequirement (auBsbCode, caRoutingNumber, gbSortCode or usRoutingNumber)
  • Added approvalExpired ReasonEnum to CreateSweepConfigurationV2, UpdateSweepConfigurationV2 and SweepConfigurationV2

Configuration Webhooks

  • Added usage field - Specifies how many times the card can be used: singleUse or multiUse.
  • Added transactionRulesResult (wallet, cof) in networkTokenNotificationDataV2
  • Added networkTokenRiskRuleData, networkTokenRiskRuleSource, networkTokenTransactionRulesResult and networkTokenTriggeredRiskRule
  • Added approvalExpired to sweepConfigurationV2 webhooks


Transfers API


  • Added approvalExpired to transfer, transferData and transferEvent
  • Added email and url to partyIdentification and ultimatePartyIdentification.

Transfers Webhooks


  • Added email and url fields to partyIdentification
  • Added approvalExpired to transferData and transferEvent.

OpenAPI spec files or templates have been modified on 30-07-2025 by commit.

Other Changes 🖇️

Full Changelog: v28.0.0...v28.1.0

Adyen Node API Library v28.0.0

14 Jul 08:40
188715c

Choose a tag to compare

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:

Read more

v27.0.1

03 Jul 14:08

Choose a tag to compare

Features 💎

  • Terminal API
    • Add NetworkConnected and NetworkDisconnected events in #1519

Adyen Node API Library v27.0.0

14 May 17:21
78f079d

Choose a tag to compare

Breaking Changes 🛠

  • Checkout API

    • Dotpay: Removed the DotpayDetails class and all related references in CheckoutPaymentMethod and test files. Direct support for Dotpay is deprecated
    • Giropay: Removed the GiropayDetails class and all related references in CheckoutPaymentMethod and test files. Direct support for Giropay is deprecated
    • Paysafecard (from PaymentDetails TypeEnum): Removed Paysafecard from the TypeEnum in the PaymentDetails model
  • Classic Payments API

    • In ResponseAdditionalDataCommon the TokenizationStoreOperationTypeEnum.AlreadyStored has been removed, and replaced by TokenizationStoreOperationTypeEnum.AlreadyExisting
  • Management API

    • Remove GiroPayInfo
    • Remove enum PAYSHOP from PaymentMethodResponse

Features 💎

  • Checkout API

    • Rakuten Pay: Add support for Rakuten Pay payment method - RakutenPayDetails
    • Add support for Surcharge in paymentRequest
    • Add Donation type field supporting the following values: roundup, fixedAmounts
    • Add email and phone number fields to AdditionalDataCommon and AdditionalDataSubMerchant
    • Add SubMerchantEmail and SubMerchantPhoneNumber fields to AdditionalDataCommon
    • Add SubMerchantSubSellerSubSellerNrEmail and SubMerchantSubSellerSubSellerNrPhoneNumber fields to AdditionalDataSubMerchant
    • Add RequestedTestAcquirerResponseCode to AdditionalDataCommon to facilitate testing scenarios for specific acquirer responses
    • Add EnhancedSchemeData property to PaymentRequest and PaymentCaptureRequest
    • Add EncryptedCard property to PaymentMethodToStore to allow storing encrypted card details.
    • Add the FraudRiskLevel enum and property to ResponseAdditionalDataCommon to indicate the risk level of a payment (e.g. VeryLow, Low, Medium, High, and VeryHigh)
    • Add Bonus enum member to the PlansEnum in CheckoutSessionInstallmentOption and Installments
  • BalancePlatform API

    • Add Bic enum in BankIdentification
    • Add Pending enum in CreateSweepConfigurationV2
    • Add message field in InvalidField
    • Add replacedById and replacementOfId attributes in PaymentInstrument and UpdatePaymentInstrument
    • Add walletProviderAccountScore and walletProviderDeviceScore attributes in TransactionRuleRestrictions
    • Add class USInstantPayoutAddressRequirement
  • Transfer API

    • Added IssuingTransactionData with captureCycleId that provides the captureCycleId associated with transfer event
    • Add enumChargebackRemainder in PlatformPayment.platformPaymentType
    • Add attribute externalReason in TransferData
    • Add enum Pending in TransferData.reason
    • Add attribute scaOnApproval in TransferReview
  • Management API

    • Add supportEmail field in AfterpayTouchInfo
    • Add enum PAYMENTDESIGNATORCONTRACT in JCBInfo
    • Add PayByBankPlaidInfo
    • Add enum PAYBYBANK_PLAID in PaymentMethodResponse
    • Add domainSuffix field in Profile model
    • In SplitConfigurationRule add enums CHARGED, DEFERRED_DEBIT and PREPAID (#1457)
    • Add enableGratuities in Standalone model

Add support for Balance Webhooks

  • Webhooks

  • Configuration Webhooks

    • Add replacedById to PaymentInstrument
  • AcsWebhooks

    • Enum value has changed:

      • Before: OTP_SMS
      • After: PWD_OTP_PHONE_FL - OTP flow via SMS
    • Enum value has changed:

      • Before: OOB
      • After: OOB_TRIGGER_FL - Out-of-band trigger flow
    • New:

    • Add PWD_OTP_EMAIL_FL - OTP flow via Email

Fixes ⛑️

Other Changes 🖇️

  • NotificationRequestItem enums: Remove legacy by @gcatanese in #1497
  • Set default timeout on the HTTP client by @gcatanese in #1490
  • Introduced a new HMAC troubleshooting utility for signature validation debugging (#1487). The tool calculates the HMAC signature given the HMAC key and the payload:
cd tools/hmac
npm install 

node calculateHmacPayments.js 11223344D785FBAE710E7F943F307971BB61B21281C98C9129B3D4018A57B2EB payload.json

Check the README

New Contributors

Full Changelog: v26.1.0...v27.0.0

Adyen Node API Library v26.1.0

14 Mar 17:28
17b47e8

Choose a tag to compare

What's Changed

Fixes ⛑️

library/pull/1482

Other Changes 🖇️

New Contributors

Full Changelog: v26.0.0...v26.1.0

Adyen Node API Library v26.0.0

04 Mar 09:45
4d51744

Choose a tag to compare

What's Changed

Breaking Changes 🛠

  • Management API:
    • In AndroidApp the field status has changed from String to StatusEnum (Archived, Error, Invalid, Processing, Ready)
  • Management webhooks:
    • In PaymentMethodRequestRemovedNotificationRequest the event type has been renamed to paymentMethodRequest.removed
    • In PaymentMethodScheduledForRemovalNotificationRequest the event type has been renamed to paymentMethodRequest.scheduledForRemoval

New Features 💎

  • Checkout:
    • New payment methods PixDetails and PixRecurring
    • In PaymentRefundResponse add attribute capturePspReference (only available for PayPal refunds)
    • In ResponseAdditionalDataCommon:
      • ⚠️ the recurring_recurringDetailReference and recurring_shopperReference are deprecated, use instead the new attribute tokenization_shopperReference
      • add tokenization_store_operationType and tokenization_storedPaymentMethodId attributes, add TokenizationStoreOperationTypeEnum enum
  • Checkout webhooks:
    • Add TechnicalCancel enum in NotificationRequestItem
  • Management API:
    • Support AffirmInfo and PayToInfo payment methods
    • in Surcharge class add attribuge excludeGratuityFromSurcharge
  • Payout:
    • In ResponseAdditionalDataCommon:
      • ⚠️ the recurring_recurringDetailReference and recurring_shopperReference are deprecated, use instead the new attribute tokenization_shopperReference
      • add tokenization_store_operationType and tokenization_storedPaymentMethodId attributes, add TokenizationStoreOperationTypeEnum enum
  • Classic Payments:
    • In ResponseAdditionalDataCommon:
      • ⚠️ the recurring_recurringDetailReference and recurring_shopperReference are deprecated, use instead the new attribute tokenization_shopperReference
      • add tokenization_store_operationType and tokenization_storedPaymentMethodId attributes, add TokenizationStoreOperationTypeEnum enum

Other Changes 🖇️

New Contributors

Full Changelog: v25.0.0...v26.0.0

Adyen Node API Library v25.0.0

18 Feb 13:35
07f268b

Choose a tag to compare

What's Changed

Breaking Changes 🛠

  • BalancePlatform:
    • Removed PriorityRestriction class.
    • In TransactionRuleRestriction removed priority.
    • In models removed priorityRestriction
  • BinLookup:
    • In CostEstimateResponse removed surchargeType.
  • Transfers:
    • In TransferReview removed numberOfApprovalsCompleted and ScaOnApprovalEnum.
    • In models removed ScaOnApprovalEnum
  • TransferWebhooks:
    • In TransferReview removed numberOfApprovalsCompleted and ScaOnApprovalEnum.
    • In models removed ScaOnApprovalEnum

Features 💎

  • AcsWebhooks:

    • In ChallengeInfo broadening the range of ChallengeCancelEnum.
  • BalancePlatform:

    • Added AssociationDelegatedAuthenticationData, AssociationFinaliseRequest, AssociationFinaliseResponse, AssociationInitiateRequest, AssociationInitiateResponse and TokenRequestorsRestriction class.
    • In TransactionRuleRestriction added tokenRequestors.
    • In models added associationFinaliseRequest, associationFinaliseResponse, associationInitiateRequest and `associationInitiateResponse
  • Checkout:

    • In CardDetails, CardDonations and paymentRequest added fastlaneData.
    • Added FastlaneDetails class.
    • In models added fastlaneDetails
  • LegalEntityManagement:

    • Added FinancialReport class.
    • In LegalEntityAssociation added nominee.
    • In Organization and SoleProprietorship added financialReports
    • In models added financialReport
  • Service:

    • BalancePlatform:
      • Deprecated GrantAccountsApi and GrantOffersApi.
      • In ManageSCADevicesApi added completeAssociationBetweenScaDeviceAndResource and initiateAssociationBetweenScaDeviceAndResource.
    • Transfers:
      • Deprecated CapitalApi.
  • Code generation: update services and models by @AdyenAutomationBot in #1461

Other Changes 🖇️

Full Changelog: v24.0.0...v25.0.0