Swagger Petstore - OpenAPI 3.0
GET/v1/balance/history

List balance transactions

Returns a paginated list of balance transactions that have contributed to the Stripe account balance, such as charges, transfers, and refunds. Transactions are sorted with the most recent appearing first. Filter by creation date, currency, source, type, or payout to narrow results.

9 parameters
createdobjectoptional

Filter transactions by creation date. Can be a Unix timestamp or an object with gt, gte, lt, or lte keys for range queries.

currencystringoptional

Filter transactions by currency. Must be a valid three-letter ISO 4217 currency code in lowercase.

ending_beforestringoptional

A cursor for pagination. Pass an object ID to fetch the previous page of results before this ID.

expandarray<string>optional

Specifies which fields in the response should be expanded.

limitintegeroptional

Maximum number of transactions to return. Must be between 1 and 100. Defaults to 10 if omitted.

payoutstringoptional

For automatic Stripe payouts only, filter transactions paid out on the specified payout ID.

sourcestringoptional

Filter transactions associated with the given object ID.

starting_afterstringoptional

A cursor for pagination. Pass an object ID to fetch the next page of results after this ID.

typestringoptional

Filter transactions by type, such as charge, refund, payout, or transfer.

2 status codes
200Returns a paginated list of balance transaction objects with details including amount, fees, net impact, status, and reporting category.
dataarray<BalanceTransaction>required
has_morebooleanrequired

True if this list has another page of items after this one that can be fetched.

objectstringrequired

String representing the object's type. Objects of the same type share the same value. Always has the value list.

Allowed:list
urlstringrequired

The URL where this list can be accessed.

defaultError response.
errorobjectrequired

Error handling

limit must be a positive integer between 1 and 100; the default is 10. currency must be a valid three-letter ISO 4217 currency code. type must be one of the documented transaction types. Use starting_after and ending_before for cursor-based pagination.