createRefund( )


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

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

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?