refundPayments( )

Developer Preview

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

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

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.
Method Declaration
Copy
Method Parameters
orderIdstringRequired

Order ID.

optionsRefundPaymentsOptions
Returns
Return Type:Promise<RefundPaymentsResponse>
Errors
400Invalid Argument

There are 5 errors with this status code.

404Not Found

There are 4 errors with this status code.

428Failed Precondition

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?