Adyen Java API Library v40.0.0

This release introduces major improvements, including support for LEM v4 and an updated Client setup.
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 #1542

🛠 Breaking Changes

Client Setup

The Client class has been updated to enforce best practices and remove deprecated methods.

You can now configure the client using the Config object for a cleaner and more consistent setup:

// setup using Config object
Config config = new Config()
    .environment(Environment.LIVE)
    .liveEndpointUrlPrefix("myCompany")
    .apiKey(apiKey);
Client client = new Client(config);

Several several legacy methods, deprecated already for 4-5 years, have been removed. See more details here #1525

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;

💎 New Features

Checkout API

• In PaymentRequest add attribute sdkData

Recurring API

• In Recurring add enum values EXTERNAL and ONECLICK_RECURRING

Management API

• Add CardRegionEnum enums in SplitConfigurationRule class

Other Changes 🖇️

• Add api-library-maintainers to CODEOWNERS by @gcatanese in #1572
• Improve POSSDK live endpoint construction by @gcatanese in #1570
• Terminal API test by @gcatanese in #1573
• Release v40.0.0 by @AdyenAutomationBot in #1569

Full Changelog: v39.5.0...v40.0.0

Adyen Java API Library v39.5.0

New Features 💎

Checkout API

• Add support for UPI QR Code
• In PaymentDetails add enum IRIS
• In UpiIntentDetails add attribute billingSequenceNumber

Classic Payments

• In Recurring add enum values EXTERNAL and ONECLICK_RECURRING

Payout API

• Add ResponseAdditionalDataSwish

Terminal API

• Validate location header upon 308 response status #1561
• Update the validation of Common Name of a Terminal API certificate #1564

Management API

• Add enum value BR_SCHEMES in PaymentMethodResponse and PaymentMethodSetupInfo

Management Webhooks

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

PRs 🖇️

• Validate location header 308 by @gcatanese in #1561
• Code generation: update services and models by @AdyenAutomationBot in #1560

Fixes ⛑️

• TerminalCommonNameValidator: Update validation regex by @gcatanese in #1564

Other Changes 🖇️

• Code generation: update services and models by @AdyenAutomationBot in #1563
• Code generation: update services and models by @AdyenAutomationBot in #1565
• Release v39.5.0 by @AdyenAutomationBot in #1562

Full Changelog: v39.4.0...v39.5.0

Adyen Java API Library v39.4.0

New Features 💎

Add support for Open Banking API v1: it provides secure endpoints to share financial data and services with third parties. This API offers quick and reliable user verification.

Checkout API

• Add bankTransfer enum value in PaymentDetails

Balance Platform

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

Legal Entity Management (v3)

• In Organization add dateOfInitiationOfLegalProceeding, economicSector, globalLegalEntityIdentifier, etc..
• In Organization add enums InstitutionalSectorEnum and StatusOfLegalProceedingEnum

Classic Payments

• Add ResponseAdditionalDataSwish

Transfer API

• Add enum valueAccepted in ConfirmationTrackingData

Configuration Webhooks

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

Transfer Webhooks

• Add enum valueAccepted in ConfirmationTrackingData

Dispute Webhooks

• Add other enum value in DisputeEventNotification

PRs 🖇️

• Code generation: update services and models by @AdyenAutomationBot in #1552
• Code generation: update services and models by @AdyenAutomationBot in #1557
• Add Open Banking API by @gcatanese in #1558

Other Changes 🖇️

• Improve test code and snippets by @gcatanese in #1553
• Add test with idempotency key by @gcatanese in #1555
• Javadoc improvements by @gcatanese in #1556
• Release v39.4.0 by @AdyenAutomationBot in #1554

Full Changelog: v39.3.0...v39.4.0

Adyen Java API Library v39.3.0

New Features 💎

Balance Platform API:

• Add support USInternationalAchPriorityRequirement

Checkout API:

• Add support for PayToPaymentMethod and UPIPaymentMethod
• Add support for validateShopperId utility to validate the shopper id
• Add enum RIVERTY_INSTALLMENTS in RivertyDetails
• Add action attribute (PaymentDetailsResponseAction) in PaymentDetailsResponse
• Add encryptedPassword attribute in CardDetails
• Add ResponseAdditionalDataSwish

Configuration Webhooks

• Add support for ScoreNotification webhook

Management API

• Add support for SepaDirectDebitInfo
• Add unreferenced attribute in Refunds

Session Authentication API

• Add Bank enum value to ProductType

Terminal API

• Introduce PredefinedContentHelper for managing Display Events #1546
• Add ScanBarcodeResult event type #1549

Fixes ⛑️

• Deserialization of bccm payment method by @gcatanese in #1539
• Correct OneOf deserialization by @gcatanese in #1543

PRs

• Code generation: update services and models by @AdyenAutomationBot in #1529
• Code generation: update services and models by @AdyenAutomationBot in #1533
• Code generation: update services and models by @AdyenAutomationBot in #1536
• Code generation: update services and models by @AdyenAutomationBot in #1540
• TerminalAPI: PredefinedContentHelper for managing Display Events by @gcatanese in #1546
• Code generation: update services and models by @AdyenAutomationBot in #1545
• Improve generated code in JSON class by @gcatanese in #1522
• Code generation: update services and models by @AdyenAutomationBot in #1537
• Add TestPixActionQrCode by @gcatanese in #1541
• Implement stricter oneOf deserialization by @AdyenAutomationBot in #1544
• Set workflow permissions by @gcatanese in #1547
• Add ScanBarcodeResult event type by @gcatanese in #1549
• Release v39.3.0 by @AdyenAutomationBot in #1532

Full Changelog: v39.2.0...v39.3.0

Adyen Java API Library v39.2.0

What's Changed

Balance Platform API:

• Added support for AdditionalbankIdentificationRequirement: auBsbCode, caRoutingNumber, gbSortCode or usRoutingNumber.

• Added usage field to Card and CardInfo to specify how many times the card can be used: singleUse or multiUse.
• Added approvalExpired ReasonEnum to CreateSweepConfigurationV2, UpdateSweepConfigurationV2 and SweepConfigurationV2


Configuration Webhooks


• Added usagefield to specify how many times the card can be used: singleUse or multiUse.
• Added transactionRulesResult in NetworkTokenNotificationDataV2
• Added NetworkTokenRiskRuleData, NetworkTokenRiskRuleSource and NetworkTokenTriggeredRiskRule
• Added approvalExpired to SweepConfigurationV2 Webhook


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

Other Changes 🖇️

• Code generation: update services and models by @AdyenAutomationBot in #1527
• Release v39.2.0 by @AdyenAutomationBot in #1528

Full Changelog: v39.1.0...v39.2.0

Adyen Java API Library v39.1.0

Checkout API

• Add attribute enhancedSchemeData (Enhanced scheme data that may be required for processing the payment) in PaymentAmountUpdateRequest, PaymentCancelRequest, PaymentRefundRequest, PaymentReversalRequest, StandalonePaymentCancelRequest
• Add enum values Payme and PaymePos in PaymentDetails
• Add attribute promoted in PaymentMethod
• Add attribute subtype in RivertyDetails

Tokenization Webhooks

Add support for Tokenization Webhooks:

• recurring.token.alreadyExisting
• recurring.token.created
• recurring.token.disabled
• recurring.token.updated

What's Changed

New Features 💎

• Add Tokenization webhooks by @gcatanese in #1520

Other Changes 🖇️

• Add Tokenization webhooks to README by @gcatanese in #1523
• Code generation: update services and models by @AdyenAutomationBot in #1524
• Release v39.1.0 by @AdyenAutomationBot in #1521

Full Changelog: v39.0.0...v39.1.0

Adyen Java API Library v39.0.0

What's Changed

The release brings several improvements around model robustness and backward compatibility with evolving API schemas:

• Improved enum deserialisation: unknown enum values in API responses and webhooks are set as null instead of throwing exceptions #1514
• Attributes with default values are now excluded from serialised API requests unless explicitly set, reducing redundant payloads and relying on the API implementation to manage default values #1517

Check below Breaking Changes 🛠 and New Features 💎

Breaking Changes 🛠

LEM API

• In LegalEntity the capabilities map is no longer readonly: the LegalEntity constructor has been modified, removing the capabilities parameter:

   public LegalEntity(
      @JsonProperty(JSON_PROPERTY_ID) String id,
      @JsonProperty(JSON_PROPERTY_TRANSFER_INSTRUMENTS)
          List<TransferInstrumentReference> transferInstruments,
      @JsonProperty(JSON_PROPERTY_VERIFICATION_DEADLINES)
          List<VerificationDeadline> verificationDeadlines)

Transfers API

• In TransactionsApi the signature of the method getAllTransactions has changed. It has a new parameter sortOrder:

  TransactionSearchResponse getAllTransactions(
      String cursor, OffsetDateTime createdSince, OffsetDateTime createdUntil,
         String sortOrder, Integer limit, RequestOptions requestOptions)
      throws ApiException, IOException 

• In TransfersApi the signature of the method getAllTransfers has changed. It has a new parameter sortOrder:

  FindTransfersResponse getAllTransfers(
      String cursor, OffsetDateTime createdSince, OffsetDateTime createdUntil,
         String sortOrder, Integer limit, RequestOptions requestOptions)
      throws ApiException, IOException 

Management API

• Remove enum class RegionalityEnum in SplitConfigurationRule
• In UpdateSplitConfigurationRuleRequest remove attribute regionality

New Features 💎

BalancePlatform API

• 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

Transfers API

• In AdditionalBankIdentification add new enums auBsbCode and caRoutingNumber
• In IssuedCard add new attribute threeDSecure
• In Transfer add new attribute createdAt, deprecate creationDate (use instead createdAt)
• In TransferData add new attribute createdAt and updatedAt, deprecate creationDate (use instead createdAt)

Management API

• Add support for AlipayPlus and MaestroUsa payment methods: see PaymentMethod and PaymentMethodSetupInfo classes
• In PaymentMethodResponse, PaymentMethodSetupInfo and UpdatePaymentMethodInfo several TypesWithErrorsEnum enums have been added (alipay_plus, avancard, cooper, etc..

ACS Webhooks

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

Transaction Webhooks

• In IssuedCard add new attribute threeDSecure

Transfer Webhooks

• In IssuedCard add new attribute threeDSecure
• In TransferData add new attribute createdAt and updatedAt, deprecate creationDate (use instead createdAt)

PRs 🖇️

• PaymentsApp API unit tests by @gcatanese in #1509
• Improve testing by @gcatanese in #1511
• Handling unknown enum values by @gcatanese in #1514
• Code generation: update services and models by @AdyenAutomationBot in #1515
• Code generation: update services and models by @AdyenAutomationBot in #1516
• [Checkout] Skip serialisation of attributes with default values by @gcatanese in #1517
• [All APIs] Skip serialisation of attributes with default values by @AdyenAutomationBot in #1518
• Release v39.0.0 by @AdyenAutomationBot in #1510

Full Changelog: v38.3.0...v39.0.0

Adyen Java API Library v38.3.0

What's Changed

New Features 💎

BalancePlatform API

• Add new service AuthorizedCardUsersApi to manage (add, get, delete and update) authorized users to a given card
• In GetTaxFormResponse add optional parameter legalEntityId
• Add NetworkTokenRequestor to NetworkToken
• Add dataMissing enum to VerificationError

Checkout API

• Add capturePspReference to PaymentRefundRequest
• Add businessDayOnly to PixRecurring

Management API

• In SplitConfigurationRule add regionality attribute and RegionalityEnum with the supported values
• In UpdateSplitConfigurationRuleRequest add regionality attribute
• In Store, StoreCreationRequest, UpdateStoreRequest and StoreCreationWithMerchantCodeRequest add attribute subMerchantData

Configuration Webhooks

• Add NetworkTokenRequestor to NetworkTokenNotificationDataV2
• In Wallet the RecommendationReasonsEnum includes several new enums: cardholderPanAssociatedToAccountWithinThresholdDays, changesMadeToAccountDataWithinThresholdDays, deviceProvisioningLocationOutsideOfCardholdersWalletAccountHomeCountry , etc..

Note RecommendationReasonsEnum.type is deprecated: use instead name of the tokenRequestor

Other Changes 🖇️

• Maven Publishing Plugin: update configuration by @gcatanese in #1505
• Maven publish: configure deploymentName by @gcatanese in #1507
• fix(deps): update dependency commons-codec:commons-codec to v1.18.0 by @renovate in #1351
• Release v38.3.0 by @AdyenAutomationBot in #1506

Full Changelog: v38.2.0...v38.3.0

Adyen Java API Library v38.2.0

What's Changed

New Features 💎

• Terminal API
  • Add new Event Types NetworkConnected and NetworkDisconnected

Other Changes 🖇️

• Improve code format using Spotless Maven Plugin #1488
• Code generation: update services and models by @AdyenAutomationBot in #1496
• fix(deps): update dependency io.swagger.core.v3:swagger-annotations to v2.2.30 by @renovate in #1349
• TransferWehooks: add test by @gcatanese in #1500
• README: add Session Authentication API by @gcatanese in #1504
• Migration to Maven Central Portal by @gcatanese in #1503
• Release v38.2.0 by @AdyenAutomationBot in #1495

Full Changelog: v38.1.0...v38.2.0

Adyen Java API Library v38.1.0

What's Changed

New Features 💎

Checkout API

• 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

LEM API

* Add enum `KYCONINVITE` (KYC On Invite) in `TermsOfService`

BalancePlatform API

* Add `walletProviderDeviceType` in `TransactionRuleRestrictions`
* Add enum `INTEREST` in `TransferRoute.CategoryEnum`

Transfer API

* Add attribute `executionDate ` in `Transfer`, `TransferData` and `TransferInfo`

BalancePlatform Webhooks

* Added new webhook events `balancePlatform.networkToken.created` and `balancePlatform.networkToken.updated` to support notifications when [Network Tokens are created or updated](https://docs.adyen.com/api-explorer/balanceplatform-webhooks/2/post/balancePlatform.networkToken.created).

Transfer Webhooks

* Add attribute `executionDate ` in `TransferData`

Other Changes 🖇️

• Remove old Mustache templates by @gcatanese in #1491
• Improve Javadoc in several classes by @gcatanese in #1493
• Release v38.1.0 by @AdyenAutomationBot in #1489

Full Changelog: v38.0.0...v38.1.0