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

Changed

• Migrated to V4 naming convention

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
• Curl verification of SSL certificate #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.

Updated

Added option to create a GB Banking Alias.

Added

• New PaymentRef parameter for Payouts v

Updated

Added all relevant EVENT_TYPE_CHOICES for virtual accounts:

• VIRTUAL_ACCOUNT_ACTIVE
• VIRTUAL_ACCOUNT_BLOCKED
• VIRTUAL_ACCOUNT_CLOSED
• VIRTUAL_ACCOUNT_FAILED

Fixed

• https://github.com/Mangopay/mangopay2-php-sdk/pull/643 Fixed PHP doc blocks.
• https://github.com/Mangopay/mangopay2-php-sdk/pull/654 Fixed idempotency response to return the error object.
• #656 Update bankAccountId parameter to accept alphanumerical IDs.

Thanks for you contribution [@williamdes](https://github.com/williamdes)

Added

New endpoints for The Virtual Account object:

• Create a Virtual Account
• Deactivate a Virtual Account
• View a Virtual Account
• List Virtual Accounts for a Wallet
• View Client Availabilities

Added

1. New endpoint: Create a Bancontact PayIn

2. New parameter PaymentCategory for the following endpoints :

• Create a Card Validation
• Create a Direct Card PayIn
• Create a Preauthorization

Added

New parameter StatementDescriptor for the following endpoints :

• Create a refund for a payin
• View a refund

Thanks @williamdes

Added

• New parameter CardHolderName for Update Card registration

Fixed

• Updated the implementation for Look up metadata for a payment method. The CommercialIndicator and CardType fields have been moved to the BinData object in the API response.

Fixed

• #637 Reset DebugMode to false by default

Added

• New endpoint Add tracking to Paypal payin
• New parameter SecureMode for Create card validation
• New parameters for Paypal mean of payment : CancelURL & Category (sub-parameter of LineItems). And management of PaypalPayerID, BuyerCountry, BuyerFirstname, BuyerLastname, BuyerPhone, PaypalOrderID in the response.

Fixed

• Fixed incorrect spelling of the Subtype key in the BinData parameter.
• Conversions endpoint spelling

Added

• The optional Fees parameter is now available on instant conversions, allowing platforms to charge users for FX services. More information here.
• Platforms can now use a quote to secure the rate for a conversion between two currencies for a set amount of time. More information here.
• Introduced the UKHeaderFlag boolean configuration key. Platforms partnered with Mangopay's UK entity should set this key to true for proper configuration.

Added

• New endpoint to look up metadata from BIN or Google Pay token. More information here
• Get a card validation endpoint
• Validate the format of user data endpoint
• Deprecate dynamic properties #592
• Constant class created for UserCategory parameter

Added

New CardInfo parameter returned on card transactions. More information here.

Added

The IDEAL legacy implementation has been enhanced. You can now pass the Bic., and if provided, the API response will include the BankName parameter. More information here.

Added

It's now possible to specify an amount for DebitedFunds and Fees when you create a refund with PayIns->CreateRefund().

Updated

• Giropay and Ideal integrations with Mangopay have been improved.
• Klarna param "MerchantOrderId" has been renamed to "Reference"

Added

• New Reference parameter for the new Paypal implementation.

Added

• Instantly convert funds between 2 wallets of different currencies owned by the same user with the new SPOT FX endpoints

Fixed

• Formatting issues (linter)

Added

• Multibanco, Satispay, Blik, Klarna are now available as a payment method with Mangopay. This payment method is in private beta. Please contact support if you have any questions.
• Card validation endpoint is now available (Private beta)
• A new parameter for Paypal : ShippingPreference
• Timeout configuration is now customizable. Default value is now 30s.

Updated

• Google Pay integration with Mangopay has been improved. This payment method is in private beta. Please contact support if you have any questions.

Fixed

• MBWay & PayPal are now using Web Execution Type.

Added

Paypal integration with Mangopay has been improved. This payment method is in private beta. Please contact support if you have any questions.

Fixed

• Phone parameter instead of PhoneNumber for MBWay

Fixed

• linter issue for the new Mbway PayIn model

Added

• MB WAY is now available as a payment method with Mangopay. This payment method is in private beta. Please contact support if you have any questions.

Added

Knowing when a dispute was closed is now possible thanks to the new ClosedDate parameter for the Dispute object.

The following endpoints have been updated accordingly:

Vew a Dispute

List Disputes for a User

List Disputes for a Wallet

List all Disputes

List Disputes that need settling

Please note that the new ClosedDate field will only display values for the Disputes closed after this release. Otherwise, a null value will be returned.

Fixed

• Fix bug preventing access to authentication endpoint

Added

Verifying some specific legal structures is now more efficient thanks to a new legal entity type: PARTNERSHIP.

The Legal User LegalPersonType parameter now includes the PARTNERSHIP value. The following endpoints have been updated accordingly:

Create a Legal User (Payer)

Create a Legal User (Owner)

Update a Legal User

Please note that changing the LegalPersonType to PARTNERSHIP for an existing user will automatically result in:

• A KYC downgrade to Light (default) verification
• The REGISTRATION_PROOF document being flagged as OUT_OF_DATE.

With this new LegalPersonType, the MANGOPAY team can better handle specific legal structures and speed up the validation process.

Added

New 30-day preauthorization feature

Preauthorizations can now hold funds for up to 30 days, therefore ensuring the solvency of a registered card for the same amount of time.

• The ApiDeposits class has been added with methods for creating, fetching and canceling a deposit
• The CreateCardPreAuthorizedDepositPayIn() method has been added to the ApiPayIns class

Thanks to 30-day preauthorizations, MANGOPAY can provide a simpler and more flexible payment experience for a wide range of use cases, especially for rentals.

Fixed

• 565 : Add Id on PayInRecurringRegistration
• 564 : Fix type hint for RemainingFunds
• 563 : Added CardId property to PayInExecutionDetailsDirect and used “int” as types for identifiers

Thanks @AntoineLemaire & @garsaud

Fixed

Tests have been fixed due to API updates

##Added New country authorizations endpoints

Country authorizations can now be viewed by using one of the following endpoints:

View a country's authorizations View all countries' authorizations

With these calls, it is possible to check which countries have:

• Blocked user creation
• Blocked bank account creation
• Blocked payout creation

Please refer to the Restrictions by country article for more information.

##Added Recurring: €0 deadlines for CIT

Setting free recurring payment deadlines is now possible for CIT (customer-initiated transactions) with the FreeCycles parameter.

The FreeCycles parameter allows platforms to define the number of consecutive deadlines that will be free. The following endpoints have been updated to take into account this new parameter:

Create a Recurring PayIn Registration View a Recurring PayIn Registration

This feature provides new automation capabilities for platforms with offers such as “Get the first month free” or “free trial” subscriptions.

Please refer to the Recurring payments overview documentation for more information.

Fixed

Implementation of UserCategory has been simplified

Added

UserCategory management

Users can now be differentiated depending on their MANGOPAY usage.

This is possible with the new UserCategory parameter, whose value can be set to:

• Payer – For users who are only using MANGOPAY to give money to other users (i.e., only pay).
• Owner – For users who are using MANGOPAY to receive funds (and who are therefore required to accept MANGOPAY’s terms and conditions).

Please note that the following parameters become required as soon as the UserCategory is set to “Owner”:

• HeadquartersAddress
• CompanyNumber (if the LegalPersonType is “Business”)
• TermsAndConditionsAccepted.

The documentation of user-related endpoints has been updated and reorganised to take into account the new parameter:

Create a Natural User (Payer) Create a Natural User (Owner) Update a Natural User Create a Legal User (Payer) Create a Legal User (Owner) Update a Legal User View a User List all Users

Differentiating the platform users results in a smoother user experience for “Payers” as they will have less declarative data to provide.

RecurringPayinRegistrationId in all PayIn GET calls

A PR to add the missing RecurringPayinRegistrationId to all PayIn get calls to match the MangoPay API calls. Thanks @H4wKs

#552

Fix in ReportRequest Entity

#551

Thanks @Asenar

Added

Terms and conditions acceptance parameter

The acceptance of the MANGOPAY terms and conditions by the end user can now be registered via the SDK.

This information can be managed by using the new TermsAndConditionsAccepted parameter added to the User object.

The following API endpoints have been updated to take into account the new TermsAndConditionsAccepted parameter:

Create a Natural User Update a Natural User Create a Legal User Update a Legal User View a User

Please note that:

• Existing users have to be updated to include the terms and conditions acceptance information.
• Once accepted, the terms and conditions cannot be revoked.

Added

Instant payment eligibility check

With the function PayOuts->CheckInstantPayoutEligibility($params); the destination bank reachability can now be verified prior to making an instant payout. This results in a better user experience, as this preliminary check will allow the platform to propose the instant payout option only to end users whose bank is eligible.

• New endpoint : GET .../v2.01/ClientId/preauthorizations/PreAuthorizationId/transactions/ which allows multiple transactions to be listed
• Testing config changes for TLS, this was blocking a part of the deploy process
• Sorting::_sortFields changed to avoid an error when calling GetSortParameter()
• Changed ignore phpunit-cache and minor "Field" typo
• removed php 5.4 and 5.5 from travis and updated curl ssl version

• New endpoint to support changes to Card Validation process (please listen out for product announcements)
• New RemainingFunds Parameters (Complete feature not fully activated, please listen for product announcements)
• Fix to PayInWebExtendedView

• As part of KYC improvements, we are adding an OUT_OF_DATE status for KYC documents
• New MultiCapture Parameter added to Preauthorization object (Complete feature not fully activated, please listen for product announcements)
• "User-agent" format in the headers changed, aligned to other assets
• Improvements to error handling for RestTool.php requests

Changed

• GET EMoney method now supports year and month parameters. More info on our docs

Fixed

• Add missing isActiveproperty for UBOs

Fixed

• missing UBO EventTypes has been added

Added

• new UBODelaration submission system
• CompanyNumber support for Legal Users

Fixed

• Pagination has been fixed as total pages/items value was always zero.

• Fixed UBO declaration by adding missing UserId
• Added missing Billing in /payins/card/web
• Test on IpAddress presence in /payins/card/direct

[3.2.0] - 2021-02-19

• 3DS2 integration with Shipping and Billing objects, including FirstName and a LastName fields The objects Billing and Shipping may be included on all calls to the following endpoints:
  • /preauthorizations/card/direct
  • /payins/card/direct
  • /payins/card/web
• Activate Instant Payment for payouts by adding a new parameter PayoutModeRequested on the following endpoint /payouts/bankwire
  • The new parameter PayoutModeRequested can take two differents values : "INSTANT_PAYMENT" or "STANDARD" (STANDARD = the way we procede normaly a payout request)
  • This new parameter is not mandatory and if empty or not present, the payout will be "STANDARD" by default
  • Instant Payment is in beta all over Europe - SEPA region
• Fix inverted params for PHP compatibility : Due to compatibility issues with newer versions of PHP we have inverted params in certain methods, including constructor, please check the release code for further detail 🔄
• Fix method ScopeBlocked for blocked status
• Fix BrowserInfo class

[3.1.6] - 2020-12-18

Added IpAddress and BrowserInfo parameters to the following endpoints and corresponding objects

• /payins/card/direct
• /preauthorizations/card/direct

Added 'NO_CHOICE' value for the SecureMode parameter

[3.1.5] - 2020-12-11

• Removed testing older PHP testing versions
• Added 'Regulatory' endpoint to allow checks of User Block Status
• Added support for Regulatory -> Blocked Status Hooks
• Added methods for creating Client bank accounts and client payouts

• To better illustrate the fact that Rate Limiting Reset is a timestamp, we have change $rateLimits[0]->ResetTimeMillis to $rateLimits[0]->ResetTimeTimestamp

On demand feature for 3DSv2

This on-demand feature is for testing purposes only and will not be available in production

Request

We've added a new parameter Requested3DSVersion (not mandatory) that allows you to choose between versions of 3DS protocols (managed by the parameter SecureMode). Two values are available:

• V1
• V2_1

If nothing is sent, the flow will be 3DS V1.

The Requested3DSVersion may be included on all calls to the following endpoints:

• /preauthorizations/card/direct
• /payins/card/direct

Response

In the API response, the Requested3DSVersion will show the value you requested:

• V1
• V2_1
• null – indicates that nothing was requested

The parameter Applied3DSVersion shows you the version of the 3DS protocol used. Two values are possible:

• V1
• V2_1

• USER_KYC_REGULAR has been added as a new Event. Thanks to it, you are now able to know when all the needed KYCs for a user have been validated and its KYCLevel is updated.
• Release adds typing for EventType values KYC_OUTDATED USER_KYC_REGULAR and USER_KYC_LIGHT
• Updated filtering on user Cards list
• Google Pay are ready to be supported!
• AccountNumber has been added for Payin External Instruction as a part of DebitedBankAccountDetails. Funds from a non-IBAN account are now better identified.

BREAKING CHANGES

• Add a new PAYLINEV2 parameter for Payin Web Card only. You must now use PayInCardTemplateURLOptions object instead of PayInTemplateURLOptions (if you use custom Template). You can always use PayInTemplateURLOptionsfor all of your Payin Direct Debit Web.

Added

• Mandate Status EXPIRED and EventType MANDATE_EXPIRED have been added.

Fixed

• Deprecated syntax on RestTool.php file for PHP 7.4 version.

Added

• ApplePay Payin functions are now available. More info about activation to come in the following weeks...
• UBODeclaration can be retrieved only with its ID thanks to new GetByIdfunction
• COUNTERFEIT_PRODUCT added as a new DisputeReasonType
• GetEMoney function has been fixed due to too many mandatory parameters.