createRefund( )

Developer Preview

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

Creates a refund.

The refunding process starts immediately after a refund entity is created.

If you specify an amount, you must also specify a currency_code. This currency should be the same as the currency of the charge. If amount and currency_code are not specified, the refund is created for the full charge amount. If the charge was already partially refunded, this refund will fail.

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 Payments - All Permissions
Manage Refunds
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
refundRefundRequired

Refund to be created.

optionsCreateRefundOptions
Returns
Return Type:Promise<Refund>
Errors
400Invalid Argument

There are 2 errors with this status code.

428Failed Precondition

There are 13 errors with this status code.

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

Did this help?