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
- createdmap
- currencyenum
- ending_
beforestring - limitinteger
- sourcestring
- starting_
afterstring
Returns
A map 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" } ]}
The Charge
object represents a single attempt to move money into your Stripe account. PaymentIntent confirmation is the most common way to create Charges, but transferring money to a different Stripe account through Connect also creates Charges. Some legacy payment flows create Charges directly, which is not recommended for new integrations.
This object represents a customer of your business. Use it to create recurring charges, save payment and contact information, and track payments that belong to the same customer.
A Customer Session allows you to grant Stripe’s frontend SDKs (like Stripe.js) client-side access control over a Customer.
Related guides: Customer Session with the Payment Element, Customer Session with the Pricing Table, Customer Session with the Buy Button.
A dispute occurs when a customer questions your charge with their card issuer. When this happens, you have the opportunity to respond to the dispute with evidence that shows that the charge is legitimate.
Related guide: Disputes and fraud