Description
The Preauthorization object enables you to reserve funds on a card so they can be captured later. A preauthorization thus has two parts:- Authorization of the transaction, handled by the Preauthorization object
- Capture of the funds, handled by the Preauthorized PayIn object
Note – Multi-capture available with Visa, Mastercard, CB, and AMEXMultiple partial captures of the preauthorized amount is possible on the card types:
CB_VISA_MASTERCARDAMEX
RemainingFunds can be made if the PaymentStatus is WAITING.There is no limit to the number of captures that can be made if each is valid.Attributes
Max. length: 255 charactersCustom data that you can add to this object.
For preauthorizations, you can use this parameter to identify corresponding information regarding the user or transaction on your platform.
For preauthorizations, you can use this parameter to identify corresponding information regarding the user or transaction on your platform.
The date and time at which successful authorization occurred. If authorization failed, the value is
null.Returned values:
WAITING, CANCELED, EXPIRED, VALIDATEDThe status of the preauthorization object:WAITING– The remaining preauthorized funds can be captured by making one or several preauthorized pay-ins. Pay-ins can only be made against a preauthorization with theWAITINGstatus.CANCELED– The preauthorization was canceled manually before any preauthorized pay-ins were made, or it was canceled automatically because the authorization failed.EXPIRED– The hold period on the preauthorized funds has ended without any preauthorized pay-ins taking place.VALIDATED– During the hold period: Indicates that all the preauthorized funds have been captured (RemainingFundsis zero) and no more preauthorized pay-ins can be made. After the hold period: Indicates that at least one capture was made during the hold period.
The date and time at which the hold period ends and the preauthorized funds are released.
At the expiration date, the preauthorization’s
At the expiration date, the preauthorization’s
PaymentStatus changes to EXPIRED if no captures were made or VALIDATED if at least one capture was made.The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
Default value: DEFAULTThe mode applied for the 3DS2 protocol for CB, Visa, and Mastercard. The options are:
DEFAULT– Requests an exemption to strong customer authentication (SCA), and thus a frictionless payment experience, if allowed by your Mangopay contract and accepted by the issuer.FORCE– Requests SCA.NO_CHOICE– Leaves the choice to the issuer whether to allow for a frictionless payment experience or to enforce SCA.
Max. length: 255 charactersThe URL to which users are automatically returned after 3DS2 if it is triggered (i.e., if the
SecureModeNeeded parameter is set to true).Max. length: 255 charactersThe URL to which to redirect the user to proceed to 3DS2 validation.Caution: This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it.
Max. length: 10 characters; only alphanumeric and spacesCustom description to appear on the user’s bank statement along with the platform name. Different banks may show more or less information. See the Customizing bank statement references article for details.
Returned values: One of the supported languages in the ISO 639-1 format: DE, EN, ES, FR, IT, NL, PL, PT.The language in which the payment page is to be displayed.
Default value: FirstName, LastName, and Address information of the Shipping object if any, otherwise the user (author).Information about the end user billing address. If left empty, the default values will be automatically taken into account.
Default value: FirstName, LastName, and Address information of the Billing object, if supplied, otherwise of the user (author).Information about the end user’s shipping address.
Returned values:
VISA, MASTERCARD, CB, MAESTROThe card network to use, as chosen by the cardholder, in case of co-branded cards.Default value:
ECommerceAllowed values: ECommerce, TelephoneOrderThe channel through which the user provided their card details, used to indicate mail-order and telephone-order (MOTO) payments:ECommerce– Payment received online.TelephoneOrder– Payment received via mail order or telephone order (MOTO).
Information about the card used for the transaction.
If the information or data is not available,
If the information or data is not available,
null is returned.The unique reference generated for the profiling session, used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.Note: Parameter not returned by the API. Profiling feature available on request – contact Mangopay via the Dashboard for more information.
Information about the authentication result, based on the request made by Mangopay and the decision of the issuer regarding the type of authentication to be enforced (if applicable).
Related resources
Guide
Learn more about 7-day preauthorization