> ## 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 Preauthorizations for a User

### Path parameters

<ParamField path="UserId" type="string" required>
  The unique identifier of the user.
</ParamField>

### Responses

<AccordionGroup>
  <Accordion title="200">
    <ResponseField name="Array (Preauthorizations)" type="array">
      The list of preauthorizations created by the platform.

      <Expandable title="properties">
        <ResponseField name="Preauthorization" type="object">
          The preauthorization created by the platform.

          <Expandable title="properties">
            <ResponseField name="Id" type="string">
              Max. length: 255 characters

              The unique identifier of the preauthorization.
            </ResponseField>

            <ResponseField name="Tag" type="string">
              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.
            </ResponseField>

            <ResponseField name="CreationDate" type="Unix timestamp">
              The date and time at which the object was created.
            </ResponseField>

            <ResponseField name="AuthorId" type="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.
            </ResponseField>

            <ResponseField name="DebitedFunds" type="object">
              Information about the preauthorized funds.

              <Expandable title="properties">
                <ResponseField name="Currency" type="string">
                  **Returned values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings).

                  The currency of the preauthorized funds.
                </ResponseField>

                <ResponseField name="Amount" type="integer">
                  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`).
                </ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="RemainingFunds" type="object">
              Information about the remaining preauthorized funds.

              <Expandable title="properties">
                <ResponseField name="Currency" type="string">
                  **Returned values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings).

                  The currency of the preauthorized funds.
                </ResponseField>

                <ResponseField name="Amount" type="integer">
                  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`).
                </ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="AuthorizationDate" type="Unix timestamp">
              The date and time at which successful authorization occurred. If authorization failed, the value is `null`.
            </ResponseField>

            <ResponseField name="Status" type="string">
              **Returned values:** `CREATED`, `SUCCEEDED`, `FAILED`

              The status of the authorization.
            </ResponseField>

            <ResponseField name="PaymentStatus" type="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.
            </ResponseField>

            <ResponseField name="ExpirationDate" type="Unix timestamp">
              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.
            </ResponseField>

            <ResponseField name="PayInId" type="string">
              The unique identifier of the first preauthorized pay-in made against the preauthorization.
            </ResponseField>

            <ResponseField name="ResultMessage" type="string">
              The explanation of the result code.
            </ResponseField>

            <ResponseField name="SecureMode" type="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.
            </ResponseField>

            <ResponseField name="CardId" type="string">
              The unique identifier of the Card object, which is returned after updating the Card Registration object with the `RegistrationData`.
            </ResponseField>

            <ResponseField name="SecureModeReturnURL" type="string">
              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`).
            </ResponseField>

            <ResponseField name="SecureModeNeeded" type="boolean">
              Whether or not the `SecureMode` was used.
            </ResponseField>

            <ResponseField name="PaymentType" type="string">
              **Returned values:** `APPLEPAY`

              The type of pay-in.
            </ResponseField>

            <ResponseField name="ExecutionType" type="string">
              **Returned values:** `WEB`, `DIRECT`, `EXTERNAL_INSTRUCTION`

              The type of execution for the pay-in.
            </ResponseField>

            <ResponseField name="StatementDescriptor" type="string">
              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 <a href="/bank-statements">Customizing bank statement references</a> article for details.
            </ResponseField>

            <ResponseField name="Culture" type="string">
              **Returned values:** One of the supported languages in the <a href="/api-reference/overview/data-formats">ISO 639-1 format</a>: DE, EN, ES, FR, IT, NL, PL, PT.

              The language in which the payment page is to be displayed.
            </ResponseField>

            <ResponseField name="SecurityInfo" type="object">
              Information regarding security and anti-fraud tools.

              <Expandable title="properties">
                <ResponseField name="AVSResult" type="string">
                  The result of the Address Verification System check (only available for UK, US, and Canada).
                </ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="MultiCapture" type="boolean">
              **Default value:** true

              Whether multiple captures are activated for the preauthorization.
            </ResponseField>

            <ResponseField name="BrowserInfo" type="object">
              Information about the browser used by the end user (author) to perform the payment.

              <Expandable title="properties">
                <ResponseField name="AcceptHeader" type="string">
                  The exact content of the HTTP accept headers as sent to the platform from the end user’s browser.
                </ResponseField>

                <ResponseField name="JavaEnabled" type="boolean">
                  Whether or not the end user’s browser has the ability to execute Java.
                </ResponseField>

                <ResponseField name="Language" type="string">
                  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.
                </ResponseField>

                <ResponseField name="ColorDepth" type="integer">
                  The value representing the depth of the screen’s color palette for displaying images, in bits per pixel.
                </ResponseField>

                <ResponseField name="ScreenHeight" type="integer">
                  Max. length: 6 characters

                  The height of the screen in pixels.
                </ResponseField>

                <ResponseField name="ScreenWidth" type="integer">
                  Max. length: 6 characters

                  The width of the screen in pixels.
                </ResponseField>

                <ResponseField name="TimeZoneOffset" type="integer">
                  The difference in minutes between the browser’s timezone and UTC.
                </ResponseField>

                <ResponseField name="UserAgent" type="string">
                  Max. length: 255 characters

                  The exact content of the HTTP User-Agent header.
                </ResponseField>

                <ResponseField name="JavascriptEnabled" type="boolean">
                  Whether or not the end user’s browser has the ability to execute JavaScript.
                </ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="Billing" type="object">
              **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.

              <Expandable title="properties">
                <ResponseField name="FirstName" type="string">
                  The first name of the user.
                </ResponseField>

                <ResponseField name="LastName" type="string">
                  Max. length: 100 characters

                  The last name of the user.
                </ResponseField>

                <ResponseField name="Address" type="object">
                  Information about the billing address.

                  <Expandable title="properties">
                    <ResponseField name="AddressLine1" type="string">
                      Max. length: 255 characters

                      The first line of the address.
                    </ResponseField>

                    <ResponseField name="AddressLine2" type="string">
                      Max. length: 255 characters

                      The second line of the address.
                    </ResponseField>

                    <ResponseField name="City" type="string">
                      Max. length: 255 characters

                      The city of the address.
                    </ResponseField>

                    <ResponseField name="Region" type="string">
                      Max. length: 255 characters

                      The region of the address. This field is optional except if the `Country` is US, CA, or MX.
                    </ResponseField>

                    <ResponseField name="PostalCode" type="string">
                      Max. length: 255 characters

                      The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
                    </ResponseField>

                    <ResponseField name="Country" type="string">
                      Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))

                      The country of the address.
                    </ResponseField>
                  </Expandable>
                </ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="Shipping" type="object">
              **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.

              <Expandable title="properties">
                <ResponseField name="FirstName" type="string">
                  The first name of the user.
                </ResponseField>

                <ResponseField name="LastName" type="string">
                  Max. length: 100 characters

                  The last name of the user.
                </ResponseField>

                <ResponseField name="Address" type="object">
                  Information about the shipping address.

                  <Expandable title="properties">
                    <ResponseField name="AddressLine1" type="string">
                      Max. length: 255 characters

                      The first line of the address.
                    </ResponseField>

                    <ResponseField name="AddressLine2" type="string">
                      Max. length: 255 characters

                      The second line of the address.
                    </ResponseField>

                    <ResponseField name="City" type="string">
                      Max. length: 255 characters

                      The city of the address.
                    </ResponseField>

                    <ResponseField name="Region" type="string">
                      Max. length: 255 characters

                      The region of the address. This field is optional except if the `Country` is US, CA, or MX.
                    </ResponseField>

                    <ResponseField name="PostalCode" type="string">
                      Max. length: 255 characters

                      The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
                    </ResponseField>

                    <ResponseField name="Country" type="string">
                      Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))

                      The country of the address.
                    </ResponseField>
                  </Expandable>
                </ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="Requested3DSVersion" type="string">
              **Returned values:** `V1`, `V2_1`

              The 3DS protocol version to be applied to the transaction.
            </ResponseField>

            <ResponseField name="Applied3DSVersion" type="string | null">
              **Returned values:** `V1`, `V2_1`

              The 3DS protocol version applied to the transaction.
            </ResponseField>

            <ResponseField name="PreferredCardNetwork" type="string">
              **Returned 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>.
            </ResponseField>

            <ResponseField name="CardInfo" type="string">
              Information about the card used for the transaction.

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

              <Expandable title="properties">
                <ResponseField name="BIN" type="string">
                  The 6-digit bank identification number (BIN) of the card issuer.
                </ResponseField>

                <ResponseField name="IssuingBank" type="string">
                  The name of the card issuer.
                </ResponseField>

                <ResponseField name="IssuerCountryCode" type="string">
                  Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))

                  The country where the card was issued.
                </ResponseField>

                <ResponseField name="Type" type="string">
                  **Returned values:** `DEBIT`, `CREDIT`, `CHARGE CARD`.

                  The type of card product.
                </ResponseField>

                <ResponseField name="Brand" type="string">
                  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.
                </ResponseField>

                <ResponseField name="SubType" type="string">
                  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.
                </ResponseField>
              </Expandable>
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Accordion>
</AccordionGroup>

<ResponseExample>
  ```json 200 theme={null}
  [
     {
         "Id": "156686696",
         "Tag": null,
         "CreationDate": 1669116896,
         "AuthorId": "156671912",
         "DebitedFunds": {
             "Currency": "EUR",
             "Amount": 500
         },
         "RemainingFunds": {
             "Currency": "EUR",
             "Amount": 0
         },
         "AuthorizationDate": 1669116904,
         "Status": "SUCCEEDED",
         "PaymentStatus": "VALIDATED",
         "ExpirationDate": 1669678504,
         "PayInId": "156686722",
         "ResultCode": "000000",
         "ResultMessage": "Success",
         "SecureMode": "FORCE",
         "CardId": "156674899",
         "SecureModeReturnURL": null,
         "SecureModeRedirectURL": null,
         "SecureModeNeeded": false,
         "PaymentType": "CARD",
         "ExecutionType": "DIRECT",
         "StatementDescriptor": null,
         "Culture": "EN",
         "SecurityInfo": null,
         "MultiCapture": true,
         "BrowserInfo": null,
         "IpAddress": null,
         "Billing": null,
         "Shipping": null,
         "Requested3DSVersion": null,
         "Applied3DSVersion": null,
         "PreferredCardNetwork": null,
         "CardInfo": {
             "BIN": "497010",
             "IssuingBank": "LA BANQUE POSTALE",
             "IssuerCountryCode": "MA",
             "Type": "CREDIT",
             "Brand": "VISA",
             "SubType": null
         }
     }
  ]  

  ```
</ResponseExample>

<RequestExample>
  ```php PHP theme={null}
  <?php 

  require_once 'vendor/autoload.php';

  use MangoPay\MangoPayApi;
  use MangoPay\Libraries\ResponseException as MGPResponseException;
  use MangoPay\Libraries\Exception as MGPException;

  $api = new MangoPayApi();

  $api->Config->ClientId = 'your-client-id';
  $api->Config->ClientPassword = 'your-api-key';
  $api->Config->TemporaryFolder = 'tmp/';

  try {
      $userId = 'user_m_01HQK25M6KVHKDV0S36JY9NRKR';

      $response = $api->Users->GetPreAuthorizations($userId);

      print_r($response);
  } catch(MGPResponseException $e) {
      print_r($e);
  } catch(MGPException $e) {
      print_r($e);
  }  
  ```

  ```javascript NodeJS   theme={null}
  const mangopayInstance = require('mangopay4-nodejs-sdk')
  const mangopay = new mangopayInstance({
    clientId: 'your-client-id',
    clientApiKey: 'your-api-key',
  })

  let user = {
    Id: '146476890',
  }

  const listUserPreauthorizations = async (userId) => {
    return await mangopay.Users.getPreAuthorizations(userId)
      .then((response) => {
        console.info(response)
        return response
      })
      .catch((err) => {
        console.log(err)
        return false
      })
  }

  listUserPreauthorizations(user.Id)  
  ```

  ```ruby Ruby   theme={null}
  require 'mangopay'

  MangoPay.configure do |client|
      client.preproduction = true
      client.client_id = 'your-client-id'
      client.client_apiKey = 'your-api-key'
      client.log_file = File.join(Dir.pwd, 'mangopay.log')
  end

  def listPreauthorizationsUser(userId)
      begin
          response = MangoPay::User.pre_authorizations(userId)
          puts response
          return response
      rescue MangoPay::ResponseError => error
          puts "Failed to fetch preauthorizations: #{error.message}"
          puts "Error details: #{error.details}"
          return false
      end
  end

  myUser = {
      Id: '146476890'
    }

  listPreauthorizationsUser(myUser[:Id])  
  ```

  ```java Java  theme={null}
  import com.google.gson.Gson;
  import com.google.gson.GsonBuilder;
  import com.mangopay.MangoPayApi;
  import com.mangopay.entities.CardPreAuthorization;

  import java.util.List;

  public class ListUserPreauthorization {
      public static void main(String[] args) throws Exception {
          MangoPayApi mangopay = new MangoPayApi();
          mangopay.getConfig().setClientId("your-client-id");
          mangopay.getConfig().setClientPassword("your-api-key");

          var userId = "user_m_01HT2NFK7Z2BRQNGNHMY30VVTT";

          List<CardPreAuthorization> preauths = mangopay.getUserApi().getPreAuthorizations(userId);

          for (CardPreAuthorization preauth : preauths) {
              Gson prettyPrint = new GsonBuilder().setPrettyPrinting().create();
              String prettyJson = prettyPrint.toJson(preauth);

              System.out.println(prettyJson);
          }
      }
  }
  ```

  ```python Python   theme={null}
  from pprint import pprint
  import mangopay

  mangopay.client_id='your-client-id'
  mangopay.apikey='your-api-key'

  from mangopay.api import APIRequest
  handler = APIRequest(sandbox=True)

  from mangopay.resources import NaturalUser

  natural_user = NaturalUser.get('213600749')

  preauthorizations = natural_user.get_pre_authorizations()

  for preauthorization in preauthorizations:
      pprint(vars(preauthorization))  
  ```

  ```csharp .NET  theme={null}
  using MangoPay.SDK;
  using MangoPay.SDK.Entities;
  using Newtonsoft.Json;

  class Program
  {
      static async Task Main(string[] args)
      {
          MangoPayApi api = new MangoPayApi();

          api.Config.ClientId = "your-client-id";
          api.Config.ClientPassword = "your-api-key";

          var userId = "user_m_01J2TZ261WZNDM0ZDRWGDYA4GN";

          var userPreauthorizations = await api.CardPreAuthorizations.GetPreAuthorizationsForUserAsync(userId, new Pagination(1, 50), null);

          string prettyPrint = JsonConvert.SerializeObject(userPreauthorizations, Formatting.Indented);
          Console.WriteLine(prettyPrint);
      }
  }
  ```
</RequestExample>
