captureAuthorizedPayments( )

Captures (charges) previously authorized payments, converting the authorization hold into an actual charge.

Use this method to complete payment when you're ready to fulfill an order, typically after confirming inventory availability and preparing for shipment.

Note*: Only payments with AUTHORIZED status can be captured. The capture amount cannot exceed the authorized amount.

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

ID of the order containing the payments to capture.

optionsCaptureAuthorizedPaymentsOptionsRequired
Returns
Return Type:Promise<CaptureAuthorizedPaymentsResponse>
Errors
400Invalid Argument

There is 1 error with this status code.

404Not Found

There is 1 error with this status code.

409Already Exists

There are 2 errors 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?