Preauthorizations
Cancel or validate a Preauthorization
PUT
This call is used to manually close the preauthorization hold period before the
ExpirationDate, thereby releasing the preauthorized funds.
The PaymentStatus can be set to:
CANCELEDwhen no preauthorized pay-ins have been made to capture funds. Trying to cancel a used preauthorization returns an error.VALIDATEDwhen at least one preauthorized pay-in has been made to capture funds. Trying to validate an unused preauthorization returns an error.
Caution – Canceling or validating a preauthorization is irreversibleA preauthorization with the
CANCELED or VALIDATED status can’t be reused.Path parameters
The unique identifier of the preauthorization.
Body parameters
Allowed values:
CANCELED, 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.
Responses
200 - Canceled (no captures)
200 - Canceled (no captures)
Max. length: 255 charactersThe unique identifier of the preauthorization.
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 the object was created.
The unique identifier of the user at the source of the transaction.
Information about the preauthorized funds.
Information about the remaining preauthorized funds.
The date and time at which successful authorization occurred. If authorization failed, the value is
null.Returned values:
CREATED, SUCCEEDED, FAILEDThe status of the authorization.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 unique identifier of the pay-in.
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
The explanation of the result code.
Returned values:
DEFAULT, FORCE, NO_CHOICEThe 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.
The unique identifier of the Card object, obtained during the card registration process.
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.
Whether or not the
SecureMode was used.Returned values:
CARD, DIRECT_DEBIT, PREAUTHORIZED, BANK_WIREThe type of pay-in.Returned values:
WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.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.
Information regarding security and anti-fraud tools.
Default value: trueWhether multiple captures are activated for the preauthorization.
Information about the browser used by the end user (author) to perform the payment.
The IP address of the end user initiating the transaction, in IPV4 or IPV6 format.
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. If left empty, the default values will be automatically taken into account.
Returned values:
V1, V2_1The 3DS protocol version to be applied to the transaction.Returned values:
V1, V2_1The 3DS protocol version applied to the transaction.Returned values:
VISA, MASTERCARD, CB, MAESTROThe card network to use, as chosen by the cardholder, in case of co-branded cards.Information about the card used for the transaction.If the information or data is not available,
null is returned.200 - Validated following successful capture
200 - Validated following successful capture
Max. length: 255 charactersThe unique identifier of the preauthorization.
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 the object was created.
The unique identifier of the user at the source of the transaction.
Information about the preauthorized funds.
Information about the remaining preauthorized funds.
The date and time at which successful authorization occurred. If authorization failed, the value is
null.Returned values:
CREATED, SUCCEEDED, FAILEDThe status of the authorization.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 unique identifier of the pay-in.
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
The explanation of the result code.
Returned values:
DEFAULT, FORCE, NO_CHOICEThe 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.
The unique identifier of the Card object, obtained during the card registration process.
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.
Whether or not the
SecureMode was used.Returned values:
CARD, DIRECT_DEBIT, PREAUTHORIZED, BANK_WIREThe type of pay-in.Returned values:
WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.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.
Information regarding security and anti-fraud tools.
Default value: trueWhether multiple captures are activated for the preauthorization.
Information about the browser used by the end user (author) to perform the payment.
The IP address of the end user initiating the transaction, in IPV4 or IPV6 format.
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. If left empty, the default values will be automatically taken into account.
Returned values:
V1, V2_1The 3DS protocol version to be applied to the transaction.Returned values:
V1, V2_1The 3DS protocol version applied to the transaction.Returned values:
VISA, MASTERCARD, CB, MAESTROThe card network to use, as chosen by the cardholder, in case of co-branded cards.Information about the card used for the transaction.If the information or data is not available,
null is returned.400 - Cancel attempted after capture
400 - Cancel attempted after capture
400 - Validation attempted before capture
400 - Validation attempted before capture