POST

Create Refund


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

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

Permissions
Manage Payments - All Permissions
Manage Refunds
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/payments/refunds/v1/refunds

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.

Event TriggersThis method triggers the following events:
Did this help?