Authorizes a payment using an order's previously saved payment method.
Creates an authorization hold on the customer's payment method for the specified amount. The authorization reserves funds but does not charge the customer until captured.
Use delayedCaptureSettings to configure automatic behavior:
CAPTURE: Automatically charge the customer after the specified delayVOID: Automatically release the hold after the specified delayAlternatively, manually control the authorization using Capture Authorized Payments or Void Authorized Payments.
Note*: The order must have a saved payment method. Check for savedPaymentMethod: true in the order's payment details.
This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:
Order ID.
The order must have a saved payment method associated with it.
Verify a saved payment method exists by calling List Transactions For Single Order and checking for regularPaymentDetails.savedPaymentMethod: true
in the order's payment details before calling this method.
There are 2 errors with this status code.
There is 1 error with this status code.
There are 4 errors with this status code.
This method may also return standard errors. Learn more about standard Wix errors.