Query Balance Records

Retrieves a list of up to 1000 balance records, given the provided paging, filtering, and sorting.

Query Balance Records runs with these defaults, which you can override:

• query.sort[0].fieldName is applied_date in ASC order
• query.paging.limit is 20
• query.paging.offset is 0 (and offset is required when paging is set)

Filter and sort field names inside query must be snake_case. They're read from the query.filter object and aren't auto-converted. Supported filter fields: account_profile_id, tags, payout_id, transaction_id, types, and the date ranges transaction_creation_date, paid, and created_date. Any other field returns an Unsupported query: unknown parameter <field> error. ID fields accept a single value by equality, tags and types accept $in, and date-range fields accept $gte and $lt. Supported sort[i].fieldName values: applied_date, payment_info.created_date, created_date. At most 1 sort field is allowed.

To list every balance record in a payout, filter by payout_id.

To learn about working with Query methods, see API Query Language, Sorting and Paging, and Field Projection.