Create a Card Extended Preauthorization
Changed onThis endpoint creates an Extended Preauthorization with PaymentType of CARD and returns the RedirectURL on which the user can preauthorize the debited funds.
Once authorized (Status becomes SUCCEEDED), you can capture the funds using the POST Create an Extended Preauthorized PayIn endpoint.
Request
- Base URLhttps://api.sandbox.mangopay.com
- URLhttps://api.sandbox.mangopay.com/v2.01/{ClientId}/extended-preauthorizations/card/direct
- AuthHTTP bearer
Path parameters
Platform's API account identifier, associated with the API key.
Request body
The unique identifier of the user at the source of the transaction.
The unique identifier of the Card object, obtained during the card registration process.
Allowed values: VISA, MASTERCARD, CB, MAESTRO
The card network to use, as chosen by the cardholder, in case of <a href="/guides/payment-methods/card/co-branded">co-branded cards</a>.
Max. length: 255 characters
The 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: 22 characters; only alphanumeric and spaces
Custom description to appear on the user’s bank statement along with the platform name. Different banks may show more or less information. See the <a href="/bank-statements">Customizing bank statement references</a> article for details.
Allowed 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.
The IP address of the end user initiating the transaction, in IPV4 or IPV6 format.
Max. length: 255 characters
Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".
The unique reference generated for the profiling session, used by the <a href="/guides/fraud-prevention">fraud prevention</a> 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 <a href="https://hub.mangopay.com/" target="_blank">via the Dashboard</a> for more information.
Response
Success
Max length: 128 characters (see data formats for details)
The unique identifier of the object.
Unix timestamp (UTC) of the date and time the object was created.
Unix timestamp (UTC) of the date and time the hold period ends and the preauthorized funds are released. At the expiration date, the extended preauthorization's PaymentStatus changes to EXPIRED if no captures were made.
Unix timestamp (UTC) of the date and time successful authorization occurred. If authorization failed, the value is null.
The unique identifier of the user at the source of the transaction.
Returned values: CREATED, SUCCEEDED, FAILED
The status of the authorization.
Returned values: WAITING, CANCELED, CANCEL_REQUESTED, EXPIRED, VALIDATED, FAILED
The payment status of the extended preauthorization object:
- WAITING – The extended preauthorization can be used: the preauthorized funds can be captured (if Status is SUCCEEDED) or the preauthorization can be canceled manually.
- CANCELED – Value to pass to manually cancel the extended preauthorization before use; indicates that the extended preauthorization was canceled manually.
- CANCEL_REQUESTED – The cancellation of the extended preauthorization has been requested but not yet processed.
- EXPIRED – The hold period on the preauthorized funds has ended without it being used.
- VALIDATED – Indicates that the preauthorized funds were captured.
- FAILED – The pay-in against the preauthorization has failed, but a retry may be possible.
The code indicating the result of the operation. This information is mostly used to <a href="/errors/codes">handle errors</a> or for filtering purposes.
The explanation of the result code.
Returned values: CARD
The payment type of the preauthorization.
Returned values: DIRECT
The execution type of the preauthorization.
Max. length: 22 characters; only alphanumeric and spaces
Custom description to appear on the user’s bank statement along with the platform name. Different banks may show more or less information. See the <a href="/bank-statements">Customizing bank statement references</a> 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.
Max. length: 255 characters
Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".
The unique identifier of the Card object, obtained during the card registration process.
Allowed values: VISA, MASTERCARD, CB, MAESTRO
The card network to use, as chosen by the cardholder, in case of <a href="/guides/payment-methods/card/co-branded">co-branded cards</a>.
Max. length: 255 characters
The 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 characters
The URL to which to redirect the user to proceed to 3DS2 validation.
Whether or not the SecureMode was used.
The IP address of the end user initiating the transaction, in IPV4 or IPV6 format.
Returned values: V1, V2_1
The 3DS protocol version to be applied to the transaction.
Returned values: V1, V2_1
The 3DS protocol version applied to the transaction.
Changes
- info
endpoint added
- info