Payout Object


A payout is an outgoing transfer of funds from a Wix Payments account to the merchant's bank account. Each payout has an amount, a lifecycle status, an estimated arrival date, and (when applicable) a failure reason.

Properties
accountIdstringformat GUID

ID of the Wix Payments account that owns the payout. Retrieve account IDs from the Accounts API.


accountProfileIdstringformat GUID

ID of the Wix Payments account profile that owns the payout.

A Wix Payments account has 1 or more profiles. Each profile has its own balance and its own payouts. Most merchants have 1 profile. Retrieve profile IDs from the Accounts API.


amountMoney

Amount of the transfer to the merchant's bank account.


bankTransferReferencestringmaxLength 500

Reference returned by the bank rail once the transfer is initiated. For example, an ACH trace number or a SEPA reference. Use this value to reconcile against the merchant's bank statement.

Empty until the bank rail returns a reference.


cashAdvanceIncludedboolean

Whether the payout amount includes funds from a Wix Capital cash advance taken out by the merchant. If false, the amount comes only from the merchant's sales proceeds.


createdDatestringformat date-time

Date and time the payout was created.

The payout is created before the underlying transfer is initiated at the bank. Once initiated, the funds typically reach the merchant's bank account within 3 to 5 business days, depending on the receiving bank.


estimatedArrivalDateV2stringformat LOCAL_DATE

Estimated date for when the funds should arrive at the merchant's bank account, in YYYY-MM-DD format.

The estimated arrival date is a prediction, not a guarantee. Actual arrival depends on the receiving bank's processing and may be later.


failureReasonPayoutFailureReason

Reason the bank rail rejected the transfer.

Returned only when status is FAILED.


idstringformat GUID

Payout ID.


statusstring
Did this help?