Php Sdk V2 Laravel Package

Deprecated

• ApiPayIns deposit-preauthorized PayIn methods – The following methods have been deprecated in favour of new names aligned with the API resource (/payins/deposit-preauthorized/...). The old methods still work but will be removed in a future major version. The new methods have the same functionality, only the naming is changed:
  • ApiPayIns::CreateCardPreAuthorizedDepositPayIn() (#795) → use ApiPayIns::CreatePayInDepositPreauthorizedWithoutComplement() instead.
  • ApiPayIns::CreateDepositPreauthorizedPayInWithoutComplement() → use ApiPayIns::CreatePayInDepositPreauthorizedWithoutComplement() instead.
  • ApiPayIns::CreateDepositPreauthorizedPayInPriorToComplement() → use ApiPayIns::CreatePayInDepositPreauthorizedPriorToComplement() instead.
  • ApiPayIns::CreateDepositPreauthorizedPayInComplement() → use ApiPayIns::CreatePayInDepositPreauthorizedComplement() instead.
• ApiPayIns recurring PayIn methods (#794) – The following methods have been deprecated in favour of new names and a unified creation entry point. The old methods still work but will be removed in a future major version:
  • ApiPayIns::CreateRecurringRegistration() → use ApiPayIns::CreateRecurringPayInRegistration() instead.
  • ApiPayIns::GetRecurringRegistration() → use ApiPayIns::GetRecurringPayInRegistration() instead.
  • ApiPayIns::UpdateRecurringRegistration() → use ApiPayIns::UpdateRecurringPayInRegistration() instead.
  • ApiPayIns::CreateRecurringPayInRegistrationCIT() → use ApiPayIns::CreateRecurringPayIn() instead.
  • ApiPayIns::CreateRecurringPayInRegistrationMIT() → use ApiPayIns::CreateRecurringPayIn() instead.
  • ApiPayIns::CreateRecurringPayPalPayInCIT() → use ApiPayIns::CreateRecurringPayIn() instead.
  • ApiPayIns::CreateRecurringPayPalPayInMIT() → use ApiPayIns::CreateRecurringPayIn() instead.

Added

• PayPal deposit preauthorizations (#795) – New PayPalDepositPreauthorization entity (extends Deposit) with PayPal-specific fields (PaypalPayerID, PaypalOrderID, BuyerFirstname, BuyerLastname, BuyerPhone, BuyerCountry, PaypalBuyerAccountEmail, CancelURL, Trackings, ShippingPreference, Reference, LineItems, RedirectURL, ReturnURL, DataCollectionId). New method ApiDeposits::CreatePayPalDepositPreauthorization() (POST /deposit-preauthorizations/payment-methods/paypal) with optional $idempotencyKey.
  • Automatic hydration: ApiDeposits::Get / Cancel / Update / GetAllForUser now automatically hydrate PayPal deposits as PayPalDepositPreauthorization (instead of the base Deposit type), so PayPal-specific fields are accessible without any extra casting.
• Recurring PayIns – Apple Pay & Google Pay support and unified creation (#794):
  • New RecurringPayInRegistration entity returned by the new registration methods (with Status, ResultCode, ResultMessage, CurrentState, RecurringType, TotalAmount, CycleNumber, AuthorId, CreditedUserId, CreditedWalletId, Billing, Shipping, EndDate, Frequency, FixedNextAmount, FractionedPayment, FreeCycles, FirstTransactionDebitedFunds, FirstTransactionFees, NextTransactionDebitedFunds, NextTransactionFees, ProfilingAttemptReference, PaymentType, CardInfo, CardId, Migration, PaymentData).
  • New ApiPayIns::CreateRecurringPayInRegistration(), ApiPayIns::GetRecurringPayInRegistration(), and ApiPayIns::UpdateRecurringPayInRegistration() methods returning the new RecurringPayInRegistration type.
  • New unified ApiPayIns::CreateRecurringPayIn() method which dispatches to the correct endpoint based on the PayIn's PaymentType / ExecutionType, replacing the per-scheme CIT/MIT methods.
  • Apple Pay recurring PayIns are now supported via the new endpoint POST /payins/payment-methods/applepay/recurring.
  • Google Pay recurring PayIns are now supported via the new endpoint POST /payins/payment-methods/googlepay/recurring.
• Report.DateFilterBy (#787) – New optional DateFilterBy property on Report to control which date field the report filter applies to.
• LocalAccount extra bank-identifier fields (#793) – Added BankCode (4-digit bank code), BSBCode (6-digit Bank State Branch code), and BCNumber (5-digit bank clearing number). Existing properties (Iban, Bic, AchNumber, FedWireNumber, AccountType, BranchCode, InstitutionNumber) gained inline doc comments; behavior unchanged.
• Recipients pagination (#792) – Verified/tested that ApiRecipients::GetUserRecipients() honours the Pagination argument; no API change.

Breaking Changes

• Sub-object casting (#790) – Added missing GetSubObjects() mappings across response and request DTOs. Properties that were previously returned as raw stdClass are now hydrated as typed Mangopay entities. Code that read those nested properties as plain objects (e.g. via array-style access, property_exists, or by passing them to functions that expect stdClass) must be updated to use the typed classes. Affected classes:
  • BankingAliasIBAN (LocalAccountDetails → LocalAccountDetailsBankingAlias)
  • BanksByCountry (Banks → Bank[])
  • CardPreAuthorization (added BrowserInfo → BrowserInfo, Shipping → Shipping)
  • CardValidation (added CardInfo → CardInfo)
  • Check (Data, Reasons → CheckData[])
  • Conversion (DebitedFunds, CreditedFunds, Fees → Money; RequestedFees → CustomFees; ConversionRateResponse → ConversionRate; MarginsResponse → MarginsResponse)
  • ConversionQuote (DebitedFunds, CreditedFunds → Money; Fees, RequestedFees → CustomFees; ConversionRateResponse → ConversionRate; UserMargin → UserMargin; MarginsResponse → MarginsResponse)
  • CreateClientWalletsInstantConversion (DebitedFunds, CreditedFunds → Money)
  • CreateInstantConversion (DebitedFunds, CreditedFunds → Money; Fees → CustomFees; UserMargin → UserMargin)
  • IdentityVerification (Checks → Check[])
  • InstantPayout – now extends Libraries\Dto; UnreachableReason → FallbackReason
  • IntentSplits (Splits → PayInIntentSplit[])
  • InternationalAccountDetails (Address → VirtualAccountAddress, Account → InternationalAccount)
  • LocalAccountDetails (Address → VirtualAccountAddress, Account → LocalAccount)
  • MarginsResponse (Mangopay, User → UserMargin)
  • PayIn (AuthenticationResult → AuthenticationResult)
  • PayInExecutionDetailsExternalInstruction (DebitedBankAccount → DebitedBankAccount)
  • PayInIntent (LineItems → PayInIntentLineItem[]; Captures → PayInIntentCapture[]; Capture → PayInIntentCapture; Refunds → PayInIntentRefund[]; Refund → PayInIntentRefund; Disputes → PayInIntentDispute[]; Dispute → PayInIntentDispute; Splits → PayInIntentSplitInfo[])
  • PayInIntentCapture, PayInIntentDispute, PayInIntentRefund, PayInIntentSplitInfo (LineItems → PayInIntentLineItem[])
  • PayInPaymentDetailsBlik (BrowserInfo → BrowserInfo)
  • PayInPaymentDetailsCard (BrowserInfo → BrowserInfo, Shipping → Shipping)
  • PayInRecurringRegistration (FirstTransactionDebitedFunds, FirstTransactionFees, NextTransactionDebitedFunds, NextTransactionFees → Money; Billing → Billing; Shipping → Shipping)
  • PayInRecurringRegistrationGet (CurrentState → RecurringPayInCurrentState)
  • PayInRecurringRegistrationRequestResponse (TotalAmount → Money)
  • PayInRecurringRegistrationUpdate (Shipping → Shipping, Billing → Billing)
  • PayOutEligibilityRequest (DebitedFunds, Fees → Money)
  • PayOutEligibilityResponse (InstantPayout → InstantPayout)
  • RecurringPayInCIT (BrowserInfo → BrowserInfo; DebitedFunds, Fees → Money)
  • RecurringPayInCurrentState (CumulatedDebitedAmount, CumulatedFeesAmount → Money)
  • RecurringPayInMIT (DebitedFunds, Fees → Money)
  • RecurringPayPalPayInCIT (Shipping → Shipping)
  • RecurringPayPalPayInMIT (DebitedFunds, Fees → Money; Shipping → Shipping)
  • Report (Filters → ReportFilters)
  • ReportRequest (Filters → FilterReports)
  • ScaStatus (ConsentScope → ConsentScope)
  • SettlementValidation (FooterErrors → SettlementValidationFooter[]; LinesErrors → SettlementValidationLine[])
  • SupportedBank (Countries → BanksByCountry[])
  • VirtualAccount (LocalAccountDetails → LocalAccountDetails; Capabilities → VirtualAccountCapabilities; see InternationalAccountDetails fix below)
  • VirtualAccountAvailabilities (Collection, UserOwned → VirtualAccountAvailability[])
• VirtualAccount.InternationalAccountDetails type fix (#790) – The VirtualAccount.$InternationalAccountDetails property is now correctly typed as InternationalAccountDetails[] (an array) instead of a single InternationalAccountDetails object, matching the API response. Code that previously accessed this property as a single object (e.g. $virtualAccount->InternationalAccountDetails->Iban) must be updated to iterate the array (e.g. $virtualAccount->InternationalAccountDetails[0]->Iban).

Breaking Changes

• Idempotency improvements (#777) – GetObjectForIdempotencyUrl updated with missing/corrected mappings; previously unmapped POST endpoints now return typed entities instead of stdClass. Several API methods were missing the $idempotencyKey parameter; it has been added as an optional last argument to ApiPayIns::CreateDepositPreauthorizedPayIn, ApiConversions::Create, ApiDeposits::Create, ApiBankingAliases::Create, and ApiUsers::ValidateTheFormatOfUserData.
• Payconiq removal (#785) – Payconiq was discontinued on 4 December 2025. Removed ApiPayIns::CreatePayconiq(), PayInPaymentDetailsPayconiq, PayInPaymentType::Payconiq, and the related URL keys from ApiBase.

Added

• Acquiring API (#783) – New ApiAcquiring class ($api->Acquiring) with CreatePayIn, CreatePayPalDataCollection, CreatePayInRefund, and CreateCardValidation methods supporting Card Direct, iDEAL, Apple Pay, Google Pay, and PayPal.
• PreferredCardNetwork field on card pay-in payment details.
• SettlementId field on report filters.
• Klarna LineItem discount (#781) – Discount support added to LineItem objects used in Klarna pay-ins.

Added - mTLS certificates support

• mTLS certificates are now configurable in the SDK via file paths or encoded strings

Added - ChargeBearer body parameter on payouts

https://github.com/Mangopay/mangopay4-php-sdk/pull/779/changes/011296e13901bd6ece848d9f052de9f93dd43346 On POST Create a Payout, platforms can now request to pay all SWIFT fees using the OUR value of the new ChargeBearer property (API release note):

• Handle ChargeBearer param

Added - AuthenticationType response property on card pay-ins

https://github.com/Mangopay/mangopay4-php-sdk/pull/779/changes/cffccbe99a3efd51bdfba54ff4e37536240af578

• The AuthenticationResult.AuthenticationType response property is now returned on card pay-ins

Added - TelephoneOrder body parameter on recurring card pay-ins (CIT and MIT)

https://github.com/Mangopay/mangopay4-php-sdk/pull/779/changes/e69cc7af27f9384c3d02bac91774b21f76061035 To support the TelephoneOrder property on POST Create a Recurring PayIn (MIT) and POST Create a Recurring PayIn (CIT):

• handle PaymentCategory param

FX

Breaking change – Custom fees

#771 To support percentage-based FX fees (API release note):

• Breaking change – The CreateInstantConversion.Fees type is now CustomFees instead of Money, to support the new FX fees structure of Type (PERCENTAGE | FIXED) and Value
• Breaking change - The ConversionQuote.Fees type is now CustomFees instead of Money, to support the new FX fees structure of Type (PERCENTAGE | FIXED) and Value
• Added RequestedFees to ConversionQuote and Conversion

Added – User margin

#771 To support the FX user margin (API release note):

• Added UserMargin to CreateInstantConversion and ConversionQuote
• Added MarginsResponse to Conversion and ConversionQuote

Echo

Breaking change - Settlement upload endpoints

#767 To support the new behavior of the POST Create a Settlement endpoint to obtain an UploadUrl:

• Updated settlement_sample.csv and tests
• Added FileName and UploadUrl to Settlement
• Added GenerateSettlementUploadUrl interface
• Breaking change – Replaced upload method in ApiSettlements with GenerateUploadUrl
• Breaking change – Replaced update method in ApiSettlements with GenerateNewUploadUrl

Added - GET validations for a Settlement endpoint

#767 To support the GET View validations for a Settlement endpoint:

• Added SettlementValidation, SettlementValidationFooter, SettlementValidationLine classes
• Added GetValidations method to ApiSettlements

Added - PUT Cancel a Settlement endpoint

#767 To support the PUT Cancel a Settlement endpoint:

• Added Cancel method to ApiSettlements

Added – Intent unfunded amounts and source wallet

#768

• Added SplitOriginWalletId to PayInIntentLineItem, PayInIntentSplit #761
• Added UnfundedSellerAmount to PayInIntentLineItem
• Added UnfundedAmount to PayInIntent

Added – POST Create a Refund of an Intent

#763 To support POST Create a Refund of an Intent:

• Added Refund and Capture to PayInIntent
• Added CreatePayInIntentRefund method to ApiPayins

Added – POST Reverse the Refund of an Intent

#763 To support POST Reverse the Refund of an Intent:

• Added ReversePayInIntentRefund method to ApiPayins

Added – POST Create a Dispute of an Intent

#763 To support POST Create a Dispute of an Intent:

• Added Dispute to PayInIntent
• Added CreatePayInIntentDispute method to ApiPayins

Added - PUT Update an Intent Dispute

#763 To support PUT Update an Intent Dispute:

• Added Decision to PayInIntent
• Added UpdatePayInIntentDisputeOutcome method to ApiPayins

Fixed - VirtualAccountCapabilities

#760

• Fixed LocalPayInAvailable and InternationalPayInAvailable in VirtualAccountCapabilities class

Added

• Support for new GET View the SCA status of a User endpoint (API release note) (#766)
• Support for new event types SCA_CONTACT_INFORMATION_UPDATE_CONSENT_GIVEN, SCA_CONTACT_INFORMATION_UPDATE_CONSENT_REVOKED, SCA_TRANSFER_CONSENT_GIVEN, SCA_TRANSFER_CONSENT_REVOKED, SCA_RECIPIENT_REGISTRATION_CONSENT_GIVEN, SCA_RECIPIENT_REGISTRATION_CONSENT_REVOKED, SCA_VIEW_ACCOUNT_INFORMATION_CONSENT_GIVEN, SCA_VIEW_ACCOUNT_INFORMATION_CONSENT_REVOKED, SCA_EMAIL_VERIFIED, SCA_PHONE_NUMBER_VERIFIED (#765) (thank you @williamdes)
• Support for new RecipientId property on payouts (API release note) (#759)

Release PR: #770

[3.48.0] - 2025-11-28

Changed

• Migrated to V4 naming convention

No changes (dummy release - retrigger sync with package manager)

Added

• Support for ScaContext on POST Create a Recipient for platforms taking action by proxy with consent from the user (API release note, #753)

Added

• New POST Manage proxy consent for a User endpoint to obtain and manage user consent via the hosted SCA experience (if proxy is activated). A proxy and user consent are now required to use the USER_NOT_PRESENT value for ScaContext (API release note, #751)
• ScaContext request parameter newly added on all user POST and PUT endpoints, enabling the platform to request these actions with USER_NOT_PRESENT – provided the proxy is in place, activated, and the user has given consent (API release note, #750 )
• Support for the Licensor property on GET View a Client (#749 )

Changed

• x-tenant-id deprecated as no longer necessary for UK platforms; the parameter is ignored by Mangopay (#749 )

Added

• Verification of Payee (VOP) API response fields (RecipientVerificationOfPayee and sub-properties) on the endpoints GET View a Recipient, POST Create a Recipient, POST Create a Payout (API release note, #739)
• Support for the POST Cancel an Intent endpoint for Echo, Mangopay's solution for platforms working with another third-party PSP for funds acquisition (#747)
• Support for POST Submit data for a PayPal PayIn endpoint (#744)

Added

• Support for ProfilingAttemptReference on all payment methods for Mangopay's Fraud Prevention solution #743
• Webhook event types for Echo, Mangopay's solution for third-party PSP integrations: INTENT_AUTHORIZED,INTENT_CAPTURED,INTENT_REFUNDED,INTENT_REFUND_REVERSED,INTENT_DISPUTE_CREATED,INTENT_DISPUTE_DEFENDED,INTENT_DISPUTE_WON,INTENT_DISPUTE_LOST,INTENT_SETTLED_NOT_PAID,INTENT_PAID,SPLIT_CREATED,SPLIT_PENDING_FUNDS_RECEPTION,SPLIT_AVAILABLE,SPLIT_REJECTED,SPLIT_REVERSED #742
• Support for VirtualAccountPurpose on Banking Alias object #745

Added

• Support for Fees on ConversionQuote #736 (thank you @pkly #647)

Improved

• OAuth token refresh buffer before expiry updated to 30s #740
• ⚠️ The way CURL verification of SSL certificate is set #737 (thank you @Kelthan #695)
• PHP 8.2 compatibility #738 (thank you @Nek- #588 @nurul-umbhiya #640)

Fixed

• Tests #734

Changed

• Type casting to deserialize arrays in GetSchema #732 (#717 thanks for raising @tarsFromTesseract).

⚠️Caution – Potentially breaking The new GetSchema typings may result in a breaking change if your integration relies on the stdClass returned previously.

• Made PendingUserAction nullable #730 (#726 thanks for raising @williamdes)

Added

• Support for POST Create a Bank Wire to the Repudiation Wallet #731

Added

Support for new Splits endpoints for Echo (#727, API release note):

• PUT Update a Split of an Intent
• POST Execute a Split of an Intent
• POST Reverse the Split of an Intent
• GET View a Split of an Intent

New ReportTypes for Echo (#728, API release note)):

• ECHO_INTENT
• ECHO_INTENT_ACTION
• ECHO_SETTLEMENT
• ECHO_SPLIT

Added

• Sku parameter on LineItem, for Klarna PayIns
• handle new endpoint View supported banks for Pay by Bank, to enable presentation of banks to user before Pay by Bank payment request

Added

Endpoints for Mangopay Echo, a solution for platforms working with another third-party PSP for funds acquisition (including via the Mirakl Connector) #720 :

• POST Create an Intent
• GET View an Intent
• POST Create a Capture for an Intent
• POST Create a Settlement
• PUT Update a Settlement
• GET View a Settlement
• POST Create a Split of an Intent

Added

• New endpoint POST Create a Bizum PayIn
• New webhook event types for SCA enrollment (API release note), note that these are triggered on enrollment not authentication:
  • SCA_ENROLLMENT_SUCCEEDED
  • SCA_ENROLLMENT_FAILED
  • SCA_ENROLLMENT_EXPIRED
• New webhook event types for UserCategory change (API release note ):
  • USER_CATEGORY_UPDATED_TO_OWNER
  • USER_CATEGORY_UPDATED_TO_PAYER
  • USER_CATEGORY_UPDATED_TO_PLATFORM
• Support for PLATFORM value to UserCategory enum
• Support for GET List Transactions for a Card Fingerprint

Added

• US and CA virtual accounts for local pay-in collection

Fixed

• On POST Enroll a User, PendingUserAction cast to \MangoPay\PendingUserAction instead of stdClass (thanks for raising @renanwingly #713)

Added

Endpoints for new Reporting Service feature:

• POST Create a Report
• GET View a Report
• GET List all Reports

Webhook event types for new Reporting Service:

• REPORT_GENERATED
• REPORT_FAILED

Support for GET List Disputes for a PayIn endpoint.

Added

• Support for RecipientScope query parameter on GET List Recipients for a User
• Support for missing webhook event types (recurring registration, deposit preauth, etc)

Fixed

• Status enum value on Identity Verification object changed from OUTDATED to OUT_OF_DATE

Added

Event types for user account webhooks, relevant to SCA enrollment in user endpoints and account closure:

• USER_ACCOUNT_VALIDATION_ASKED
• USER_ACCOUNT_ACTIVATED
• USER_ACCOUNT_CLOSED

Event types for instant and quoted FX conversions:

• INSTANT_CONVERSION_CREATED
• INSTANT_CONVERSION_SUCCEEDED
• INSTANT_CONVERSION_FAILED
• QUOTED_CONVERSION_CREATED
• QUOTED_CONVERSION_SUCCEEDED
• QUOTED_CONVERSION_FAILED

Support for 30-day deposit preauthorization features:

• POST Create a Deposit Preauthorized PayIn prior to complement
• POST Create a Deposit Preauthorized PayIn complement
• NO_SHOW_REQUESTED on updateDeposit method for PUT Cancel a Deposit Preauthorization or request a no-show
• GET View a PayIn (Deposit Preauthorized Card
• GET List Transactions for a Deposit Preauthorization

Added and refined

Hosted KYC/KYB endpoints

The following endpoints have been refined following the beta phase, and are now generally available:

• POST Create an IDV Session (no changes)
• GET View an IDV Session (includes Checks in response)
• GET List IDV Sessions for a User (new endpoint)

The previously available endpoint GET View Checks for an IDV Session has been removed (as Checks were integrated into the GET by ID).

See the guide for more details.

Recipients

The Country property has been added to Recipients, as a required query parameter on GET View the schema for a Recipient and as a required body parameter on POST Validate data for a Recipient and POST Create a Recipient.

Added

• GET List Deposit Preauthorizations for a Card
• GET List Deposit Preauthorizations for a User

Added

SCA on wallet access endpoints

ScaContext query parameter added on wallet access endpoints for the introduction of SCA:

• GET View a Wallet
• GET List Wallets for a User
• GET List Transactions for a User
• GET List Transactions for a Wallet

If SCA is required, Mangopay responds with a 401 response code. The PendingUserAction RedirectUrl is in the dedicated WWW-Authenticate response header.

See the tests for examples on handling this error.

Added

Recipients

• GET View payout methods
• GET View the schema for a Recipient
• POST Validate data for a Recipient
• POST Create a Recipient
• GET View a Recipient
• GET List Recipients for a user
• PUT Deactivate a Recipient
• Webhook event types:
  • RECIPIENT_ACTIVE
  • RECIPIENT_CANCELED
  • RECIPIENT_DEACTIVATED

SCA on Owner-initiated transfers

• On POST Create a Transfer
  • ScaContext body parameter
  • PendingUserAction response field containing RedirectUrl

Endpoints to close a user account

• DELETE Close a Natural User
• DELETE Close a Legal User

Added

• POST Create a BLIK PayIn (with code)
• POST Create a TWINT PayIn
• POST Create a Pay by Bank PayIn, including related PAYIN_NORMAL_PROCESSING_STATUS_PENDING_SUCCEEDED webhook event type
• RTGS_PAYMENT for PayoutModeRequested on POST Create a Payout
• PayPal recurring payments, thanks to the PaymentType value PAYPAL on Recurring PayIn Registrations and new endpoints (POST Create a Recurring PayPal PayIn (CIT) and POST Create a Recurring PayPal PayIn (MIT)

Changed

• User-Agent Header value standardized on format: User-Agent: Mangopay-SDK/SDKVersion (Language/LanguageVersion)

Fixed

• Replaced int property with Money property for recurring payin registration TotalAmount
• Fixed tests for categorize SCA users endpoint

Added

New endpoints for strong customer authentication (SCA) on Owner users:

• POST Create a Natural User (SCA)
• PUT Update a Natural User (SCA)
• POST Create a Legal User (SCA)
• PUT Update a Legal User (SCA)
• PUT Categorize a Natural User (SCA)
• PUT Categorize a Legal User (SCA)
• POST Enroll a User in SCA

Added

New endpoint for Payconiq:

• POST Create a Payconiq PayIn

Fixed

Rate limiting headers interpreted dynamically based on X-RateLimit-Reset time and for a variable number of bucket values.

Added

New endpoints for hosted Identity Verification and relevant webhooks:

• Create a hosted Identity Verification Session
• View an Identity Verification Session
• View an Identity Verification Checks

New endpoint for The Swish PayIn object:

• Create a Swish PayIn
• View a PayIn (Swish)

New endpoints for client wallet conversations:

• Create an Instant Conversion between Client Wallets
• Create a Quoted Conversion between Client Wallets

Updated

Revised tests to improve reliability and address any outdated tests.