extendedPreauthorizations

Cancel an Extended Preauthorization

Changed on

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

put/v2.01/{ClientId}/extended-preauthorizations/{ExtendedPreauthorizationId}

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/extended-preauthorizations/{ExtendedPreauthorizationId}
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

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

ExtendedPreauthorizationIdstring required

The unique identifier of the extended preauthorization.

Request body

PaymentStatusstring required

Allowed values: CANCELED

The payment status of the extended preauthorization object:

  • WAITING – The extended 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 extended preauthorization before use; indicates that the extended preauthorization was canceled manually.
  • CANCEL_REQUESTED – The cancellation of the extended 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