depositPreauthorizations

View a Deposit Preauthorization

Changed on
<Warning icon="fa-regular fa-triangle-exclamation"> **Warning – Deprecated feature**

This endpoint is deprecated. Use GET View an Extended Preauthorization instead.

The Deposit Preauthorization endpoints are scheduled for decommissioning at the end of 2027. Platforms with existing integrations need to move to the new endpoints at their earliest convenience before then.

The Extended Preauthorization feature is a like-for-like renaming of the legacy Deposit Preauthorization – the behavior is otherwise unchanged.

The previous use of the term "deposit" was 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. </Warning>

This call retrieves a single Deposit Preauthorization, of which there are two types, indicated by PaymentType:

  • CARD – Created using POST Create a Card Deposit Preauthorization
  • PAYPAL – Created using POST Create a PayPal Deposit Preauthorization

Both types can be captured using POST Create a Deposit Preauthorized PayIn.

get/v2.01/{ClientId}/deposit-preauthorizations/{DepositId}

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/deposit-preauthorizations/{DepositId}
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

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

DepositIdstring required

The unique identifier of the deposit preauthorization.

Response

Success

OR

Changes

    • breaking

      added to the response body oneOf list for the response status

    • info

      endpoint deprecated

    • info

      removed from the response body oneOf list for the response status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API