Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.
Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history
.
Parameters
- payoutstring
For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.
- typestring
Only returns transactions of the given type. One of:
adjustment
,advance
,advance_
,funding anticipation_
,repayment application_
,fee application_
,fee_ refund charge
,climate_
,order_ purchase climate_
,order_ refund connect_
,collection_ transfer contribution
,issuing_
,authorization_ hold issuing_
,authorization_ release issuing_
,dispute issuing_
,transaction obligation_
,outbound obligation_
,reversal_ inbound payment
,payment_
,failure_ refund payment_
,network_ reserve_ hold payment_
,network_ reserve_ release payment_
,refund payment_
,reversal payment_
,unreconciled payout
,payout_
,cancel payout_
,failure payout_
,minimum_ balance_ hold payout_
,minimum_ balance_ release refund
,refund_
,failure reserve_
,transaction reserved_
,funds stripe_
,fee stripe_
,fx_ fee stripe_
,balance_ payment_ debit stripe_
,balance_ payment_ debit_ reversal tax_
,fee topup
,topup_
,reversal transfer
,transfer_
,cancel transfer_
, orfailure transfer_
.refund
More parameters
- createdobject
Only return transactions that were created during the given date interval.
- created.
gtinteger Minimum value to filter by (exclusive)
- created.
gteinteger Minimum value to filter by (inclusive)
- created.
ltinteger Maximum value to filter by (exclusive)
- created.
lteinteger Maximum value to filter by (inclusive)
- currencyenum
Only return transactions in a certain currency. Three-letter ISO currency code, in lowercase. Must be a supported currency.
- ending_
beforestring A cursor for use in pagination.
ending_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withbefore obj_
, your subsequent call can includebar ending_
in order to fetch the previous page of the list.before=obj_ bar - limitinteger
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- sourcestring
Only returns the original transaction.
- starting_
afterstring A cursor for use in pagination.
starting_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withafter obj_
, your subsequent call can includefoo starting_
in order to fetch the next page of the list.after=obj_ foo
Returns
A dictionary with a data
property that contains an array of up to limit
transactions, starting after transaction starting_
. Each entry in the array is a separate transaction history object. If no more transactions are available, the resulting array will be empty.
{ "object": "list", "url": "/v1/balance_transactions", "has_more": false, "data": [ { "id": "txn_1MiN3gLkdIwHu7ixxapQrznl", "object": "balance_transaction", "amount": -400, "available_on": 1678043844, "created": 1678043844, "currency": "usd", "description": null, "exchange_rate": null, "fee": 0, "fee_details": [], "net": -400, "reporting_category": "transfer", "source": "tr_1MiN3gLkdIwHu7ixNCZvFdgA", "status": "available", "type": "transfer" } ]}