The refund object. A refund object is the record of an attempt to return charged funds.
Refund ID.
Revision number, which increments by 1 each time the refund is updated.
Ignored when creating a refund.
Date and time the refund was created in ISO-8601 format. For example, "2024-01-30T13:30:00".
Date and time the refund was last updated in ISO-8601 format. For example, "2024-01-30T13:30:00".
Custom field data for the refund object.
Extended fields must be configured in the app dashboard before they can be accessed with API calls.
ID of the charge to refund.
Refund currency. Should be the same as the charge currency.
Amount being returned to the buyer in the refund currency's main units (such as dollars or euros).
For example, "12.95".
Application fee returned to the merchant from Wix in the refund currency's main units (such as dollars or euros). For example, "12.95".
Only included if an application fee was returned.
Processing fee returned to the merchant from the payment service provider in the refund currency's main units (such as dollars or euros). For example, "12.95".
This field is empty when the processing fee is unknown.
Whether the refund is for the entire amount of the charge.
Status of the refund.
Learn more about the refund lifecycle.
Payment service provider's ID for the refund.
Reason this refund was issued.
Details about the refund status. Used to provide additional information about why a refund was given its status.
Unique number assigned to a refund. This number is shared across all parties involved in processing the refund. It allows the merchant to track the refund with their bank.
Note providing additional information about this refund.