List Balance Transactions
GET/api/shopify/:integrationInstance/balance-transactions
Returns a paginated list of Shopify Payments balance transaction lines across every payout synced for the integration instance — the line-level detail behind the payout summaries. Each line includes its type, financial code, amount, fee, net, source type, source order ID, adjustment reason, and cross-link blocks for the parent payout and (when matched) the Shopify order.
Authentication: Requires Bearer token.
Filters: filter[search] matches the internal ID, balance transaction ID, source order ID, financial code, type, or linked Shopify order (Shopify order ID or internal order ID). filter[financial_code], filter[type], filter[shopify_payout_id], and filter[id] are exact-match filters.
Allowed sorts: id, amount, created_at (prefix with - for descending; default -id). Pagination defaults to 15 per page.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.