POST

Update Payment Status

Updates the status of an order's payment.

This method only updates the payment record. It doesn't interact with the payment provider or move any funds.

Notes:

  • To issue a refund and update the payment status to refunded, use Refund Payments in the Order Billing API instead.
  • Gift card and membership payments only support the APPROVED and VOIDED statuses.
  • The order's paymentStatus is recalculated asynchronously after the call.
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
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Event TriggersThis method triggers the following events:
Order Transactions Updated
Order Transactions Details Updated
Did this help?