refundPayments( )

Calls relevant payment providers and creates refund transactions for the requested payments.

Refunds marked with paymentRefunds.externalRefund = true do not call payment providers and only update the order's transactions records.

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 eCommerce - all permissions
Manage Stores - all permissions
Manage Orders
Manage Restaurants - all permissions
Manage Stores
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
orderIdstringRequired

Order ID.

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?