Balance transactions represent funds moving through your Stripe account. Stripe creates them for every type of transaction that enters or leaves your Stripe account balance.
Related guide: Balance transaction types
Attributes
- idstring
Unique identifier for the object.
- amountinteger
Gross amount of this transaction (in the smallest currency unit). A positive value represents funds charged to another party, and a negative value represents funds sent to another party.
- currencyenum
Three-letter ISO currency code, in lowercase. Must be a supported currency.
- descriptionnullable string
An arbitrary string attached to the object. Often useful for displaying to users.
- feeinteger
Fees (in the smallest currency unit) paid for this transaction. Represented as a positive integer when assessed.
- fee_
detailsarray of objects Detailed breakdown of fees (in the smallest currency unit) paid for this transaction.
- netinteger
Net impact to a Stripe balance (in the smallest currency unit). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by
amount-fee - sourcenullable stringExpandable
This transaction relates to the Stripe object.
- statusstring
The transaction’s net funds status in the Stripe balance, which are either
availableorpending. - typeenum
Transaction type:
tax_,fund adjustment,advance,advance_,funding anticipation_,repayment application_,fee application_,fee_ refund charge,climate_,order_ purchase climate_,order_ refund connect_,collection_ transfer contribution,inbound_,transfer inbound_,transfer_ reversal 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 reserve_,hold reserve_,release stripe_,fee stripe_,fx_ fee stripe_,balance_ payment_ debit stripe_,balance_ payment_ debit_ reversal tax_,fee topup,topup_,reversal transfer,transfer_,cancel transfer_,failure transfer_, orrefund fee_. Learn more about balance transaction types and what they represent. To classify transactions for accounting purposes, considercredit_ funding reporting_instead.category Possible enum valuesadjustmentadvanceadvance_funding anticipation_repayment application_fee application_fee_ refund chargeclimate_order_ purchase climate_order_ refund connect_collection_ transfer Show 40 more
More attributes
- objectstring
- available_
ontimestamp - balance_
typeenum - createdtimestamp
- exchange_
ratenullable number - reporting_
categorystring
{ "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"}Retrieves the balance transaction with the given ID.
Note that this endpoint previously used the path /v1/balance/history/:id.
Parameters
No parameters.
Returns
Returns a balance transaction if a valid balance transaction ID was provided. Raises an error otherwise.
curl https://api.stripe.com/v1/balance_transactions/{{BALANCE_TRANSACTION_ID}} \ -u "sk_test_Hrs6SAopgFPF0bZXSN3f6ELNsk_test_Hrs6SAopgFPF0bZXSN3f6ELN:"{ "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"}