Adyen PHP API Library v28.3.0

Legal Entity Management API v4

LEM v4 enhances the onboarding process and ensures compliance with evolving regulatory data requirements across regions and products. #829

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

Other Changes 💎

• Individual: add support
• Organization: add support , doingBusinessAsAbsent, registrationNumberAbsent
• SoleProprietorship: add doingBusinessAsAbsent, registrationNumberAbsent
• Trust: add doingBusinessAsAbsent
• UnincorporatedPartnership: add doingBusinessAsAbsent
• ServiceEnum: add new value"issuing"
• SourceOfFunds: add several new attributes (amount, assetMonthsHeld, etc..)
• SourceOfFunds: add array of Financier
• SourceOfFunds. TypeEnum: add several new values ("employment", "donations", etc..)
• TaxInformation: add numberAbsent
• Document: add proofOfDirector

Balance Platform API

• Add TransferLimitsBalanceAccountLevelApi to manage Transfer limits - balance account level

• Add TransferLimitsBalancePlatformLevelApi to manage Transfer limits - balance platform level

• LEM v4 by @gcatanese in #829

Other Changes 🖇️

• [PaymentsAPIs] Code generation: update services and models by @AdyenAutomationBot in #813
• [Webhooks] Code generation: update services and models by @AdyenAutomationBot in #812
• Add @Adyen/api-library-maintainers to CODEOWNERS by @gcatanese in #827
• [PlatformsAPIs] Code generation: update services and models by @AdyenAutomationBot in #811
• Handling Unknown Enum Values test by @gcatanese in #830
• docs(README): fix typo "you account" → "your account" by @alisolphp in #832
• Release v28.3.0 by @AdyenAutomationBot in #814

New Contributors

• @alisolphp made their first contribution in #832

Full Changelog: v28.2.0...v28.3.0

Adyen PHP API Library v28.2.0

Features 💎

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

• Improved enum deserialisation: when an unknown enum value is found in API responses and webhooks, an exception is no longer thrown (to avoid affecting the applications). An error is logged instead while the value is still parsed. #807

Tokenization Webhooks

Add support for Tokenization Webhooks #778:

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

Checkout API

• Added action attribute (PaymentDetailsResponseAction) in PaymentDetailsResponse
• Added support for PayToPaymentMethod and UPIPaymentMethod
• Added support for validateShopperId utility to validate the shopper id
• Added enum RIVERTY_INSTALLMENTS in RivertyDetails
• Added subtype attribute in RivertyDetails
• Added EnhancedSchemeData (supporting Airline enhanced scheme data) in PaymentRequest
• Added promoted attribute in PaymentMethod

BalancePlatform API

• Add new service AuthorizedCardUsersApi to manage (add, get, delete and update) authorized users to a given card
• 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
• Added support for AdditionalbankIdentificationRequirement: auBsbCode, caRoutingNumber, gbSortCode or usRoutingNumber.

• In Card add new attribute threeDSecure
• 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

• Add NetworkTokenRequestor to NetworkToken
• New walletProviderAccountScore and walletProviderDeviceScore attributes in TransactionRuleRestrictions
• Added support USInternationalAchPriorityRequirement
• Add walletProviderDeviceType in TransactionRuleRestrictions
• Add enum INTEREST in TransferRoute.CategoryEnum

LEM API

• In AdditionalBankIdentification add new enums auBsbCode and caRoutingNumber

Transfers API

• In AdditionalBankIdentification add new enums auBsbCode and caRoutingNumber
• Add attribute executionDate in Transfer, TransferData and TransferInfo
• In IssuedCard add new attribute threeDSecure
• Added email and url to PartyIdentification and UltimatePartyIdentification
• 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 SepaDirectDebitInfo
• 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..
• In Store, StoreCreationRequest, UpdateStoreRequest and StoreCreationWithMerchantCodeRequest add attribute subMerchantData

ACS Webhooks

• Update deserialization to handle unknown enums
• Add support for balancePlatform.authentication.relayed event
• In RelayedAuthenticationRequest add new attributes threeDSRequestorAppURL, environment, timestamp, type

Report Webhooks

• Update deserialization to handle unknown enums

Transaction Webhooks

• Update deserialization to handle unknown enums
• In IssuedCard add new attribute threeDSecure
• In TransferViewCategoryData add new attribute threeDSecure

Tranfers Webhooks

• Update deserialization to handle unknown enums
• In IssuedCard add new attribute threeDSecure
• In TransferViewCategoryData add new attribute threeDSecure
• In AdditionalBankIdentification add new enums auBsbCode and caRoutingNumber
• Add attribute executionDate in Transfer, TransferData and TransferInfo
• Added email and url to PartyIdentification and UltimatePartyIdentification
• In TransferData add new attribute createdAt and updatedAt, deprecate creationDate (use instead createdAt)
• Added approvalExpired to TransferData and TransferEvent

Changes in this release:

• Add Tokenization Webhooks by @gcatanese in #778
• Generate Checkout models (EnhancedSchemeData) by @gcatanese in #779
• [PaymentsAPIs] Code generation: update services and models by @AdyenAutomationBot in #789
• [ManagementAPIs] Code generation: update services and models by @AdyenAutomationBot in #792
• Generate LEM, Transfers and BalancePlatform services and models by @gcatanese in #804
• Handling unknown enum values by @gcatanese in #807
• Generate Webhooks models by @gcatanese in #808
• [ManagementAPIs] Code generation: update services and models by @AdyenAutomationBot in #802

Other Changes 🖇️

• Add tests for unknown enums and attributes by @gcatanese in #775
• Add test for JSON serialisation by @gcatanese in #777
• Format running on multiple branches by @gcatanese in #784
• Update filter in format.yml by @gcatanese in #786
• Format: update Composer version by @gcatanese in #791
• [PaymentsAPIs] Code generation: update services and models by @AdyenAutomationBot in #796
• Remove leading backslash by @gcatanese in #797
• [PaymentsAPIs] Code generation: update services and models by @AdyenAutomationBot in #798
• [ManagementAPIs] Code generation: update services and models by @AdyenAutomationBot in #799
• [PaymentsAPIs] Code generation: update services and models by @AdyenAutomationBot in #803
• AcsWebhooks: remove custom fix by @gcatanese in #809
• Release v28.2.0 by @AdyenAutomationBot in #776

Full Changelog: v28.1.0...v28.2.0

Adyen PHP API Library v28.1.0

What's Changed

Note

PHP 8.4 Compatibility
Updated method signatures across various service models and abstract resources to explicitly declare nullable > array parameters (array $param = null changed to ?array $param = null), resolving deprecation warnings in PHP 8.4.

New Features 💎

• Checkout API
  • add capturePspReference and businessDayOnly attributes

Other Changes 🖇️

• chore(deps): update dependency phpunit/phpunit to v9.6.23 by @renovate in #676
• Fix warning: Implicitly marking parameter $params as nullable is deprecated by @gcatanese in #771
• PHP 8.4 compatibility by @gcatanese in #773
• Update to release-automation-action v1.4.0 by @gcatanese in #772
• Release v28.1.0 by @AdyenAutomationBot in #770

Full Changelog: v28.0.0...v28.1.0

Adyen PHP API Library v28.0.0

What's Changed

Breaking Changes 🛠

Checkout API

- Remove `DotpayDetails` and `GiropayDetails`
- Remove enum `PAYSAFECARD` from `PaymentDetails`

Management API

• Remove GiroPayInfo
• Remove enum PAYSHOP from PaymentMethodResponse

New Features 💎

Checkout API

* add support for `RakutenPay`
* Add `Surcharge` and `EnhancedSchemeData` (supporting Airline enhanced scheme data) in `PaymentRequest`
* Add `EnhancedSchemeData` (supporting Airline enhanced scheme data) in `PaymentCaptureRequest`
* Add `fraudRiskLevel` in `ResponseAdditionalDataCommon`
* Add enum `PAYSAFECARD` from `StoredPaymentMethodDetails`
* New Donation `type` field supporting the following values: `roundup`, `fixedAmounts`  

(Documentation)
* Added sub-merchant info:
- subMerchantPhoneNumber, subMerchantEmail
- Nested: subMerchant.subSeller[n].email, subMerchant.subSeller[n].phoneNumber
* Added bonus enum to CheckoutSessionInstallmentOption * add RequestedTestAcquirerResponseCodeinAdditionalDataCommon`

Payment Classic API

* Add `fraudRiskLevel` in `ResponseAdditionalDataCommon`

Payout API

* Add `fraudRiskLevel` in `ResponseAdditionalDataCommon`

Management API

• Add supportEmail field to the AfterpayTouchInfo
• Add enum PAYMENTDESIGNATORCONTRACT in JCBInfo
• Add PayByBankPlaidInfo
• Add enum PAYBYBANK_PLAID in PaymentMethodResponse
• Add domainSuffix field to Profile
• In SplitConfigurationRule add enums CHARGED, DEFERRED_DEBIT and PREPAID (#1457)
• Add enableGratuities to the Standalone model

LEM API

* Add  attribute `allowDebugUi` in `OnboardingLinkSettings`to  debug user interface (UI) when applicable.

Transfers API

- Added `IssuingTransactionData` with `captureCycleId` that provides the captureCycleId associated with transfer event
* Add enum `DCCPLATFORMCOMMISSION` in `PlatformPayment`
* Add enum `PENDING`in `TransferData`
* Add attribute `externalReason` in `TransferData`
* Add `scaOnApproval` attribute in `TransferReview`

Fixes ⛑️

• Remove invalid PHPDoc tag @description by @gcatanese in #764
• Correct PosSdk (PosMobileService) LIVE url by @gcatanese in #760
• Add a new configuration for HTTP client to set CURLOPT_CONNECTTIMEOUT and defines default values by @candemiralp in #756

Other Changes 🖇️

• Introduced a new HMAC troubleshooting utility for signature validation debugging (#754). The tool calculates the HMAC signature given the HMAC key and the payload:

cd tools/hmac
php tools/hmac/HMACValidatorPayments.php 1122334455AABBCCDDEEDFDFFSDS payload.json

Check the README

• Add close-issue-label flag to correctly label closed issues by @DjoykeAbyah in #750
• Add bug and feature GitHub issue form by @ayodejidev in #744
• Add nullable return types to API mustache templates by @ayodejidev in #748
• Improve PHP CI workflow by @ayodejidev in #753
• Import Guzzle utils by @szepeviktor in #720
• Vulnerability fix: set workflow permissions by @gcatanese in #765
• Generate Checkout models by @gcatanese in #761
• Generate models for LEM/Transfers/BalanceControl/BalancePlatform by @gcatanese in #763
• Generate models for Payment Classic/Payout/Management/Recurring APIs by @gcatanese in #762

Full Changelog: v27.0.0...v28.0.0

Adyen PHP API Library v27.0.0

What's Changed

Breaking Changes 🛠

• Management API:
  • In MeApiCredential the associatedMerchantAccounts string has been removed.
• 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 recurringRecurringDetailReference and recurringShopperReference are deprecated, use instead the new attribute tokenization.storedPaymentMethodId and tokenization.shopperReference.
    • add tokenizationStoreOperationType and tokenizationStoredPaymentMethodId attributes, add tokenizationStoreOperationType enum.
• Management API:
  • In AndroidApp add STATUS_ARCHIVED, STATUS_ERROR, STATUS_INVALID, STATUS_PROCESSING, STATUS_READY to StatusAllowableValues enum.
  • Support AffirmInfo and PayToInfo payment methods.
  • in Surcharge class add attribuge excludeGratuityFromSurcharge.
• Payout:
  • In ResponseAdditionalDataCommon:
    • ⚠️ the recurringRecurringDetailReference and recurringShopperReference are deprecated, use instead the new attribute tokenization.storedPaymentMethodId and tokenization.shopperReference.
    • add tokenizationStoreOperationType and tokenizationStoredPaymentMethodId attributes, add tokenizationStoreOperationType enum.
• Classic Payments:
  • In ResponseAdditionalDataCommon:
    • ⚠️ the recurringRecurringDetailReference and recurringShopperReference are deprecated, use instead the new attribute tokenization.storedPaymentMethodId and tokenization.shopperReference.
    • add tokenizationStoreOperationType and tokenizationStoredPaymentMethodId attributes, add tokenizationStoreOperationType enum.

Important

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

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

Other Changes 🖇️

• Release v27.0.0 by @AdyenAutomationBot in #746

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

Adyen PHP API Library v26.0.0

What's Changed

Breaking ⚒️

• BalancePlatform:
  • Removed PriorityRestriction class.
  • In TransactionRuleRestriction removed priority.
• BinLookup:
  • In CostEstimateResponse removed surchargeType.
• • TransferWebhook:
    • In TransferReview removed numberOfApprovalsCompleted and scaOnApproval.
• Transfers:
  • In TransferReview removed numberOfApprovalsCompleted and scaOnApproval.

Features 💎

• AcsWebhooks:

  • In ChallengeInfo broadening the range of CHALLENGE_CANCEL enums.

• BalancePlatform:

  • Added AssociationDelegatedAuthenticationData, AssociationFinaliseRequest, AssociationFinaliseResponse, AssociationInitiateRequest, AssociationInitiateResponse and TokenRequestorsRestriction class.
  • In TransactionRuleRestriction added tokenRequestors.

• Checkout:

  • In CardDetails, CardDonations, CheckoutPaymentMethod and DonationPaymentMethod added fastlaneData.
  • Added FastlaneDetails class.

• LegalEntityManagement:

  • Added FinancialReport class.
  • In LegalEntityAssociation added nominee.
  • In Organization and SoleProprietorship added financialReports.

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

• Services:

  • BalancePlatform:
    • Deprecated GrantAccountsApi and GrantOffersApi.
    • In ManageSCADevicesApi added completeAssociationBetweenScaDeviceAndResource and initiateAssociationBetweenScaDeviceAndResource.
  • Transfers:
    • Deprecated CapitalApi.

Other Changes 🖇️

• updated readme by @DjoykeAbyah in #739
• Release v26.0.0 by @AdyenAutomationBot in #740

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

Adyen PHP API Library v25.0.0

What's Changed

Breaking Changes ⚒️

• Payments:
  • In AdditionalDataAirline changed airlinePassengerTelephoneNumber to airlinePassengerPhoneNumber

New Features 💎

• Checkout:
  • In Split added TopUp.
• NegativeBalanceWarningWebhooks:
  • Added Amount class.
  • Added ModelInterface class.
  • Added NegativeBalanceCompensationWarningNotificationData class.
  • Added NegativeBalanceCompensationWarningNotificationRequest class.
  • Added ObjectSerializer class.
  • Added Resource class.
  • Added ResourceReference class.
• Payments:
  • In Split added TopUp.
• Code generation: update services and models by @AdyenAutomationBot in #734

Other Changes 🖇️

• Add deprecation info - models by @ayodejidev in #735
• Add deprecation info for services by @ayodejidev in #737
• Fix deprecation info - remove extra new line by @ayodejidev in #738
• Release v25.0.0 by @AdyenAutomationBot in #736

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: v24.0.0...v25.0.0

Adyen PHP API Library v24.0.0

What's Changed

Breaking Changes 🛠

• Checkout API:
  • airlinePassengerTelephoneNumber changed to airlinePassengerPhoneNumber in AdditionalDataAirline

New Features 💎

• Checkout API:
  • Added AffirmDetails payment method
  • Added PayPayDetails payment method
  • 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.

Other Changes 🖇️

• Code generation: update services and models by @AdyenAutomationBot in #733
• Release v24.0.0 by @AdyenAutomationBot in #729
• Enhanced Client and Region with support for Terminal Cloud LIVE regional endpoints by @DjoykeAbyah in #724
• fix assert for testGetCloudEndpointForTestEnvironment by @DjoykeAbyah in #727

Full Changelog: v23.2.1...v24.0.0

Adyen PHP API Library v23.2.0

What's Changed

New Features 💎

• BalancePlatform:
  • Added PriorityRestriction class.
  • In TransactionRuleRestrictions added priority.
  • 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 #722

Other Changes 🖇️

• Release v23.2.0 by @AdyenAutomationBot in #723

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

Adyen PHP API Library v23.1.0

What's Changed

New Features 💎

• BalancePlatform:
  • Added CounterpartyTypesRestriction and SourceAccountTypesRestriction class
  • In TransactionRuleRestrictions added counterpartyTypes and sourceAccountTypes
• ConfigurationWebhooks:
  • In AccountHolderNotificationRequest, BalanceAccountNotificationRequest, CardOrderNotificationRequest, PaymentNotificationRequest and SweepConfigurationNotificationRequest added timestamp
• Management:
  • In TerminalConnectivityCellular added iccid2
  • In UpdatePaymentMethodInfo added storeId
• ManagementWebhooks:
  • Added TerminalAssignmentNotificationRequest and TerminalAssignmentNotificationResponse class
• ReportWebhooks:
  • In ReportNotificationRequest added timestamp
• Update all services by @AdyenAutomationBot in #719

Other Changes 🖇️

• Release v23.1.0 by @AdyenAutomationBot in #721

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