--- title: "List Preauthorizations for a User" method: GET path: "/v2.01/{ClientId}/users/{UserId}/preauthorizations" tags: ["Preauthorizations"] --- # List Preauthorizations for a User `GET /v2.01/{ClientId}/users/{UserId}/preauthorizations` List Preauthorizations for a User ## Path parameters - `ClientId` string, required - `UserId` string, required ## Headers - `Authorization` string, required ## Response `200` Success - ListPreauthorizationsForACardResponse - `Array (Preauthorizations)` ListPreauthorizationsForACardResponseArrayPreauthorizationsItems[] — The list of preauthorizations created by the platform. - `Preauthorization` ListPreauthorizationsForACardResponseArrayPreauthorizationsItemsPreauthorization — The preauthorization created by the platform. - `Id` string — The unique identifier of the preauthorization. - `Tag` string — 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. - `CreationDate` integer — Unix timestamp (UTC) of the date and time the object was created. - `AuthorId` string — 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. - `DebitedFunds` ListPreauthorizationsForACardResponseArrayPreauthorizationsItemsPreauthorizationDebitedFunds — Information about the preauthorized funds. - `Currency` string — **Allowed 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 amount. - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`. - `RemainingFunds` ListPreauthorizationsForACardResponseArrayPreauthorizationsItemsPreauthorizationRemainingFunds — Information about the remaining preauthorized funds. - `Currency` string — **Allowed 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 amount. - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`. - `AuthorizationDate` integer — Unix timestamp (UTC) of the date and time successful authorization occurred. If authorization failed, the value is `null`. - `Status` string — **Returned values:** `CREATED`, `SUCCEEDED`, `FAILED` The status of the authorization. - `PaymentStatus` string — **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. - `ExpirationDate` integer — Unix timestamp (UTC) of the date and time 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. - `PayInId` string — The unique identifier of the first preauthorized pay-in made against the preauthorization. - `ResultMessage` string — The explanation of the result code. - `SecureMode` string — **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. - `CardId` string — The unique identifier of the Card object, which is returned after updating the Card Registration object with the `RegistrationData`. - `SecureModeReturnURL` string — The URL to which users are automatically returned after 3DS2 if it is triggered (i.e., if the `SecureModeNeeded` parameter is set to `true`). - `SecureModeNeeded` boolean — Whether or not the `SecureMode` was used. - `PaymentType` string — **Returned values:** `CARD` The payment type of the preauthorization. - `ExecutionType` string — **Returned values:** `DIRECT` The execution type of the preauthorization. - `StatementDescriptor` string — 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. - `Culture` string — **Returned values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): DE, EN, ES, FR, IT, NL, PL, PT. The language in which the payment page is to be displayed. - `SecurityInfo` AVSResult — Information regarding security and anti-fraud tools. - `AVSResult` string — The result of the Address Verification System check (only available for UK, US, and Canada). - `MultiCapture` boolean — **Default value:** true Whether multiple captures are activated for the preauthorization. - `BrowserInfo` BrowserInfo — Information about the browser used by the end user (author) to perform the payment. - `AcceptHeader` string, required — The exact content of the HTTP accept headers as sent to the platform from the end user's browser. - `JavaEnabled` boolean, required — Whether or not the end user's browser has the ability to execute Java. - `Language` string, required — 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. - `ColorDepth` integer, required — The value representing the depth of the screen's color palette for displaying images, in bits per pixel. - `ScreenHeight` integer, required — The height of the screen in pixels. - `ScreenWidth` integer, required — The width of the screen in pixels. - `TimeZoneOffset` integer, required — The difference in minutes between the browser's timezone and UTC. - `UserAgent` string, required — The exact content of the HTTP User-Agent header. - `JavascriptEnabled` boolean, required — Whether or not the end user's browser has the ability to execute JavaScript. - `Billing` BillingDefaultsShippingUserResponse — **Default values:** `FirstName`, `LastName`, and `Address` information of the `Shipping` object if sent, otherwise of the `AuthorId` (if address values present). Information about the billing address. - `FirstName` string — The first name of the user. - `LastName` string — The last name of the user. - `Address` Address — The postal address. - `AddressLine1` string — The first line of the address. - `AddressLine2` string — The second line of the address. - `City` string — The city of the address. - `Region` string — Required if `Country` is US, CA, or MX. The region of the address. - `PostalCode` string — The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces. - `Country` string — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address. - `Shipping` ShippingDefaultsBillingUserResponse — **Default values:** `FirstName`, `LastName`, and `Address` information of the `Billing` object if sent, otherwise of the `AuthorId` (if address values present). Information about the shipping address. - `FirstName` string — The first name of the user. - `LastName` string — The last name of the user. - `Address` AddressSubPropsRequired — The postal address. - `AddressLine1` string, required — The first line of the address. - `AddressLine2` string — The second line of the address. - `City` string, required — The city of the address. - `Region` string — Required if `Country` is US, CA, or MX. The region of the address. - `PostalCode` string, required — The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces. - `Country` string, required — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address. - `Requested3DSVersion` string — **Returned values:** `V1`, `V2_1` The 3DS protocol version to be applied to the transaction. - `Applied3DSVersion` string — **Returned values:** `V1`, `V2_1` The 3DS protocol version applied to the transaction. - `PreferredCardNetwork` string — **Returned values:** `VISA`, `MASTERCARD`, `CB`, `MAESTRO` The card network to use, as chosen by the cardholder, in case of co-branded cards. - `CardInfo` CardInfo — Information about the card used for the transaction. If the information or data is not available, `null` is returned. - `BIN` string — The bank identification number (BIN) of the card. - `IssuingBank` string — The name of the bank that issued the card. - `IssuerCountryCode` string — The country code of the card issuer. - `Type` string — The type of card (for example, `CREDIT` or `DEBIT`). - `SubType` string, nullable — The sub-type of the card, if available. - `Brand` string — The card brand (for example, `VISA` or `MASTERCARD`). --- [API](https://skmtc.dev/mangopay/apis/api-reference.md) · [All operations](https://skmtc.dev/mangopay/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mangopay/api-reference/revisions/fafbd0c69654/schema)