The Deposit Preauthorization object
Warning – Deprecated feature
The Deposit Preauthorization object is deprecated. Use the Extended Preauthorization object instead.
The Deposit Preauthorization endpoints are scheduled for decommissioning at the end of 2027. Platforms with existing integrations need to move to the new endpoints at their earliest convenience before then.
The Extended Preauthorization feature is a like-for-like renaming of the legacy Deposit Preauthorization – the behavior is otherwise unchanged.
The previous use of the term “deposit” was for convenience only and does not constitute a traditional banking deposit under applicable banking regulations, including the EU Capital Requirements Directive (Directive 2013/36/EU) or the Deposit Guarantee Schemes Directive (Directive 2014/49/EU). Accordingly, these funds are not covered by any statutory deposit protection schemes, and Mangopay does not operate as a licensed banking institution.
Regardless of which endpoint was used to capture the preauthorized funds, the pay-in object returns both the ExtendedPreauthorizationId and the now-deprecated DepositId containing the same unique identifier.
The prefix of the unique identifier allows you to determine the endpoint used to create the preauthorization:
ext_auth_wt_<uuid>– POST Create a Card Extended Preauthorization or POST Create a PayPal Extended Preauthorizationdeposit_wt_<uuid>– POST Create a Card Deposit Preauthorization or POST Create a PayPal Deposit Preauthorization
Description
The Deposit Preauthorization object enables you to reserve funds on a card so they can be captured later, using two API calls:
- Authorization of the transaction, handled by the Deposit Preauthorization object
- Capture of the funds, handled by the Deposit Preauthorized PayIn object
The Deposit Preauthorization object is used for two payment methods, indicated by the PaymentType:
CARD– Created using POST Create a Card Deposit PreauthorizationPAYPAL– Created using POST Create a PayPal Deposit Preauthorization
In both cases, the capture is made with the same endpoint, POST Create a Deposit Preauthorized PayIn:
CARD– Within 29.5 days.PAYPAL– Within 3 days as recommended by PayPal, but the technical limit is 29 days (not 29.5).
Note that preauthorizations may not be permitted by some issuers and for some card types.
Note – Multi-capture not possible with the Deposit Preauthorization
Multiple partial captures are not possible with the Deposit Preauthorization, for either CARD or PAYPAL. In both cases however, the single capture can be for an amount less than the preauthorized amount.