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

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

List all balance transactions

GET / v1 / balance_transactions

Returns a list of transactions that have contributed to the Stripe account balance (for example, charges, transfers, and so on). The transactions return in sorted order, with the most recent transactions appearing first.

The previous name of this endpoint was “Balance history,” and it used the path /the relevant part of the product.

Parameters

payout string For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.
type string Only returns transactions of the given type. One of: 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.

More parameters

created object
currency enum
ending _ before string
limit integer
source string
starting _ after string

Returns

A dictionary with a data property that contains an array of up to limit transactions, starting after transaction starting_after. Each entry in the array is a separate transaction history object. If no more transactions are available, the resulting array will be empty.

Response

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