Cancel a Deposit Preauthorization

PUT

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

PUT

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

$ curl -X PUT https://api.sandbox.mangopay.com/v2.01/ClientId/deposit-preauthorizations/DepositId \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "PaymentStatus": "CANCELED"
>   }
> }'

1 {
2   "Id": "deposit_wt_41716dcf-c0aa-42fe-8efb-5f82b812040b",
3   "CreationDate": 1771585449,
4   "ExpirationDate": 1774177460,
5   "AuthorizationDate": null,
6   "AuthorId": "user_m_01KHXAHEBRWSZXJY85TPPR56TK",
7   "DebitedFunds": {
8     "Currency": "EUR",
9     "Amount": 20000
10   },
11   "Status": "SUCCEEDED",
12   "PaymentStatus": "CANCELED",
13   "PayinsLinked": {
14     "PayinCaptureId": null,
15     "PayinComplementId": null
16   },
17   "ResultCode": "000000",
18   "ResultMessage": "Success",
19   "CardId": "card_wt_HodULFWKVRMEecCa",
20   "PreferredCardNetwork": null,
21   "SecureModeReturnURL": "http://example.com?depositId=deposit_wt_41716dcf-c0aa-42fe-8efb-5f82b812040b",
22   "SecureModeRedirectURL": null,
23   "SecureModeNeeded": false,
24   "PaymentType": "CARD",
25   "ExecutionType": "DIRECT",
26   "StatementDescriptor": null,
27   "Culture": "EN",
28   "BrowserInfo": {
29     "AcceptHeader": "text/html, application/xhtml+xml, application/xml;q=0.9, /;q=0.8",
30     "JavaEnabled": true,
31     "Language": "FR-FR",
32     "ColorDepth": 4,
33     "ScreenHeight": 1800,
34     "ScreenWidth": 400,
35     "TimeZoneOffset": 60,
36     "UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
37     "JavascriptEnabled": true
38   },
39   "IpAddress": "050d:ad6a:e5ab:cdf1:f0f5:2f47:a59d:cac7",
40   "Billing": {
41     "FirstName": "Jonatan",
42     "LastName": "Renner",
43     "Address": {
44       "AddressLine1": "16544 Jalon Expressway",
45       "AddressLine2": "Pacocha Road",
46       "City": "Paris",
47       "Region": "Ile-de-France",
48       "PostalCode": "75001",
49       "Country": "FR"
50     }
51   },
52   "Shipping": {
53     "FirstName": "Jonatan",
54     "LastName": "Renner",
55     "Address": {
56       "AddressLine1": "16544 Jalon Expressway",
57       "AddressLine2": "Pacocha Road",
58       "City": "Paris",
59       "Region": "Ile-de-France",
60       "PostalCode": "75001",
61       "Country": "FR"
62     }
63   },
64   "Requested3DSVersion": null,
65   "Applied3DSVersion": "V2_1",
66   "Tag": "Created using the Mangopay API Postman collection",
67   "CardInfo": {
68     "BIN": "497010",
69     "IssuingBank": "LA BANQUE POSTALE",
70     "IssuerCountryCode": "MA",
71     "Type": "CREDIT",
72     "Brand": "VISA",
73     "SubType": null,
74     "AuthenticationType": null
75   }
76 }

This endpoint allows you to cancel a deposit preauthorization (with PaymentType of CARD or PAYPAL) if it is no longer needed, by setting the PaymentStatus to CANCELED. A canceled deposit preauthorization can’t be subsequently captured.

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.

Request

This endpoint expects an object.

PaymentStatusstringRequired

Allowed values: CANCELED

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.

Errors

400

Bad Request Error