POST

Void Authorized Payments

Developer Preview

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

Voids an order's authorized payments.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/ecom/v1/order-billing/void-authorized-payments
Body Params
orderIdstringRequiredformat GUID

Order ID.

paymentIdsArray <string>RequiredminItems 1maxItems 100format GUID

IDs of the authorized payments to void.

Response Object
orderTransactionsOrderTransactions

Order transactions updated with voided payment.

Void Authorized Payments

Void previously authorized payments.

Request
cURL
Response
JSON
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?