Adyen Node API Library v29.0.0

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

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

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