Refund Object


The refund object. A refund object is the record of an attempt to return charged funds.

Properties
acquirerReferenceNumberstringRead-onlyimmutableminLength 1maxLength 30

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.


amountstringimmutabledecimalValue {"gt":"0","maxScale":8}

Amount being returned to the buyer in the refund currency's main units (such as dollars or euros). For example, "12.95".


chargeIdstringimmutableformat GUID

ID of the charge to refund.


createdDatestringRead-onlyimmutableformat date-time

Date and time the refund was created in ISO-8601 format. For example, "2024-01-30T13:30

".


currencyCodestringimmutableformat CURRENCY

Refund currency. Should be the same as the charge currency.


extendedFieldsExtendedFields

Custom field data for the refund object.

Extended fields must be configured in the app dashboard before they can be accessed with API calls.


fullbooleanRead-onlyimmutable

Whether the refund is for the entire amount of the charge.


idstringRead-onlyimmutableformat GUID

Refund ID.


notestringimmutableminLength 1maxLength 200

Note providing additional information about this refund.


providerRefundIdstringRead-onlyimmutableminLength 1maxLength 100

Payment service provider's ID for the refund.


reasonstringminLength 1maxLength 1000

Reason this refund was issued.


returnedApplicationFeestringRead-onlyimmutabledecimalValue {"gt":"0","maxScale":8}

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.


returnedProcessingFeestringRead-onlyimmutabledecimalValue {"gt":"0","maxScale":8}

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.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the refund is updated.

Ignored when creating a refund.


statusstringRead-only

Status of the refund.

Learn more about the refund lifecycle.


statusInfoStatusInfoRead-only

Details about the refund status. Used to provide additional information about why a refund was given its status.


updatedDatestringRead-onlyformat date-time

Date and time the refund was last updated in ISO-8601 format. For example, "2024-01-30T13:30

".

Did this help?