> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mangopay.com/llms.txt
> Use this file to discover all available pages before exploring further.
# List Deposit Preauthorizations for a User
### Query parameters
The code indicating the result of the operation. You can filter on multiple values by separating them with a comma.
**Allowed values:** `CREATED`, `SUCCEEDED`, `FAILED`
The status of the transaction. You can filter on multiple values by separating them with a comma.
**Allowed values:** `WAITING`, `CANCELED`, `CANCEL_REQUESTED`, `EXPIRED`, `VALIDATED`, `FAILED`
The payment status of the deposit preauthorization object:
* `WAITING` – The deposit 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 deposit preauthorization before use; 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.
* `VALIDATED` – Indicates that the preauthorized funds were captured.
* `FAILED` – The pay-in against the preauthorization has failed, but a retry may be possible.
### Responses
List of deposit preauthorizations created by the platform.
The deposit preauthorization created by the platform.
Max. length: 255 characters
The date and time at which the object was created.
The date and time at which the hold period ends and the preauthorized funds are released.\
At the expiration date, the deposit preauthorization’s `PaymentStatus` changes to `EXPIRED` if no captures were made.
The date and time at which successful authorization occurred. If authorization failed, the value is `null`.
The unique identifier of the user at the source of the transaction.
Information about the debited funds.
**Returned values:** The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the debited funds (the sell currency).
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`).
During a conversion, (`DebitedFunds.Amount` - `Fees`) \* `MarketRate` = `CreditedFunds.Amount`.
**Returned values:** `CREATED`, `SUCCEEDED`, `FAILED`
The status of the transaction.
**Returned values:** `WAITING`, `CANCELED`, `CANCEL_REQUESTED`, `EXPIRED`, `VALIDATED`, `FAILED`
The payment status of the deposit preauthorization object:
* `WAITING` – The deposit 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 deposit preauthorization before use; 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.
* `VALIDATED` – Indicates that the preauthorized funds were captured.
* `FAILED` – The pay-in against the preauthorization has failed, but a retry may be possible.
Information about the deposit preauthorized pay-ins made against the deposit preauthorization.
The unique identifier of the preauthorized pay-in (capture) made against the deposit preauthorization to debit the preauthorized funds.
This deprecated parameter is always returned `null`.
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.
The unique identifier of the Card object, which is returned after updating the Card Registration object with the `RegistrationData`.
**Returned values:** `VISA`, `MASTERCARD`, `CB`, `MAESTRO`
The card network to use, as chosen by the cardholder, in case of co-branded cards.
Max. length: 255 characters
The URL to which to redirect the user to proceed to 3DS2 validation.
Whether or not the `SecureMode` was used.
**Returned values:** `KLARNA`
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: CS, DA, DE, EL, EN, ES, FI, FR, HU, IT, NL, NO, PL, PT, SK, SV.
The language in which the payment page is to be displayed.
Information about the browser used by the end user (author) to perform the payment.
The exact content of the HTTP accept headers as sent to the platform from the end user’s browser.
Whether or not the end user’s browser has the ability to execute Java.
Format: Two-letter language code (ISO 639-1 alpha-2) followed by two-letter country code (ISO 3166-1 alpha-2), separated by a hyphen (example: `en-US`; pattern:`^[a-zA-Z]{2}(-[a-zA-Z]{2})?$`)
The language of the browser.
The value representing the depth of the screen’s color palette for displaying images, in bits per pixel.
Max. length: 6 characters
The height of the screen in pixels.
Max. length: 6 characters
The width of the screen in pixels.
The difference in minutes between the browser’s timezone and UTC.
Max. length: 255 characters
The exact content of the HTTP User-Agent header.
Whether or not the end user’s browser has the ability to execute JavaScript.
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 supplied.
Information about the end user's billing address. If left empty, the default values will be automatically taken into account.
The first name of the user.
Max. length: 100 characters
The last name of the user.
Information about the billing address.
Max. length: 255 characters
The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters
The city of the address.
Max. length: 255 characters
The region of the address. This field is optional except if the `Country` is US, CA, or MX.
Max. length: 255 characters
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))
The country of the address.
Information about the end user’s shipping address. If left empty, the default values will be automatically taken into account.
The first name of the user.
Max. length: 100 characters
The last name of the user.
Information about the shipping address.
Max. length: 255 characters
The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters
The city of the address.
Max. length: 255 characters
The region of the address. This field is optional except if the `Country` is US, CA, or MX.
Max. length: 255 characters
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))
The country of the address.
**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.
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.
Information about the card used for the transaction.
If the information or data is not available, `null` is returned.
The 6-digit bank identification number (BIN) of the card issuer.
The name of the card issuer.
Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))
The country where the card was issued.
**Returned values:** `DEBIT`, `CREDIT`, `CHARGE CARD`.
The type of card product.
The card brand. Examples include: `AMERICAN EXPRESS`, `DISCOVER`, `JCB`, `MASTERCARD`, `VISA`, etc.
**Note:** The possible returned values are numerous and liable to evolve over time.
The subtype of the card product. Examples include: `CLASSIC`, `GOLD`, `PLATINUM`, `PREPAID`, etc.
**Note:** The possible returned values are numerous and liable to evolve over time.
```json 200 theme={null}
[
{
"Id": "748bfd3c-96f0-4475-949b-3aedfa3bdcfc",
"CreationDate": 1696255231,
"ExpirationDate": 1698847231,
"AuthorizationDate": 1696255242,
"AuthorId": "204068024",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 22220
},
"Status": "SUCCEEDED",
"PaymentStatus": "CANCELED",
"PayinsLinked": {
"PayinCaptureId": null,
"PayinComplementId": null
},
"ResultCode": "000000",
"ResultMessage": "Success",
"CardId": "204068248",
"PreferredCardNetwork": null,
"SecureModeReturnURL": null,
"SecureModeRedirectURL": null,
"SecureModeNeeded": null,
"PaymentType": "CARD",
"ExecutionType": "DIRECT",
"StatementDescriptor": null,
"Culture": null,
"BrowserInfo": null,
"IpAddress": null,
"Billing": null,
"Shipping": null,
"Requested3DSVersion": null,
"Applied3DSVersion": null,
"Tag": "Created using Mangopay API Postman Collection",
"CardInfo": {
"BIN": "497010",
"IssuingBank": "LA BANQUE POSTALE",
"IssuerCountryCode": "MA",
"Type": "CREDIT",
"Brand": "VISA",
"SubType": null
}
}
]
```