Sample - Stripe API
GET/v1/balance_transactions

List balance transactions

Lists balance transactions that contribute to the account balance, with the newest transactions returned first. Use created, currency, payout, source, and type to filter results, and use cursor parameters to paginate the list.

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

9 parameters
createdobjectoptional
Filters transactions by creation time using a date range or a Unix timestamp.
currencystringoptional
Filters transactions by currency using a supported three-letter ISO currency code in lowercase.
ending_beforestringoptional
Cursor for retrieving the preceding page, using a balance transaction object ID.
expandarray<string>optional
Fields to expand in the response; each value must be no longer than 5000 characters.
limitintegeroptional
Maximum number of transactions to return, from 1 to 100. Defaults to 10 when omitted.
payoutstringoptional
Filters transactions to those paid out through the specified payout ID.
sourcestringoptional
Filters transactions associated with the specified object.
starting_afterstringoptional
Cursor for retrieving the following page, using a balance transaction object ID.
typestringoptional
Filters by balance transaction type, such as charge, refund, payout, transfer, or topup; use one of the transaction types documented for this parameter.

2 status codes
200Returns a paginated list object containing balance transactions, a `has_more` indicator, the list object type, and the list URL.
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 supported three-letter ISO currency code in lowercase, and type must be one of the documented balance transaction types.