voidAuthorizedPayments( )


Voids (cancels) previously authorized payments, releasing the authorization hold without charging the customer.

Use this method when you no longer need to capture an authorized payment, such as when an order is cancelled or when inventory becomes unavailable after authorization.

Note*: Only payments with AUTHORIZED status can be voided. Already captured payments cannot be voided.

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
orderIdstringRequired

ID of the order containing the payments to void.


optionsVoidAuthorizedPaymentsOptionsRequired
Returns
Return Type:Promise<VoidAuthorizedPaymentsResponse>
Errors
404Not Found

There are 2 errors with this status code.

409Already Exists

There is 1 error with this status code.

428Failed Precondition

There are 2 errors with this status code.

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

Did this help?