Cancel a Deposit Preauthorization
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.
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
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.
Path parameters
Request
Allowed values: CANCELED
The payment status of the deposit preauthorization object:
WAITING– The deposit preauthorization can be used: the preauthorized funds can be captured (ifStatusisSUCCEEDED) 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
Response if Deposit Preauthorization’s PaymentType is CARD.
Response if Deposit Preauthorization’s PaymentType is PAYPAL.