PUT
/
v2.01
/
{ClientId}
/
preauthorizations
/
{PreauthorizationId}

This call is used to manually close the preauthorization hold period before the ExpirationDate, thereby releasing the preauthorized funds. 

The PaymentStatus can be set to:

  • CANCELED when no preauthorized pay-ins have been made to capture funds. Trying to cancel a used preauthorization returns an error.
  • VALIDATED when at least one preauthorized pay-in has been made to capture funds. Trying to validate an unused preauthorization returns an error.

Caution – Canceling or validating a preauthorization is irreversible

A preauthorization with the CANCELED or VALIDATED status can’t be reused.

Path parameters

PreauthorizationId
string
required

The unique identifier of the preauthorization.

Body parameters

PaymentStatus
string
required

Allowed values: CANCELED, VALIDATED

The status of the preauthorization object:

  • WAITING – The remaining preauthorized funds can be captured by making one or several preauthorized pay-ins. Pay-ins can only be made against a preauthorization with the WAITING status.
  • CANCELED – The preauthorization was canceled manually before any preauthorized pay-ins were made, or it was canceled automatically because the authorization failed.
  • EXPIRED – The hold period on the preauthorized funds has ended without any preauthorized pay-ins taking place.
  • VALIDATED – During the hold period: Indicates that all the preauthorized funds have been captured (RemainingFunds is zero) and no more preauthorized pay-ins can be made. After the hold period: Indicates that at least one capture was made during the hold period.

Responses