About the Refunds API

The Refunds API allows you to create and manage refunds for charges processed by Wix.

With this API, you can create full or partial refunds, query refund history, and track refund status through its lifecycle. Refunds can be created through this API or synchronized from Payment Service Providers. Refunds can transition to any status (PENDING, SUCCEEDED, FAILED, or REVERSED) at any time.

To understand how refunds progress from creation to completion, see Refund Lifecycle. For guidance on avoiding duplicate partial refunds, see Prevent Unintended Refunds.

Before you begin

• The site must be onboarded to accept payments through Wix.
• Some functionality in this API is specific to particular payment providers, which is noted in the documentation when applicable.

Use cases

• Refund existing charges
• Issue partial refunds while preventing duplicates
• Import refunds to external accounting software

Terminology

• Merchant: A Wix user who owns a website and has onboarded to accept payments through Wix.
• Buyer: A user of a merchant's site who makes a purchase from the merchant.
• Charge: A transfer of funds from a buyer to a merchant. This was previously referred to as a transaction. Charges (or transactions) are currently handled by the Transaction API.
• Refund: The process of returning funds for a charge to a buyer. Refunds are initiated by merchants. A Refund object represents a record of a refunding attempt.
• Refundability: A property of a charge that describes whether it's possible to issue a refund on the charge, and if so, the allowed range of the refund amount.
• Payment Service Provider (PSP): A service that enables merchants to take payments from buyers. For example, Wix Payments is the Wix PSP, and PayPal is a 3rd-party PSP.
• Processing Fee: A fee taken from a merchant by a Payment provider for processing a charge.
• Application Fee: A fee taken from a merchant by a Wix application associated with the charge. For example, Wix Events may charge a ticket service fee.
• Dispute: The process of returning funds for a charge from a merchant to a buyer. Disputes are initiated by the buyer via their bank. This API doesn't handle disputes, but disputes can cause refunds to fail (indicated by the CHARGE_DISPUTED rejection reason).
• Acquirer Reference Number (ARN): A unique number assigned to a refund. This number is shared across all parties involved in processing the refund. It allows the merchant to track refunds with their bank.