Balance Transactions

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

Was this section helpful? Yes No

Retrieve a balance transaction

GET / v1 / balance_transactions /:id

List all balance transactions

GET / v1 / balance_transactions

The Balance Transaction object

Attributes

• id string Unique identifier for the object.
• amount integer 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.
• currency enum Three-letter ISO currency code, in lowercase. Must be a supported currency.
• description nullable string An arbitrary string attached to the object. Often useful for displaying to users.
• fee integer Fees (in the smallest currency unit) paid for this transaction. Represented as a positive integer when assessed.
• fee _ details array of objects Detailed breakdown of fees (in the smallest currency unit) paid for this transaction.
• net integer 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
• source nullable string Expandable This transaction relates to the Stripe object.
• status string The transaction’s net funds status in the Stripe balance, which are either available or pending.
• type enum 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_refund, or fee_credit_funding. Learn more about balance transaction types and what they represent. To classify transactions for accounting purposes, consider reporting_category instead. Possible enum values adjustment advance advance_funding anticipation_repayment application_fee application_fee_refund charge climate_order_purchase climate_order_refund connect_collection_transfer Show 40 more

More attributes

• object string, value is "balance_transaction"
• available _ on timestamp
• balance _ type enum
• created timestamp
• exchange _ rate nullable number
• reporting _ category string

The Balance Transaction object

{ "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"}

Retrieve a balance transaction

GET / v1 / balance_transactions /:id

Retrieves the balance transaction with the given ID.

Note that this endpoint previously used the path /the relevant part of the product/:id.

Parameters

No parameters.

Returns

Returns a balance transaction if a valid balance transaction ID was provided. Raises an error otherwise.

Response

{ "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"}