refundPayments( )

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
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Orders
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
orderIdstringRequired

Order ID to process refunds for.

optionsRefundPaymentsOptions
Returns
Return Type:Promise<RefundPaymentsResponse>
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?