October 1, 2026
Added
Extended Preauthorization feature to rename Deposit Preauthorization
New ApiExtendedPreauthorizations API (exposed as $api->ExtendedPreauthorizations), renaming the existing Deposit Preauthorization API, now deprecated (API release note). It provides:
Create()(POST Create a Card Extended Preauthorization)CreatePayPalExtendedPreauthorization()(POST Create a PayPal Extended Preauthorization)Get()(GET View an Extended Preauthorization)Update()(PUT Cancel an Extended Preauthorization)GetAllForUser()(GET List Extended Preauthorizations for a User)GetAllForCard()(GET List Extended Preauthorizations for a Card)GetTransactions()(GET List Transactions for an Extended Preauthorization)
New ExtendedPreauthorization, PayPalExtendedPreauthorization, and CreatePreAuthorizedExtendedPayIn entities and an ExtendedPreauthorizationStatus enum (CREATED, SUCCEEDED, FAILED) were added. Get(), Update(), and GetAllForUser() return a PayPalExtendedPreauthorization when the underlying preauthorization was created via PayPal, otherwise an ExtendedPreauthorization.
Added
Extended Preauthorized PayIn
New method ApiPayIns::CreatePayInExtendedPreauthorized(CreatePreAuthorizedExtendedPayIn $payIn), backed by POST Create an Extended Preauthorized PayIn, to create a PayIn from an extended preauthorization.
Added
Transaction::$ExtendedPreauthorizationId
New property on Transaction, replacing the now-deprecated $DepositId.
Added
Extended Preauthorization event types
New EventType constants, mirroring the Extended Preauthorization webhook events:
EXTENDED_PREAUTHORIZATION_CREATEDEXTENDED_PREAUTHORIZATION_PAYMENT_WAITINGEXTENDED_PREAUTHORIZATION_PAYMENT_VALIDATEDEXTENDED_PREAUTHORIZATION_PAYMENT_FAILEDEXTENDED_PREAUTHORIZATION_FAILEDEXTENDED_PREAUTHORIZATION_PAYMENT_CANCEL_REQUESTEDEXTENDED_PREAUTHORIZATION_PAYMENT_CANCELEDEXTENDED_PREAUTHORIZATION_PAYMENT_EXPIRED
Added
Settlement event types
New EventType constants, mirroring the Settlement webhook events:
SETTLEMENT_CREATEDSETTLEMENT_UPLOADEDSETTLEMENT_PENDING_UPLOADSETTLEMENT_PENDING_FUNDS_RECEPTIONSETTLEMENT_RECONCILEDSETTLEMENT_PARTIALLY_MATCHEDSETTLEMENT_UNMATCHEDSETTLEMENT_INSUFFICIENT_FUNDSSETTLEMENT_CANCELLEDSETTLEMENT_FAILED
Added
ProfilingAttemptReference on users
New optional ProfilingAttemptReference property on UserNaturalSca and UserLegalSca.
Deprecated
Deposit Preauthorization feature deprecated
The following are deprecated and will be removed in a future major version:
ApiDeposits($api->Deposits) – useApiExtendedPreauthorizations($api->ExtendedPreauthorizations) instead.DepositStatus– useExtendedPreauthorizationStatusinstead.Transaction::$DepositId– useTransaction::$ExtendedPreauthorizationIdinstead.ApiPayIns::CreatePayInDepositPreauthorizedWithoutComplement()– useApiPayIns::CreatePayInExtendedPreauthorized()instead.