Adyen Node API Library v27.0.0

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 'Pendingenum inCreateSweepConfigurationV2`
  • 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

  • Add ISSUER_COMMENTS webhook event code by @nickcarenza in #1488

• 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 ⛑️

• Fix null value in User-Agent HTTP header by @gcatanese in #1496
• Fix union types deserialization in Transfer webhooks by @mercury2269 in #1489

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 payaload:

cd tools/hmac
npm install 

node calculateHmacPayments.js 11223344D785FBAE710E7F943F307971BB61B21281C98C9129B3D4018A57B2EB payload.json

Check the README

New Contributors

• @nickcarenza made their first contribution in #1488
• @mercury2269 made their first contribution in #1489

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

Adyen Node API Library v26.1.0

What's Changed

Fixes ⛑️

• Bug: Fixed possdk base replacement URL on LIVE - Previously, the business-logic appended "/checkout" to the LIVE url, this should not be the case when using /possdk/v68 by @ChrisSchofieldCheckatrade in https://github.com/Adyen/adyen-node-api-

library/pull/1482

Other Changes 🖇️

• Add close-issue-label flag to correctly label closed issues by @DjoykeAbyah in #1480
• Release v26.1.0 by @AdyenAutomationBot in #1481

New Contributors

• @ChrisSchofieldCheckatrade made their first contribution in #1482

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

Adyen Node API Library v26.0.0

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

Important

The Recurring API is deprecated. Use the Checkout API recurring endpoints instead.

Other Changes 🖇️

• Expose PosMobileAPI by @victorcuena in #1463
• Improve issue templates by @ayodejidev in #1470
• Create config.yml by @ayodejidev in #1473
• Improve GitHub Node and release workflows by @ayodejidev in #1477
• Add TechnicalCancel Enum by @DjoykeAbyah in #1468
• Fix HMAC validation for Banking webhooks by @gcatanese in #1476
• Release v26.0.0 by @AdyenAutomationBot in #1472

New Contributors

• @victorcuena made their first contribution in #1463

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

Adyen Node API Library v25.0.0

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 🖇️

• Release v25.0.0 by @AdyenAutomationBot in #1469

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

Adyen Node API Library v24.0.0

What's Changed

Breaking Changes 🛠

• Checkout:
  • In additionalDataAirline changed airline_passenger_telephone_number to airline_passenger_phone_number
• Payment:
  • In additionalDataAirline changed airline_passenger_telephone_number to airline_passenger_phone_number
• Code generation: update services and models by @AdyenAutomationBot in #1458

Features 💎

• NegativeBalanceWarningWebhooks:
  • Added Amount class.
  • Added NegativeBalanceCompensationWarningNotificationData class.
  • Added NegativeBalanceCompensationWarningNotificationRequest class.
  • Added ObjectSerializer class.
  • Added Resource class.
  • Added ResourceReference class.
  • Added amount, negativeBalanceCompensationWarningNotificationData, negativeBalanceCompensationWarningNotificationRequest, resource and resourceReference to models
• Payments:
  • In Split added TopUp.

Other Changes 🖇️

• Add NPM publish status badge in README by @gcatanese in #1455
• updated readme with deprecation message for POS Terminal Managament API by @DjoykeAbyah in #1460
• Add negativeBalanceWarningWebhook to bankingWebhookHandler by @DjoykeAbyah in #1459
• Release v24.0.0 by @AdyenAutomationBot in #1456

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.

Full Changelog: v23.3.0...v24.0.0

Adyen Node API Library v23.3.0

What's Changed

New Features 💎

• Checkout:
  • Add AffirmPay payment method
  • Add PayPay payment method
  • Add new enum value TopUp in Split class

Other Changes 🖇️

• Code generation: update services and models by @AdyenAutomationBot in #1450
• GitHub workflows edits by @gcatanese in #1451
• Chore(deps): bump cross-spawn from 7.0.3 to 7.0.6 by @dependabot in #1453
• Release v23.3.0 by @AdyenAutomationBot in #1452

Full Changelog: v23.2.0...v23.3.0

Adyen Node API Library v23.2.0

What's Changed

New Features 💎

• Checkout API (auto-rescue):
  • Added autoRescue in AdditionalDataCommon - Set to true to enable Auto Rescue
  • Added maxDaysToRescue in AdditionalDataCommon - Specify the rescue window for a transaction, in days, when autoRescue is set to true. You can specify a value between 1 and 48.
• Update all services by @AdyenAutomationBot in #1443

Other Changes 🖇️

• Upgrade @types/node: Update to 18.19.69 by @DjoykeAbyah in #1446
• Release v23.2.0 by @AdyenAutomationBot in #1448

Full Changelog: v23.1.0...v23.2.0

Adyen Node API Library v23.1.0

What's Changed

New Features 💎

• BalancePlatform:
  • In models added PriorityRestriction
  • Added PriorityRestriction class.
  • In TransactionRuleRestrictions added priority of type PriorityRestriction.
  • In VerificationDeadline, VerificationError and VerificationErrorRecursive added issueChargeCard, issueChargeCardCommercial , useChargeCard and useChargeCardCommercial enum.
• ConfigurationWebhooks:
  • In VerificationDeadline, VerificationError and VerificationErrorRecursive added issueChargeCard, issueChargeCardCommercial , useChargeCard and useChargeCardCommercial enum.
• LegalEntityManagement:
  • In VerificationDeadline, VerificationError and VerificationErrorRecursive added issueChargeCard, issueChargeCardCommercial , useChargeCard and useChargeCardCommercial enum.
• ReportWebhooks:
  • In ReportNotificationData added id
• Update all services by @AdyenAutomationBot in #1441

Other Changes 🖇️

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.

• Release v23.1.0 by @AdyenAutomationBot in #1442

Full Changelog: v23.0.0...v23.1.0

Adyen Node API Library v23.0.0

What's Changed

Breaking Changes 🛠

• LegalEntityManagament:
  • In Trust removed setTaxAbsent attribute
• Update all services by @AdyenAutomationBot in #1433

New Features 💎

This version of the library introduces 2 significant improvements:

• optional attributes can be set as null: in the previous version it was only possible to omit the attribute.
  For example, an optional attribute is defined as such:

   'contactDetails'?: ContactDetails | null;

• mandatory polymorphic attributes cannot be set as null: in the previous version it was possible to do so.
  For example, a mandatory attribute can be any of the allowed classes, while null is no longer an option:

  'paymentMethod': ApplePayDonations | CardDonations | GooglePayDonations | IdealDonations;

• AcsWebhooks:
  • In AuthenticationNotificationData added timestamp attribute
• BalancePlatform:
  • Added CounterpartyTypesRestriction and SourceAccountTypesRestriction class and import in models
  • Added CounterpartyTypesRestriction and SourceAccountTypesRestriction in transactionRuleRestricton
• Checkout:
  • In CardDetails and CardDonations added encryptedCard attribute and clicktopay enum
  • In Models and PaymentRequest added pseDetails
  • Added pseDetails’ class
• ConfigurationWebhooks:
  • Added timestamp to AccountHolderNotificationRequest, BalanceAccountNotificationRequest, CardOrderNotificationRequest,PaymentNotificationRequest and SweepConfigurationNotificationRequest
• DisputeWebhooks:
  • Added amount, balancePlatformNotificationResponse, disputeEventNotification and disputeNotificationRequest class
  • Added models class with amount, balancePlatformNotificationResponse, disputeEventNotification and disputeNotificationRequest
• LegalEntityManagament:
  • In PCIQuestionnairesApi added calculatePciStatusOfLegalEntity
  • Added CalculatePciStatusRequest, CalculatePciStatusResponse and UnincorporatedPartnership class
  • In LegalEntity added unincorporatedPartnership attribute
  • In LegalEntityAssociation added secondaryPartner and unincorporatedPartnership attributes
  • In LegalEntityInfo and LegalEntityInfoRequiredType added unincorporatedPartnership attribute
  • In models added calculatePciStatusRequest, calculatePciStatusResponse and unincorporatedPartnership
  • In OnboardingLinkSettings added enforceLegalAge attribute
  • In PhoneNumber added phoneCountryCode attribute
  • In Trust added description , businessTrust, charitableTrust, discretionaryTrust and familyTrust attributes
• Management:
  • Added DinersInfo class
  • In JCBINfo changed serviceLevel to optional
  • In models added dinersInfo
  • In PaymentMethod and PaymentMethodSetupInfo replaced import from GenericPmWithTdinfo to DinersInfo
  • In PaymentMethodResponse and PaymentMethodSetupInfo added affirm
  • In TerminalConnectivityCellular added iccid2
  • In UpdatePaymentMethodInfo added storeId
• ManagementWebhooks
  • In models added terminalAssignmentNotificationRequest and terminalAssignmentNotificationResponse
  • Added TerminalAssignmentNotificationRequest and TerminalAssignmentNotificationResponse class
• ReportWebhooks:
  • Added timestamp in ReportNotificationRequest
• Payout:
  • In models added ResponseAdditionalDataCard
  • In ResponseAdditionalDataCard added cardProductId
• TransactionWebhooks:
  • In TransactionNotificationRequestV4 added timestamp attribute
• TransferWebhooks:
  • Added Airline, Leg and MerchantPurchaseData class
  • In models added airline, leg and MerchantPurchaseData
  • In TransferData added eventId, platformPayment and topUp attributes
  • In TransferEvent added eventsData
  • In TransferNotificationRequest added timestamp
• Transfers:
  • Added Airline, Leg and MerchantPurchaseData class
  • In models added leg, airline and MerchantPurchaseData
  • In transfer added platformPayment
  • In transferData added eventId, platformPaymentandtopUp` attributes
  • In transferEvent added eventsData
  • In transferInfo added platformPayment and topUp

Other Changes 🖇️

• Allow nullable for TerminalSettings by @DjoykeAbyah in #1432
• chore(deps): update actions/setup-node action to v4 by @renovate in #1401
• adjust mustache templates by @DjoykeAbyah in #1438
• Update all services by @AdyenAutomationBot in #1440
• Release v23.0.0 by @AdyenAutomationBot in #1434

Full Changelog: v22.1.0...v23.0.0

Adyen Node API Library v22.1.0

What's Changed

New Features 💎

• BalancePlatform
  • In accountHoldersApi, balanceAccountsApi and platformApi using TransactionRulesResponse added getAllTransactionRulesForAccountHolder
  • Added AmountNonZeroDecimalsRequirement class
  • In CreateSweepConfigurationV2, SweepConfigurationV2 and UpdateSweepConfigurationV2 added reasonDetail, a human readable reason for disabling the sweep.
  • Added IbanAccountIdentificationRequirement class
  • In models added AmountNonZeroDecimalsRequirement, IbanAccountIdentificationRequirement and USInternationalAchAddressRequirement
  • In transferRoute added AmountNonZeroDecimalsRequirement, IbanAccountIdentificationRequirement and USInternationalAchAddressRequirement
  • Added USInternationalAchAddressRequirement class
• Checkout
  • Added CheckoutBankAccount
  • In models and paymentRequest added CheckoutBankAccount and RivertyDetails
  • In paymentMethodsRequest added shopperConversionId
  • Added RivertyDetails class
• ConfigurationWebhooks
  • In SweepConfigurationV2 added reasonDetail and refusedByCustomer
• TransferWebhooks
  • In transferData and transferEvent added refusedByCustomer
• Transfers
  • In transfer and transferData added refusedByCustomer
• Update all services by @AdyenAutomationBot in #1428

Other Changes 🖇️

• Add minimum required release age by @ayodejidev in #1429
• Release v22.1.0 by @AdyenAutomationBot in #1430

New Contributors

• @ayodejidev made their first contribution in #1429

Full Changelog: v22.0.0...v22.1.0