List Preauthorizations for a Card

Max. length: 255 characters

The unique identifier of the preauthorization.

Max. length: 255 characters

Custom 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.

The date and time at which the object was created.

The unique identifier of the user at the source of the transaction. In a conversion, both the debited and credited wallets are owned by the author.

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, FAILED

The status of the authorization.

Returned values: WAITING, CANCELED, CANCEL_REQUESTED, EXPIRED, TO_BE_COMPLETED, NO_SHOW_REQUESTED, NO_SHOW, VALIDATED, FAILED

The payment status of the deposit preauthorization object:

• WAITING – The deposit preauthorization can be used: the preauthorized funds can be captured (without or prior to complement); a no-show can be declared; or the preauthorization can be canceled manually.
• CANCELED – Value to pass to manually cancel the deposit preauthorization before use (whether for capture or no-show); indicates that the deposit preauthorization was canceled manually.
• CANCEL_REQUESTED – The cancellation of the deposit preauthorization has been requested but not yet processed.
• EXPIRED – The hold period on the preauthorized funds has ended without it being used (whether for capture or no-show).
• TO_BE_COMPLETED – The preauthorized funds were captured (prior to complement) but the complement has not yet been captured.
• NO_SHOW_REQUESTED – Value to pass to request a no-show, signaling no capture of the preauthorized funds but the intent to capture a complement.
• NO_SHOW – A no-show was requested but a complement not yet been captured.
• VALIDATED – Indicates either (i) that the preauthorized funds were captured without complement; (ii) that the preauthorized funds and a complement were captured; or (iii) that a no-show was declared and a complement was captured.
• FAILED – The action against the preauthorization has failed (whether capture without complement, capture prior to complement, no-show request, complement), but a retry may be possible.

The date and time at which the hold period ends and the preauthorized funds are released.
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 first preauthorized pay-in made against the preauthorization.

The explanation of the result code.

Returned values: DEFAULT, FORCE, NO_CHOICE

The 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, which is returned after updating the Card Registration object with the RegistrationData.

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).

Whether or not the SecureMode was used.

Returned values: APPLEPAY

The type of pay-in.

Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTION

The type of execution for the pay-in.

Max. length: 10 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 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: true

Whether multiple captures are activated for the preauthorization.

Information about the browser used by the end user (author) to perform the payment.

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_1

The 3DS protocol version to be applied to the transaction.

Returned values: V1, V2_1

The 3DS protocol version applied to the transaction.

Returned values: VISA, MASTERCARD, CB, MAESTRO

The card network to use, as chosen by the cardholder, in case of co-branded card products.

Information about the card used for the transaction.

If the information or data is not available, null is returned.