Sample - Stripe API
GET/v1/balance/history/{id}

Retrieve a balance transaction

Retrieves a single balance transaction by its unique identifier. Use id to identify the transaction and expand to request additional fields in the response when needed.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
idstringrequired
The unique identifier of the balance transaction, limited to 5000 characters.
expandarray<string>optional
Fields to expand in the response; each value must be no longer than 5000 characters.

2 status codes
200Returns the balance transaction, including its amount, availability date, balance impact, fees, currency, source, and status.
amountintegerrequired
Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party.
available_onintegerrequired
The date that the transaction's net funds become available in the Stripe balance.
balance_typestringrequired
The balance that this transaction impacts.
Allowed:issuingpaymentsrefund_and_dispute_prefundingrisk_reserved
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
currencystringrequired
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
descriptionstringoptional
An arbitrary string attached to the object. Often useful for displaying to users.
exchange_ratenumberoptional
If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multiplied by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`.
feeintegerrequired
Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed.
fee_detailsarray<Fee>required
Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction.
idstringrequired
Unique identifier for the object.
netintegerrequired
Net impact to a Stripe balance (in cents (or local equivalent)). 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`
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:balance_transaction
reporting_categorystringrequired
Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective.
sourcestringoptional
This transaction relates to the Stripe object.
statusstringrequired
The transaction's net funds status in the Stripe balance, which are either `available` or `pending`.
typestringrequired
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](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.
Allowed:adjustmentadvanceadvance_fundinganticipation_repaymentapplication_feeapplication_fee_refundchargeclimate_order_purchaseclimate_order_refundconnect_collection_transfercontributionfee_credit_funding
defaultError response.
errorobjectrequired

Error handling

id must be a string no longer than 5000 characters and must identify the balance transaction to retrieve. Each expand value must be a string no longer than 5000 characters.