authorizeChargeWithSavedPaymentMethod( )

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 delay
  • VOID: Automatically release the hold after the specified delay

Alternatively, 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.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Orders
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
orderIdstringRequired

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.

optionsAuthorizeChargeWithSavedPaymentMethodOptionsRequired
Returns
Return Type:Promise<AuthorizeChargeWithSavedPaymentMethodResponse>
Errors
400Invalid Argument

There are 2 errors with this status code.

404Not Found

There is 1 error with this status code.

428Failed Precondition

There are 4 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?