Skip to navigation
Card pay-insExtended Preauthorizations

Cancel an Extended Preauthorization

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.

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.

Path parameters

ClientIdstringRequired
Platform's API account identifier, associated with the API key.
ExtendedPreauthorizationIdstringRequired
The unique identifier of the extended preauthorization.

Request

This endpoint expects an object.
PaymentStatusstringRequired

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
Cardobject

Response if Extended Preauthorization's PaymentType is CARD.

OR
PayPalobject

Response if Extended Preauthorization's PaymentType is PAYPAL.

Errors

400
Bad Request Error