depositPreauthorizations

Cancel a Deposit Preauthorization

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

This endpoint is deprecated. Use PUT Cancel 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 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.

put/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.

Request body

PaymentStatusstring required

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

OR

Changes

  • 33a23ba84cddRevision 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

  • f44a59c76515Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API