POST

Refund Payments


Processes payment refunds by calling payment providers and creating refund transactions.

Supports two refund methods:

  • Automatic refunds: Calls the payment provider's API to process the refund.
  • External refunds: Marks payments as refunded without calling providers (for manual provider-side refunds).

Set paymentRefunds.externalRefund = true for external refunds when you've manually processed the refund and only need to update the order's transaction records.

The method also handles restocking inventory and sending customer notifications when specified in sideEffects.

Authentication

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

Permissions
Manage Orders
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/ecom/v1/order-billing/refund-payments

Errors
400Invalid Argument

There are 6 errors with this status code.

404Not Found

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