v2

latestOpenAPI 3.1.02026-07-262279731.3 MB
depositPreauthorizations

View a Deposit Preauthorization

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.

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

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

Path parameters

ClientIdstring required

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

DepositIdstring required

The unique identifier of the deposit preauthorization.

Headers

Authorizationstring required

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.

Response

Success

OR