Skip to content

Releases: Adyen/adyen-node-api-library

Release list

Adyen Node API Library v32.1.0

Adyen Node API Library v32.1.0 Latest
Latest

Choose a tag to compare

View all tags
@AdyenAutomationBot AdyenAutomationBot released this 03 Sep 08:31
v32.1.0
afd3bb4

What's Changed

This release adds Checkout session updates and richer payment, travel, lodging, and enhanced-scheme models; introduces the Document Collector API with multipart file uploads; and exposes Session Authentication types. It also removes obsolete Checkout error models and two deprecated payment-method enum values.

New Features 💎

Checkout API

  • Add PaymentsApi.updateSession(sessionId, checkoutSessionPatchSessionRequest, requestOptions?) with CheckoutSessionPatchSessionRequest, CheckoutSessionPatchSessionResponse, and SessionAmountUpdate to update a session's amount and payable state. (#1735)
  • Add AuPayDetails, DBaraiDetails, and SepaDirectDebitDonations, including their TypeEnum values, and update discriminator mappings for payment methods and response actions. (#1735)
  • Add enhanced-scheme models CarRental, PickupInfo, RentalSurcharges, ReturnInfo, Healthcare, Lodging, Folio, Room, and TemporaryServices; expose them through EnhancedSchemeData.carRental, healthcare, lodging, and temporaryServices. (#1735)
  • Add ThirdPartyTokenRedundancyInfo with requestParameters and requestTemplateCode; expose it on CreateCheckoutSessionRequest, CreateCheckoutSessionResponse, and PaymentRequest, and add CreateCheckoutSessionRequest.shopperConversionId. (#1735)
  • Add LineItem.returnShippingCompany, returnTrackingNumber, returnTrackingUri, shippingCompany, shippingMethod, trackingNumber, and trackingUri; add PaypalUpdateOrderRequest.deliveryAddress, discountAmount, and shippingAmount. (#1735)
  • Add AffirmDetails.financingProgram, CardBrandDetails.healthcare, DonationCampaignsRequest.label, KlarnaDetails.merchantData, RivertyDetails.merchantData, and StoredPaymentMethod.externalToken. (#1735)
  • Make SepaDirectDebitDetails.iban and SepaDirectDebitDetails.ownerName optional. (#1380) (#1735)

Document Collector API

Payment API

  • Add transactionLinkId to AdditionalDataCommon and ResponseAdditionalDataCommon. (#1738)

Fixes ⛑️

  • Export the Types.sessionAuthentication namespace so request and response models used by SessionAuthenticationAPI are available from the public package entry point. (#1751) (#1760)
  • Update the Banking webhook HMAC README example to use validateHMACSignature(hmacKey, hmacSignature, data) instead of the deprecated, misleading call. (#1744)

Notes

Few unused attributes have been removed:

  • Remove Types.checkout.DefaultErrorResponseEntity, its constructor(), and its serialized properties detail, errorCode, instance, invalidFields, requestId, status, title, and type. (#1735)
  • Remove Types.checkout.InvalidField, its constructor(), and its serialized properties message, name, and value. (#1735)
  • Remove Types.checkout.PaymentDetails.TypeEnum.Paybright and move the gopay_wallet value from Types.checkout.PaymentDetails.TypeEnum.GopayWallet to Types.checkout.StoredPaymentMethodDetails.TypeEnum.GopayWallet. (#1735)

Contributor Notes 🔧

  • Add form-data 4.0.6 as a runtime dependency and reusable multipart and URL-encoded request helpers; update the generated API template for file uploads. (#1761)
  • Patch transitive security-sensitive dependencies: fast-uri 3.1.5, brace-expansion 1.1.18, ajv 6.15.0, js-yaml 3.15.1/4.3.1, and an override for micromatch 4.0.8. (#1753) (#1754) (#1755) (#1756) (#1757)
  • Update contributor tooling: eslint-plugin-unused-imports 4.x, ts-loader 9.6.2, and acorn 8.17.0. (#1402) (#1646) (#1724)
  • Update release, stale, and Node setup actions, and improve the SonarCloud scanner configuration. (#1719) (#1722) (#1723) (#1752)
  • Remove redundant generated void statements so SDK Automation can continue removing unused imports. (#1779)

Other Changes 🖇️

  • Add a SaleToAcquirerData.additionalData usage example, fix the classic Platforms API documentation link, and list Document Collector API v1 in the supported APIs table. (#1741) (#1743) (#1782)

PRs 📋️

Read more
Assets 2
Loading

Adyen Node API Library v32.0.0

Adyen Node API Library v32.0.0

Choose a tag to compare

View all tags
@AdyenAutomationBot AdyenAutomationBot released this 15 Jul 09:40
v32.0.0
99d1a0c

What's Changed

✨ This release introduces the support of Checkout API v72 and Cloud device API, a first-class replacement for the legacy TerminalCloudAPI that brings built-in Nexo message encryption, device management, and a cleaner service design.

Breaking Changes 🛠

Checkout API

There are several breaking changes during the Checkout v72 upgrade, check #1727 for the full details

  • inDirectDebitAuDetails class holderName is now required (was optional). Consumers must always provide this field.
  • donationType is now optional and deprecated. Use type instead.
  • in DonationPaymentRequest several fields are removed : additionalData, conversionId deliverAt, threeDSAuthenticationOnly (this was deprecated since Checkout API v69, use authenticationData.authenticationOnly.
  • in PaymentAmountUpdateRequest has been removed enhancedSchemeData. Use the new mpiData field instead.
  • in PaymentRequest conversionId was removed (deprecated since Checkout API v68, use checkoutAttemptId).
  • in StandalonePaymentCancelRequest attribute enhancedSchemeData was removed.

Transfers API

  • Counterparty model removed and replaced by GrantCounterparty (used in CapitalGrant) and GrantInfoCounterparty (used in CapitalGrantInfo), with different field sets for each context. See #1634

New Features 💎

Checkout API

  • In PaymentAmountUpdateRequest add adjustAuthType field (PaymentAmountUpdateRequest.AdjustAuthTypeEnum). Possible values: cardholderInitiatedTransaction, merchantInitiatedTransaction.
  • New adjustAuthorisationData field (string) for synchronous authorization adjustments.
  • New mpiData field (ThreeDSecureData) replacing enhancedSchemeData.

Cloud Device API

Two new services replace the deprecated TerminalCloudAPI:

  • cloudDeviceApi — Send synchronous and asynchronous Terminal API messages, query connected devices and device status.
  • encryptedCloudDeviceApi — Variant of cloudDeviceApi with built-in Nexo message encryption/decryption. Requires EncryptionCredentialDetails information.
    New supporting security classes: nexoSecurityManager, nexoCryptoPrimitives, nexoDerivedKeyGenerator, nexoSecurityException, encryptionCredentialDetails.

It includes documentation:

Transfers API

  • Add CashOutApi for initiating cashouts.
  • Add transfer tracing models and fields for UK FPS and US ACH.
  • Add NetworkReason, InterchangeData, and UltimatePartyIdentification.

Fixes

  • Fix ESM-compatible NexoCrypto exports and safely handle differing HMAC lengths. #1701 (#1701)
  • Correct webhook HMAC validation and discriminator mappings for webhook bank-account models.
  • Update ESLint, Nock, and CI actions for Node.js 24 compatibility.

PRs.

New Contributors

Full Changelog: v31.0.0...v32.0.0

Contributors

gcatanese, AdyenAutomationBot, and CedricConday
Loading

Adyen Node API Library v31.0.0

Adyen Node API Library v31.0.0

Choose a tag to compare

View all tags
@AdyenAutomationBot AdyenAutomationBot released this 23 Jun 11:39
v31.0.0
d475263

Breaking Changes 🛠

Balance Platform API

  • Move sweep-related methods from BalanceAccountApi to CustomPayoutSchedulesSweepsApi (#1637)

Capital API

  • Make accountHolderId parameter required in grantOffersApi.getAllGrantOffers (#1641)
  • Change AdditionalBankIdentification.type attribute type from AdditionalBankIdentificationTypes to AdditionalBankIdentification.TypeEnum (#1641)

Checkout API

  • Remove alma enum value from PaymentDetails.TypeEnum in favour of the new AlmaDetails model (#1644)

Management API

  • Change getApplePayDomains return type from ApplePayInfo to ApplePayResponseInfo (#1629)
  • Introduce dedicated read-only *ResponseInfo and update-only *UpdateInfo types for 40+ payment methods; operations using UpdatePaymentMethodInfo now require different types (#1629)

New Features 💎

Configuration Webhooks

  • Add support for Payout Schedule webhook events (balancePlatform.balanceAccountPayoutSchedule.created, balancePlatform.balanceAccountPayoutScheduleExecution.succeeded, etc.) (#1643)
    • Add AccountPayoutAutoApplicationNotificationRequest and AccountPayoutAutoApplicationWebhookData models
    • Add PayoutStateWebhookData, AccountPayoutConfigWebhookData, and PlatformPayoutConfigWebhookData models
    • Add UKLocalMandateAccountIdentification model

Legal Entity Management API

  • Add optional industryCodeDescription property to BusinessLine, BusinessLineInfo, and BusinessLineInfoUpdate models (#1650)
  • Add optional bic property to IbanAccountIdentification for BIC/SWIFT code support (#1650)
  • Update LegalEntityAssociation to support immediateParentCompany relation for organizations (#1650)

Payment API

  • Add enum values Refused and Error to ModificationResult (#1636)
  • Add cardAltID attribute to ResponseAdditionalDataCard (#1636)
  • Change cardProductId type to string in ResponseAdditionalDataCard (#1636)
  • Add networkProcessingMode attribute to ResponseAdditionalDataCommon (#1636)
  • Add enum values AMBER and RED to ResponseAdditionalDataCommon.FraudResultType (#1636)

Payout API

  • Add cardAltID attribute to ResponseAdditionalDataCard (#1639)
  • Change cardProductId type to string in ResponseAdditionalDataCard (#1639)
  • Add networkProcessingMode attribute to ResponseAdditionalDataCommon (#1639)
  • Add enum values AMBER and RED to ResponseAdditionalDataCommon.FraudResultType (#1639)

Recurring API

  • Add transactionLinkId attribute to RecurringDetail (#1628)

Transaction Webhooks

  • Add oneOf discriminator mapping to TransferViewCategoryDataClass for correct deserialization of categoryData in TransferView (#1655)
  • Update processingType field description in IssuedCard to enumerate all possible values (#1655)

Transfer Webhooks

  • Add enum values AdviceAuthorised, AdviceRefused, and InterchangeAdjusted to StatusEnum across TransferData, TransferEvent, and Modification (#1630)
  • Add ultimateParty field to TransferData referencing the new UltimatePartyIdentification model (#1630)
  • Add discriminator mappings to BankAccountV3AccountIdentificationClass for polymorphic deserialization (#1630)
  • Add InterchangeData model and interchangeData field to IssuedCard (#1630)

Fixes ⛑️

  • Fix serialization and deserialization of Set<T> types in ObjectSerializer; Set<Resource> and Set<string> fields previously fell through to an unmatched typeMap lookup and returned raw Set objects (#1660)
  • Fix standalone enum registration in ObjectSerializer.enumsMap to use type name strings (e.g. "Result") instead of runtime values (e.g. 'VALID'), ensuring correct serialization of top-level export enum types (#1664)
  • Export NexoCrypto from package index #1701

PRs

Read more

Contributors

gcatanese, AdyenAutomationBot, and 2 other contributors
Loading

Adyen Node API Library v30.1.0

Adyen Node API Library v30.1.0

Choose a tag to compare

View all tags
@AdyenAutomationBot AdyenAutomationBot released this 30 Jan 09:18
v30.1.0
9b76575
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

New Features 💎

This release adds support for:

Checkout API

Added the sdkData property to all payment methods (i.e. AchDetails, AffirmDetails, etc..)

applePayDetails.ts

  • New enum value Prepaid was added to FundingSourceEnum.

applePayDonations.ts

  • New enum value Prepaid was added to FundingSourceEnum.

cardDetails.ts

  • New property billingSequenceNumber?: string; was added.
  • New enum value Prepaid was added to FundingSourceEnum.

cardDonations.ts

  • New property billingSequenceNumber?: string; was added.
  • New enum value Prepaid was added to FundingSourceEnum.

checkoutBankTransferAction.ts

  • New property bankCode?: string; was added.
  • New property branchCode?: string; was added.

donationPaymentRequest.ts

  • Property paymentMethod was made optional.

enhancedSchemeData.ts

  • New property levelTwoThree?: LevelTwoThree | null; was added.

externalTokenDetails.ts

  • externalTokenDetails.ts is a new file.

genericIssuerPaymentMethodDetails.ts

  • New enum value OnlinebankingIn was added to TypeEnum.

googlePayDetails.ts

  • New enum value Prepaid was added to FundingSourceEnum.

googlePayDonations.ts

  • New enum value Prepaid was added to FundingSourceEnum.

itemDetailLine.ts

  • itemDetailLine.ts is a new file.

masterpassDetails.ts

  • New enum value Prepaid was added to FundingSourceEnum.

payWithGoogleDetails.ts

  • New enum value Prepaid was added to FundingSourceEnum.

payWithGoogleDonations.ts

  • New enum value Prepaid was added to FundingSourceEnum.

payment.ts

  • New enum values Received and Pending were added to ResultCodeEnum.

paymentDetails.ts

  • Enum values Neteller, OnlinebankingIn, Moneybookers were removed from TypeEnum.

paymentDetailsResponse.ts

  • Add property paymentValidations

paymentMethod.ts

  • New enum value Prepaid was added to FundingSourceEnum.

paymentRequest.ts

  • New property paymentValidations?: PaymentValidations | null; was added.
  • New property shopperTaxInfo?: ShopperTaxInfo | null; was added.

paymentRequestPaymentMethod.ts

  • ExternalTokenDetails was added to the type union.

paymentResponse.ts

  • New property paymentValidations?: PaymentValidationsResponse | null; was added.

responseAdditionalDataCommon.ts

  • New enum values Amber and Red were added to FraudResultTypeEnum and Fraud was removed.

responseAdditionalDataSepa.ts

  • New property sepadirectdebit_sepadirectdebit_dueDate?: string; was added.

samsungPayDetails.ts

  • New enum value Prepaid was added to FundingSourceEnum.

sepaDirectDebitDetails.ts

  • New property dueDate?: string; was added.

shopperTaxInfo.ts

  • shopperTaxInfo.ts is a new file.

storedPaymentMethodDetails.ts

  • New enum values AlipayPlus, AlipayPlusAlipayCn, AlipayPlusAlipayHk, AlipayPlusDana, AlipayPlusGcash, AlipayPlusKakaopay, AlipayPlusKplus, AlipayPlusNaverpay, AlipayPlusRabbitlinepay, AlipayPlusTosspay, AlipayPlusTouchngo, AlipayPlusTruemoney were added to TypeEnum.

storedPaymentMethodResource.ts

  • New property cardBin?: string; was added.
  • New property mandate?: TokenMandate | null; was added.

tokenMandate.ts

  • tokenMandate.ts is a new file.

visaCheckoutDetails.ts

  • New enum value Prepaid was added to FundingSourceEnum.

weChatPayMiniProgramDetails.ts

  • New property recurringDetailReference?: string; was added.
  • New property storedPaymentMethodId?: string; was added.

Legal Entity Management

Balance Platform API

Note

In SweepConfigurationV2, CreateSweepConfigurationV2 and UpdateSweepConfigurationV2 several enum values have been deleted (ApprovalExpired, BalanceAccountTemporarilyBlockedByTransactionRule, Declined, etc..), however those values were never delivered or used.

⚠️ Removing of unused attributes
Several attributes (cardCaptureTechnology, deviceName, imei, isoDeviceType, msisdn, osVersion, paymentTypes, serialNumber, storageTechnology) have been removed DeviceInfo: this is NOT considered a breaking change since those attributes were never included in the API response

Transfers API

  • Add attribute storedPaymentMethodId in BankAccountV3
  • Add enum value DccMarkup in platformPayment
  • Add attribute fundingInstrument in UltimatePartyIdentification
  • Add several enum values in TransferData, TransferDataCategoryData, TransferEvent

Payout API

  • In ResponseAdditionalDataSepa add attribute sepadirectdebit_sepadirectdebit_dueDate

Management API

  • Add support for GivexInfo, Moto, ValuelinkInfo, SvsInfo
  • Add new property pricePlan in AffirmInfo
  • Add new enum AffirmInfo.PricePlanEnum with values Bronze, Silver, Gold.
  • Add forceRebootDetails in scheduleTerminalActionsRequestActionDetails
  • Add enums BlikPos, Givex, KlarnaB2b, Svs, Valuelink inPaymentMethodResponse, PaymentMethodSetupInfo
  • Add property localizedInformation in Store
  • Add property localizedInformation in Store, StoreCreationRequest, StoreCreationWithMerchantCodeRequest

terminal.ts

  • New property installedAPKs?: Array<InstalledAPKs>; was added.

Classic Payments API

  • Add enum value Prepaid in PaymentRequest.FundingSourceEnum
  • Add property sepadirectdebit_sepadirectdebit_dueDate in responseAdditionalDataSepa

Configuration Webhooks

  • Add attribute name in BulkAddress
  • Make optional attribute number in Card

Note

In SweepConfigurationV2 several enum values have been deleted (ApprovalExpired, Declined, etc..), however those values were never delivered or used.

Transfer Webhooks

  • Add attribute storedPaymentMethodId in BankAccountV3
  • Add enum DccMarkup in PlatformPayment
  • Add several enum values in TransferData, TransferDataCategoryData, TransferEvent

Transaction Webhooks

  • Add enum DccMarkup in PlatformPayment

Fixes ⛑️

  • Pin GitHub Actions to immutable commit SHAs by @Copilot in #1585
  • fix: secure workflows with pinned actions and npm ci by @Copilot in #1590
  • Fix: correct handling on LIVE prefix by @gcatanese in #1617
  • Secure NPM publishing workflow against supply chain attacks by @Copilot in #1588

PRs 🖇️

Read more

Contributors

gcatanese, jeandersonbc, and 2 other contributors
Loading

Adyen Node API Library v30.0.2

Adyen Node API Library v30.0.2

Choose a tag to compare

View all tags
@gcatanese gcatanese released this 26 Jan 10:54
v30.0.2
7159525

Release Notes: v30.0.2

Fixes ⛑️

  • Corrected liveEndpointUrlPrefix validation logic. The prefix is now strictly required only for Live environment calls to pal- and checkout- services, preventing unnecessary errors for other service types.

Other Changes 🖇️

  • Significantly increased unit testing within service.spec.ts.

Full Changelog: v30.0.1...v30.0.2

Loading

Adyen Node API Library v30.0.1

Adyen Node API Library v30.0.1

Choose a tag to compare

View all tags
@AdyenAutomationBot AdyenAutomationBot released this 21 Nov 11:16
v30.0.1
2e88925
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

Fixes ⛑️

Session Authentication API

Other Changes 🖇️

New Contributors 🎉

Full Changelog: v30.0.0...v30.0.1

Contributors

gcatanese, AdyenAutomationBot, and benjamin-deutsch-swap
Loading

Adyen Node API Library v30.0.0

Adyen Node API Library v30.0.0

Choose a tag to compare

View all tags
@AdyenAutomationBot AdyenAutomationBot released this 16 Oct 06:47
v30.0.0
f8743c2
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

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

Contributors

gcatanese, 0xflotus, and AdyenAutomationBot
Loading

Adyen Node API Library v29.1.0

Adyen Node API Library v29.1.0

Choose a tag to compare

View all tags
@AdyenAutomationBot AdyenAutomationBot released this 05 Sep 08:06
v29.1.0
ef3387d
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Critical Fix ⛑️

New Features 💎

Terminal API

Other Changes 🖇️

New Contributors

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

Contributors

gcatanese, naseemkullah, and AdyenAutomationBot
Loading

Adyen Node API Library v29.0.0

Adyen Node API Library v29.0.0

Choose a tag to compare

View all tags
@AdyenAutomationBot AdyenAutomationBot released this 18 Aug 15:47
v29.0.0
6b76dac
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

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

Contributors

AdyenAutomationBot
Loading

Adyen Node API Library v28.1.0

Adyen Node API Library v28.1.0

Choose a tag to compare

View all tags
@AdyenAutomationBot AdyenAutomationBot released this 30 Jul 15:55
v28.1.0
60ceb8c
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

Breaking Changes 🛠

Balance Platform API:

  • Rename method createNetworkTokenActivationData to createNetworkTokenProvisioningData in PaymentInstrumentsApi

New Features 💎

Checkout API:

  • Add attribute enhancedSchemeData to PaymentAmountUpdateRequest, PaymentCancelRequest, PaymentRefundRequest, PaymentReversalRequest, StandalonePaymentCancelRequest`
  • Add enum Payme and PaymePos in PaymentDetails
  • add attribute promoted in PaymentMethod
  • add attribute subtype in RivertyDetails

Balance Platform API:

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


Configuration Webhooks

  • Added usage field in Card
  • Added attributetransactionRulesResult in NetworkTokenNotificationDataV2
  • Added networkTokenRiskRuleData, networkTokenRiskRuleSource, networkTokenTransactionRulesResult and networkTokenTriggeredRiskRule
  • Added enum approvalExpired to SweepConfigurationV2


Tokenization Webhooks

  • Added TokenizationAlreadyExistingDetailsNotificationRequest, TokenizationCreatedDetailsNotificationRequest, TokenizationDisabledDetailsNotificationRequest, TokenizationUpdatedDetailsNotificationRequest

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

Contributors

AdyenAutomationBot
Loading