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

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:

Permissions
Manage Orders
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsCaptureAuthorizedPaymentsOptionsRequired

orderIdstringRequired

ID of the order containing the payments to capture.

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?