Sample - Stripe API
GET/v1/balance/history

List balance transactions

Lists transactions that contributed to the account balance, with the most recent transactions first. Use created, currency, payout, source, and type to filter results, and use cursor parameters to paginate through the list.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

9 parameters
createdobjectoptional
Filters transactions by creation time using a timestamp or a range with `gt`, `gte`, `lt`, or `lte`.
currencystringoptional
Filters transactions by a lowercase three-letter ISO currency code that must be supported.
ending_beforestringoptional
An object ID cursor that identifies the position before the page to retrieve.
expandarray<string>optional
Specifies response fields to expand; each value can be up to 5000 characters.
limitintegeroptional
The number of transactions to return, from 1 to 100. Defaults to 10 when omitted.
payoutstringoptional
Filters results to transactions paid out by the specified automatic payout ID.
sourcestringoptional
Filters results to transactions associated with the specified object.
starting_afterstringoptional
An object ID cursor that identifies the position after the page to retrieve.
typestringoptional
Filters results by transaction type, such as `charge`, `refund`, `payout`, `transfer`, or `topup`, from the documented transaction type set.

2 status codes
200Returns a list of balance transaction objects with amounts, fees, net values, currencies, sources, statuses, and pagination metadata.
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 between 1 and 100 and defaults to 10 when omitted. currency must be a lowercase three-letter supported currency code, and type must be one of the transaction types documented for this parameter.