View a Deposit Preauthorization

GET

/v2.01/:ClientId/deposit-preauthorizations/:DepositId

GET

/v2.01/:ClientId/deposit-preauthorizations/:DepositId

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

200Retrieved

1 {
2   "Applied3DSVersion": "V2_1",
3   "AuthenticationResult": {
4     "AuthenticationType": "CHALLENGE"
5   },
6   "AuthorId": "user_m_01KHXAHEBRWSZXJY85TPPR56TK",
7   "Billing": {
8     "Address": {
9       "AddressLine1": "16544 Jalon Expressway",
10       "AddressLine2": "Pacocha Road",
11       "City": "Paris",
12       "Country": "FR",
13       "PostalCode": "75001",
14       "Region": "Ile-de-France"
15     },
16     "FirstName": "Jonatan",
17     "LastName": "Renner"
18   },
19   "BrowserInfo": {
20     "AcceptHeader": "text/html, application/xhtml+xml, application/xml;q=0.9, /;q=0.8",
21     "ColorDepth": 4,
22     "JavaEnabled": true,
23     "JavascriptEnabled": true,
24     "Language": "FR-FR",
25     "ScreenHeight": 1800,
26     "ScreenWidth": 400,
27     "TimeZoneOffset": 60,
28     "UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148"
29   },
30   "CardId": "card_wt_HodULFWKVRMEecCa",
31   "CardInfo": {
32     "BIN": "497010",
33     "Brand": "VISA",
34     "IssuerCountryCode": "MA",
35     "IssuingBank": "LA BANQUE POSTALE",
36     "SubType": null,
37     "Type": "CREDIT"
38   },
39   "CreationDate": 1771585135,
40   "Culture": "EN",
41   "DebitedFunds": {
42     "Amount": 20000,
43     "Currency": "EUR"
44   },
45   "ExecutionType": "DIRECT",
46   "ExpirationDate": 1774177173,
47   "FlowDescriptor": {
48     "Beneficiaries": [
49       {
50         "UserId": "user_m_02APAYTWSDYXHXN1FRTKX9WMA2"
51       }
52     ],
53     "FlowId": "flow_wt_97448e0a-5bc6-4b83-ac29-cdfcadf60a08"
54   },
55   "Id": "deposit_wt_073099a9-4e14-42b7-9bc7-d1978f65d8ba",
56   "IpAddress": "4ce4:e138:803f:eb1c:9c5b:7316:ec84:3d00",
57   "PayinsLinked": {
58     "PayinCaptureId": "wt_28217024-04e1-400b-b902-15bc2cca8a82",
59     "PayinComplementId": null
60   },
61   "PaymentStatus": "VALIDATED",
62   "PaymentType": "CARD",
63   "PreferredCardNetwork": null,
64   "Requested3DSVersion": null,
65   "ResultCode": "000000",
66   "ResultMessage": "Success",
67   "SecureModeNeeded": true,
68   "SecureModeRedirectURL": null,
69   "SecureModeReturnURL": "http://example.com?depositId=deposit_wt_073099a9-4e14-42b7-9bc7-d1978f65d8ba",
70   "Shipping": {
71     "Address": {
72       "AddressLine1": "16544 Jalon Expressway",
73       "AddressLine2": "Pacocha Road",
74       "City": "Paris",
75       "Country": "FR",
76       "PostalCode": "75001",
77       "Region": "Ile-de-France"
78     },
79     "FirstName": "Jonatan",
80     "LastName": "Renner"
81   },
82   "StatementDescriptor": null,
83   "Status": "SUCCEEDED",
84   "Tag": "Created using the Mangopay API Postman collection"
85 }

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

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](/api-reference/deposit-preauthorizations/create-card-deposit-preauthorization) - `PAYPAL` – Created using [POST Create a PayPal Deposit Preauthorization](/api-reference/deposit-preauthorizations/create-paypal-deposit-preauthorization) Both types can be captured using [POST Create a Deposit Preauthorized PayIn](/api-reference/deposit-preauthorizations/create-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>

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.

DepositIdstringRequired

The unique identifier of the deposit preauthorization.

Response

Success

Cardobject

Response if Deposit Preauthorization’s PaymentType is CARD.

PayPalobject

Response if Deposit Preauthorization’s PaymentType is PAYPAL.