authorizeChargeWithSavedPaymentMethod( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Authorizes a payment using an order's saved payment method.

Use the delayedCaptureSettings field to specify whether the payment should also be captured/voided immediately or at a later time. Alternatively, the payment can be manually captured or voided using the Capture Authorized Payments or Void Authorized Payments methods.

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 eCommerce - all permissions
Manage Stores - all permissions
Manage Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
orderIdstringRequired

Order ID.

The order must have a saved payment method associated. Pass the order ID to the List Transactions For Single Order method and search the response for a payment with regularPaymentDetails.savedPaymentMethod: true. If no saved payment exists, the call will fail.

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 3 errors with this status code.

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

Did this help?