Balance Record Object

A balance record is 1 entry on a Wix Payments account ledger, representing 1 financial operation on the account: a payment, a refund, a chargeback, a refund or chargeback reversal, a reserve hold or release, a top-up, a Wix Capital cash advance, a Wix Capital remittance, or an adjustment.

Each record belongs to an account and to one of the account's profiles. Reserve, payment, payout, and book transfer details are populated based on the record's type. On every record, net equals amount - fee. Records are immutable: amount, fee, and net never change after creation.

In certain cases a balance record can be virtual: a record that hasn't been persisted but is projected to occur in the future. Virtual records are returned only for the ESTIMATED_RESERVE_HOLD and ESTIMATED_RESERVE_RELEASE tags and have no id and no appliedDate.

Properties
accountIdstringformat GUID

ID of the Wix Payments account this balance record belongs to.

accountProfileIdstringformat GUID

ID of the Wix Payments account profile this balance record belongs to.

amountMoney

Gross amount of the balance record, including fees.

Positive for credits to the account, negative for deductions.

appliedDatestringformat date-time

Date and time the balance record was applied to the account balance.

Not returned for virtual records.

bookTransferInfoBookTransferInfo

Book transfer details for this balance record.

Returned for records funded through a Wix Checking book transfer (Instant Access) rather than a payout. Funds backed by a book transfer are immediately available in the merchant's Wix Checking account.

createdDatestringformat date-time

Date and time the balance record was created.

feeMoney

Fee that Wix Payments collected on this balance record.

idstringformat GUID

Balance record ID.

Not returned for virtual records produced by ESTIMATED_RESERVE_HOLD or ESTIMATED_RESERVE_RELEASE tags.

netMoney

Net amount of the balance record after subtracting fee.

paymentInfoPaymentInfo

Information about the payment that produced this balance record.

Returned for records related to a payment, refund, or chargeback.

payoutAvailabilityDatestringformat LOCAL_DATE

Date the balance record becomes available for payout, in YYYY-MM-DD format.

payoutInfoPayoutInfo

Information about the payout that includes this balance record.

Returned only after the record has been included in a payout. The presence of payoutInfo (versus bookTransferInfo) distinguishes a regular payout from an Instant Access book transfer.

recordStatusstring
recordTypestring
reserveInfoReserveInfo

Reserve details for this balance record.

Returned for records with recordType RESERVE_HOLD or RESERVE_RELEASE.

updatedDatestringformat date-time

Date and time the balance record was last updated.

Did this help?