List Deposit Preauthorizations for a Card

GET

/v2.01/:ClientId/cards/:CardId/deposit-preauthorizations

GET

/v2.01/:ClientId/cards/:CardId/deposit-preauthorizations

curl https://api.sandbox.mangopay.com/v2.01/{ClientId}/cards/{CardId}/deposit-preauthorizations \
     -H "Authorization: Bearer <token>"

200Retrieved

[
  {
    "Applied3DSVersion": null,
    "AuthorId": "204068024",
    "AuthorizationDate": 1696256388,
    "Billing": null,
    "BrowserInfo": null,
    "CardId": "204068248",
    "CardInfo": {
      "BIN": "497010",
      "Brand": "VISA",
      "IssuerCountryCode": "MA",
      "IssuingBank": "LA BANQUE POSTALE",
      "SubType": null,
      "Type": "CREDIT"
    },
    "CreationDate": 1696256380,
    "Culture": null,
    "DebitedFunds": {
      "Amount": 22223,
      "Currency": "EUR"
    },
    "ExecutionType": "DIRECT",
    "ExpirationDate": 1698848380,
    "Id": "78e82d95-bf01-4633-84d9-f433e1130eba",
    "IpAddress": null,
    "PayinsLinked": {
      "PayinCaptureId": null,
      "PayinComplementId": null
    },
    "PaymentStatus": "CANCELED",
    "PaymentType": "CARD",
    "PreferredCardNetwork": null,
    "Requested3DSVersion": null,
    "ResultCode": "000000",
    "ResultMessage": "Success",
    "SecureModeNeeded": null,
    "SecureModeRedirectURL": null,
    "SecureModeReturnURL": null,
    "Shipping": null,
    "StatementDescriptor": null,
    "Status": "SUCCEEDED",
    "Tag": "Created using Mangopay API Postman Collection"
  }
]

Note – Disclaimer about terminology

The use of the term “deposit” in this feature is for convenience only and does not constitute a traditional banking deposit under applicable banking regulations, including the EU Capital Requirements Directive (Directive 2013/36/EU) or the Deposit Guarantee Schemes Directive (Directive 2014/49/EU). Accordingly, these funds are not covered by any statutory deposit protection schemes, and Mangopay does not operate as a licensed banking institution.

<Note icon="fa-regular fa-circle-info"> **Note – Disclaimer about terminology** The use of the term "deposit" in this feature is for convenience only and does not constitute a traditional banking deposit under applicable banking regulations, including the EU Capital Requirements Directive (Directive 2013/36/EU) or the Deposit Guarantee Schemes Directive (Directive 2014/49/EU). Accordingly, these funds are not covered by any statutory deposit protection schemes, and Mangopay does not operate as a licensed banking institution. </Note>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired

Platform's API account identifier, associated with the API key.

CardIdstringRequired

Query parameters

ResultCodestringOptional

The code indicating the result of the operation. You can filter on multiple values by separating them with a comma.

StatusstringOptional

Allowed values: CREATED, SUCCEEDED, FAILED

The status of the transaction. You can filter on multiple values by separating them with a comma.

PaymentStatusstringRequired

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.

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

Response

Success

Cardobject

Response if Deposit Preauthorization’s PaymentType is CARD.

PayPalobject

Response if Deposit Preauthorization’s PaymentType is PAYPAL.