Adyen Java API Library v21.0.0

Description

This release contains a major library overhaul. Several API's have had their models updated to match the latest version of every API. Check The Readme for more information on the supported APIs. The corresponding models can also be found in the Adyen API Explorer

Checkout migration guide

Many requests/responses classes in the Checkout service have been renamed,
please use the new names as shown in the sections below:

service/checkout/UtilityApi.java

Old name(v20.1.2)	New name(v21.0.0)
CreateApplePaySessionRequest	ApplePaySessionRequest
CheckoutUtilityRequest	UtilityRequest
CheckoutUtilityResponse	UtilityResponse

service/checkout/PaymentsApi.java

Old name(v20.1.2)	New name(v21.0.0)
PaymentDonationRequest	DonationPaymentRequest
DonationResponse	DonationPaymentResponse
DetailsRequest	PaymentDetailsRequest

service/checkout/PaymentLinksApi.java

Old name(v20.1.2)	New name(v21.0.0)
CreatePaymentLinkRequest	PaymentLinkRequest

service/checkout/OrdersApi.java

Old name(v20.1.2)	New name(v21.0.0)
CheckoutCreateOrderRequest	CreateOrderRequest
CheckoutCreateOrderResponse	CreateOrderResponse
CheckoutCancelOrderRequest	CancelOrderRequest
CheckoutCancelOrderResponse	CancelOrderResponse
CheckoutBalanceCheckRequest	BalanceCheckRequest
CheckoutBalanceCheckResponse	BalanceCheckResponse

service/checkout/ModificationsApi.java

Old name(v20.1.2)	New name(v21.0.0)
CreateStandalonePaymentCancelRequest	StandalonePaymentCancelRequest
StandalonePaymentCancelResource	StandalonePaymentCancelResponse
CreatePaymentAmountUpdateRequest	PaymentAmountUpdateRequest
PaymentAmountUpdateResource	PaymentAmountUpdateResponse
CreatePaymentCancelRequest	PaymentCancelRequest
PaymentCancelResource	PaymentCancelResponse
CreatePaymentCaptureRequest	PaymentCaptureRequest
PaymentCaptureResource	PaymentCaptureResponse
CreatePaymentRefundRequest	PaymentRefundRequest
PaymentRefundResource	PaymentRefundResponse
CreatePaymentReversalRequest	PaymentReversalRequest
PaymentReversalResource	PaymentReversalResponse

Deprecated services removal

• Account, Fund, Hop, Notification and Notification Configuration APIs for the classic Marketplace integration that were previously marked as @Deprecated, have been removed, please refer to https://docs.adyen.com/marketplaces-and-platforms on how to use the new integration.

Other relevant service changes

• Balance Platform CapitalApi has moved from /service/CapitalApi.java to /service/transfers/CapitalApi.java
• Added SplitConfigurationMerchantLevelApi to /service/management
• Management API TerminalActionsCompanyLevelApi:
  • listAndroidApps now accepts packageName and versionCode as optional parameters
  • listAndroidCertificates now accepts certificateName as optional parameter
• Management API TerminalsTerminalLevelApi
  • listTerminals now accepts otpQuery as optional parameter

Changes for TerminalLocalApi

Thanks to the changes regarding performance improvements for TerminalAPI the securityKey needs to be passed when instantiating TerminalLocalAPI:
TerminalLocalAPI terminalLocalApi = new TerminalLocalAPI(client, securityKey);
Please see TerminalLocalAPITest.java as an example.

What's Changed

Breaking Changes 🛠

• [ITT-578] GSON->Jackson: checkout by @jillingk in #1068
• [ITT-606]- fix name remapping for Checkout class by @antolo-arch in #1071
• [ITT-578] Remove Classic Platforms and lingering GSON depedencies by @jillingk in #1075
• [ITT-599] Implement caching of NexoDerivedKey for TerminalLocalAPI. by @timon-langlotz in #1067
• Update models by @AdyenAutomationBot in #1041
• Automation/models Fix by @jillingk in #1093

Other Changes 🖇️

• docs: fix api-explorer links by @wilsonpinto in #1050
• Add badge to Maven Central by @michaelpaul in #1065
• Fixing the Byte Array Serialization for Jackson Templates by @jillingk in #1074
• [ITT-578] Refactored Banking Webhooks to use Jackson by @jillingk in #1076
• move capital API into transfers by @wboereboom in #1072
• [ITT-578] Change ApiError to jackson by @jillingk in #1078
• SaleToAcquirerData is missing field recurringProcessingModel by @scriptease in #1053
• chore(deps): update dependency org.mockito:mockito-core to v5.4.0 by @renovate in #1060
• [ITT-578] Migrate LEM to Jackson by @jillingk in #1077
• Java 17 and Java 20 CI support by @jlengrand in #1082
• Additional cleanup to support java17 by @jillingk in #1083
• fix(deps): update dependency io.swagger.core.v3:swagger-annotations to v2.2.15 by @renovate in #1058
• chore(deps): update peter-evans/create-pull-request action to v5.0.2 by @renovate in #1059
• fix(deps): update dependency commons-codec:commons-codec to v1.16.0 by @renovate in #1064
• chore(deps): update dependency com.squareup.okio:okio to v3.4.0 by @renovate in #1080
• [ITT-629] Cleanup Java library PreServiceAutomation by @AlexandrosMor in #1087
• Sync Main with Develop branches by @michaelpaul in #1091
• Add services workflow by @AlexandrosMor in #1094
• Update models by @AdyenAutomationBot in #1097
• Release v21.0.0 by @jillingk in #1098

New Contributors

• @wilsonpinto made their first contribution in #1050
• @jlengrand made their first contribution in #1082

Full Changelog: v20.1.2...v21.0.0

Adyen Java API Library v20.1.2

What's Changed

Fixes ⛑️

• AUTHN-525: Remove deprecated challengeIndicator field by @michaelpaul in #1089

Other Changes 🖇️

• Release v20.1.2 by @michaelpaul in #1090

Full Changelog: v20.1.1...v20.1.2

Adyen Java API Library v20.1.1

What's Changed

Fixes ⛑️

• ITT-598: Strict OneOf validation for deserialization against multiple models by @jillingk in #1054

Other Changes 🖇️

• [ITT-536] Release automation by @antolo-arch in #1055
• Release v20.1.1 by @AdyenAutomationBot in #1057

Full Changelog: 20.1.0...v20.1.1

Adyen Java API Library v20.1.0

What's Changed

New Features 💎

• Adding x-requested-verification-code in request options by @sharipsg in #1032
• New field in requestOptions for additional headers by @jillingk in #1039
• Update models no checkout by @wboereboom in #1043

Fixes ⛑️

• Remove hard validation for additional and optional fields by @jillingk in #1030
• Fix shell redirect error by @michaelpaul in #1040
• Add SaleToAcquirerDataSerializer deserialisation by @scriptease in #1038

Other Changes 🖇️

• Update codesnippets by @jillingk in #1027
• Release 20.1.0 by @wboereboom in #1045
• [ITT-572] Banking Webhooks by @jillingk in #1046
• [ITT-572] Process webhooks with Optional field by @jillingk in #1051
• Release 20.1.0 by @wboereboom in #1044

New Contributors

• @sharipsg made their first contribution in #1032
• @scriptease made their first contribution in #1038

Full Changelog: 20.0.0...20.1.0

Adyen Java API Library v20.0.0

What's Changed

Summary 🔁

• AdditionalAmount is added to the model/checkout/PaymentRequest.java class.
• Payout API is split into three services according to the layout in our API explorer.
• Configuration API contains new endpoints.
• The new Capital API has been added to this library.
• All services are regenerated using new templates, introducing the following:
  • Pass query fields to service methods as separate parameters instead of a hashmap
  • Overloading service methods for non-required fields
  • Service classes and methods follow an orderly naming convention
  • Option to add an idempotency key for every request
• All service classes contain an -Api suffix to prevent confusion with models objects.
• Method annotation for services that link you to the required request and response objects, query objects and path parameters.

Breaking Changes 🛠

• [ITT-434] Rename PaymentDonationRequest -> CheckoutPaymentMethod by @jillingk in #1005
• [ITT-141] Automating Services in Java Lib by @jillingk in #1001
• [ITT-485] Upgrade LEM to v3 by @michaelpaul in #1003
• [ITT-446] Rename notifications to Webhook by @AlexandrosMor in #1013
• [ITT-498] LEM by @jillingk in #1011
• [ITT-498] Generate storedvalue/payout/transfers by @jillingk in #1006
• [ITT-498] DataProtection/BalanceControl by @jillingk in #1010
• [ITT-498] Regenerate Management and Recurring by @jillingk in #1008
• [ITT-498] Regenerated Payment/BinLookup/PosTerminalManagement by @jillingk in #1009
• [ITT-498] Regenerated Balance Platform by @jillingk in #1018

New Features 💎

• Bugfix For BCL v2 Endpoints and Add Missing Endpoint by @jillingk in #989
• [ITT-500/ITT-549] Release v20 by @jillingk in #1020

Other Changes 🖇️

• add setter for notificationItems by @wboereboom in #982
• Update models by @AdyenAutomationBot in #984
• ApiException doesn't provide ApiError with error information by @gcatanese in #992
• fix: static initialisers to avoid side effects in the JSON constructors by @sp00m in #990
• Update models by @AdyenAutomationBot in #998
• Update models by @AdyenAutomationBot in #1000
• Model generation: deprecate build and setter methods by @gcatanese in #1015
• Add Feedback section to README by @wboereboom in #1019
• Update README.md by @jillingk in #1014

New Contributors

• @sp00m made their first contribution in #990

Full Changelog: 19.0.0...20.0.0

Adyen Java API Library v19.0.0

What's Changed

Generic models moved

All generic models have been moved to their appropriate service namespaces. That means that, for example, the java.model.amount has been moved to java.model.checkout.amount.

Service classes removed

Some services classes have been removed. All methods in these services have been moved appropriately to keep in line with our API specifications:

Modifications

Has been moved to Checkout

PaymentLinks

Has been moved to Checkout

Retrieve3DS2

Has been moved to Payments (Classic Payments)

Breaking Changes 🛠

• PW-7048: Upgrade Payout from v51 to v68 by @michaelpaul in #831
• PW-7049: Upgrade Recurring from v49 to v68 by @michaelpaul in #830
• PW-7046: Upgrade Payments Classic from v52 to v68 by @michaelpaul in #808
• Pw 7050/update checkout service by @wboereboom in #838
• add modifications to payment service by @wboereboom in #873
• [PW-7051] Binlookup models by @AlexandrosMor in #872
• [PW-7450] Migrate from legacy java Date Library to Java 1.8 OffsetDateTime by @jillingk in #906
• [PW-8014] Removed Error Deserialization by @jillingk in #961
• [PW-7984] Checkout v70 (model generation and adding endpoints) by @jillingk in #960
• [ITT-78] Webhook validation check and remove deprecated HPP classes and config objects by @jillingk in #971
• Update models by @AdyenAutomationBot in #956
• [PW-7716-extended] Removing javax-annotation dependency by @jillingk in #950 Now using GSON rather than Jackson for (de)serialization.

New Features 💎

• [PW-7056] Legal Entity Management Endpoints API by @jillingk in #849
• [PW-7256] Add Bank and Issuing Fund Transfers V3 API by @AlexandrosMor in #856
• PW-7052: Management API by @michaelpaul in #871
• Allow setting RequestOptions for Checkout captures, cancels, refunds, reversals, and payment amount updates by @jrparker in #857
• [PW-7055]BalancePlatform by @jillingk in #839
• add missing createPermit and DisablePermit to recurring service by @wboereboom in #941
• add requestoptions for all service calls supporting idempotency keys by @wboereboom in #952
• PW-8051: Application info via headers by @michaelpaul in #962
• [ITT-76] Created notification handler for Terminal event/display notifications by @jillingk in #969

Fixes ⛑️

• fix typo in payments example by @wboereboom in #958
• PW-8005: Fix Javadoc issues by @michaelpaul in #957
• Fixing the constructor with config object in Client.java by @jillingk in #959
• Update LegalEntity.json by @michaelpaul in #963
• [ITT-40] Fix transfer base url by @jillingk in #973
• Update HMAC validation snippet by @gcatanese in #967
• Remove
  from Javadoc (Checkout) by @gcatanese in #966

Other Changes 🖇️

• PW-7305: Service class template by @michaelpaul in #864
• Update models by @AdyenAutomationBot in #816
• Fix/generated models service cleanup by @wboereboom in #869
• Update dependency org.apache.httpcomponents.client5:httpclient5 to v5.2 by @renovate-bot in #880
• Bump jackson-annotations from 2.13.4 to 2.14.0 by @dependabot in #879
• Bump jackson-datatype-jdk8 from 2.13.4 to 2.14.0 by @dependabot in #878
• Bump jackson-databind from 2.13.4.2 to 2.14.0 by @dependabot in #877
• Bump mockito-core from 4.8.0 to 4.8.1 by @dependabot in #859
• add applicationInfo library info to Checkout requests by @wboereboom in #892
• Update dependency com.google.code.gson:gson to v2.10 by @renovate in #898
• Update dependency org.mockito:mockito-core to v4.9.0 by @renovate in #899
• Update dependency io.swagger:swagger-annotations to v1.6.9 by @renovate in #897
• Update dependency io.swagger.core.v3:swagger-models to v2.2.7 by @renovate in #895
• Update dependency io.swagger.core.v3:swagger-annotations to v2.2.7 by @renovate in #894
• PW-7378: Summary based method names by @michaelpaul in #884
• [PW-7449] Remove Parent Class from LEM/BalancePlatform by @jillingk in #910
• Update Broken Link by @jillingk in #883
• Added requestOptions to storeDetailAndSubmitThirdParty in Payout API by @luggi961 in #909
• Add release.yml file to automatically categorize PRs by @Morerice in #907
• Delete .openapi-generator-ignore by @wboereboom in #915
• move common models to specific packages by @wboereboom in #908
• [PW-7442] Change JSON.java template to fix byte-array adapter by @jillingk in #923
• Pw 7465/update docs by @wboereboom in #919
• Update dependency org.apache.maven.plugins:maven-checkstyle-plugin to v3.2.1 by @renovate in #934
• Update dependency com.squareup.okio:okio to v3.3.0 by @renovate in #929
• Update dependency io.swagger.core.v3:swagger-models to v2.2.8 by @renovate in #928
• Update dependency io.swagger.core.v3:swagger-annotations to v2.2.8 by @renovate in #927
• Update dependency com.google.code.gson:gson to v2.10.1 by @renovate in #926
• Update dependency org.apache.httpcomponents.client5:httpclient5 to v5.2.1 by @renovate in #916
• Update dependency com.fasterxml.jackson.datatype:jackson-datatype-jdk8 to v2.14.1 by @renovate in #902
• Update dependency com.fasterxml.jackson.core:jackson-databind to v2.14.1 by @renovate in #901
• Update dependency com.fasterxml.jackson.core:jackson-annotations to v2.14.1 by @renovate in #900
• Update dependency org.mockito:mockito-core to v4.11.0 by @renovate in #920
• Delete dependabot.yml by @wboereboom in #912
• Update README.md by @antolo-arch in #942
• Update dependency org.mockito:mockito-core to v5 by @renovate in #939
• Add nextgen powerhouses to codeOwners by @wboereboom in #944
• [PW-7716] Removing unused depedencies by @jillingk in #943
• fix transfers models directory and reference by @wboereboom in #954
• Update models by @AdyenAutomationBot in #888
• Release 19.0.0-beta by @michaelpaul in #955
• Update CODEOWNERS by @wboereboom in #965
• Update dependency org.apache.maven.plugins:maven-javadoc-plugin to v3.5.0 by @renovate in #964
• Bump versions for Release 19.0.0 by @jillingk in #975
• [ITT-26] Automate Maven release by @jillingk in #976
• Release 19.0.0 by @jillingk in #977
  *...

Adyen Java API Library 19.0.0-beta

What's Changed

Breaking Changes 🛠

• PW-7048: Upgrade Payout from v51 to v68 by @michaelpaul in #831
• PW-7049: Upgrade Recurring from v49 to v68 by @michaelpaul in #830
• PW-7046: Upgrade Payments Classic from v52 to v68 by @michaelpaul in #808
• Pw 7050/update checkout service by @wboereboom in #838
• add modifications to payment service by @wboereboom in #873
• [PW-7051] Binlookup models by @AlexandrosMor in #872
• [PW-7450] Migrate from legacy java Date Library to Java 1.8 OffsetDateTime by @jillingk in #906

New Features 💎

• [PW-7056] Legal Entity Management Endpoints API by @jillingk in #849
• [PW-7256] Add Bank and Issuing Fund Transfers V3 API by @AlexandrosMor in #856
• PW-7052: Management API by @michaelpaul in #871
• Allow setting RequestOptions for Checkout captures, cancels, refunds, reversals, and payment amount updates by @jrparker in #857
• [PW-7055]BalancePlatform by @jillingk in #839
• add missing createPermit and DisablePermit to recurring service by @wboereboom in #941
• add requestoptions for all service calls supporting idempotency keys by @wboereboom in #952

Other Changes 🖇️

• PW-7305: Service class template by @michaelpaul in #864
• Update models by @AdyenAutomationBot in #816
• Fix/generated models service cleanup by @wboereboom in #869
• add applicationInfo library info to Checkout requests by @wboereboom in #892
• PW-7378: Summary based method names by @michaelpaul in #884
• [PW-7449] Remove Parent Class from LEM/BalancePlatform by @jillingk in #910
• Update Broken Link by @jillingk in #883
• Added requestOptions to storeDetailAndSubmitThirdParty in Payout API by @luggi961 in #909
• Add release.yml file to automatically categorize PRs by @Morerice in #907
• Delete .openapi-generator-ignore by @wboereboom in #915
• move common models to specific packages by @wboereboom in #908
• [PW-7442] Change JSON.java template to fix byte-array adapter by @jillingk in #923
• Pw 7465/update docs by @wboereboom in #919
• Delete dependabot.yml by @wboereboom in #912
• Update README.md by @antolo-arch in #942
• [PW-7716-extended] Removing javax-annotation dependency by @jillingk in #950
• Add nextgen powerhouses to codeOwners by @wboereboom in #944
• [PW-7716] Removing unused depedencies by @jillingk in #943
• fix transfers models directory and reference by @wboereboom in #954
• Update models by @AdyenAutomationBot in #888
• Release 19.0.0-beta by @michaelpaul in #955

New Contributors

• @AdyenAutomationBot made their first contribution in #816
• @jrparker made their first contribution in #857
• @renovate made their first contribution in #898
• @luggi961 made their first contribution in #909
• @antolo-arch made their first contribution in #942

Full Changelog: 18.1.3...19.0.0-beta

Adyen Java API Library 18.1.3

What's Changed

Fixes

• [PW-7223] Fix for serializing Date objects to ISO 8601 format for Checkout #853
• add India to Region Enum #862

Adyen Java API Library 18.1.2

What's Changed

Fixes

• PW-7327: Serialise ByteArray into JSON String by @michaelpaul in #848
• Secure PRNG for ivNonce in NexoCrypto based on strongest non blocking instance by @jillingk in #818

Adyen Java API Library 18.1.1

What's Changed

Fixes

• PW-7215: Allow client configuration via system properties by @michaelpaul in #815
• PW-7204: Add AuthenticationNotRequired by @michaelpaul in #820

Others

• PW-6294: Add OpenAPI model templates by @michaelpaul in #802
• PW-7045: Model generation workflow by @michaelpaul in #809

Full Changelog: 18.1.0...18.1.1