Skip to main content
Manja / Stripe
Schema2020-08-27object

balance_transaction

Balance transactions represent funds moving through your Stripe account. They're created for every type of transaction that comes into or flows out of your Stripe account balance. Related guide: [Balance Transaction Types](https://stripe.com/docs/reports/balance-transaction-types).

Source
openapi/spec3.json
Commit
d70de345383d
Active snapshot
da69df7e6e11

BalanceTransaction

object

Balance transactions represent funds moving through your Stripe account. They're created for every type of transaction that comes into or flows out of your Stripe account balance. Related guide: [Balance Transaction Types](https://stripe.com/docs/reports/balance-transaction-types).

amount integer
required

Gross amount of the transaction, in %s.

available_on integer (unix-time)
required

The date the transaction's net funds will become available in the Stripe balance.

created integer (unix-time)
required

Time at which the object was created. Measured in seconds since the Unix epoch.

currency string
required

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).

description string
optionalnullable

An arbitrary string attached to the object. Often useful for displaying to users.

maxLength:5000

exchange_rate number
optionalnullable

The exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then the `amount` in currency A, times `exchange_rate`, would be the `amount` in currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent's `amount` would be `1000` and `currency` would be `eur`. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction's `amount` would be `1234`, `currency` would be `usd`, and `…

fee integer
required

Fees (in %s) paid for this transaction.

fee_details array
required

Detailed breakdown of fees (in %s) paid for this transaction.

id string
required

Unique identifier for the object.

maxLength:5000

net integer
required

Net amount of the transaction, in %s.

object string
required

String representing the object's type. Objects of the same type share the same value.

Allowed: "balance_transaction"

reporting_category string
required

[Learn more](https://stripe.com/docs/reports/reporting-categories) about how reporting categories can help you understand balance transactions from an accounting perspective.

maxLength:5000

source
optionalnullable

The Stripe object to which this transaction is related.

status string
required

If the transaction's net funds are available in the Stripe balance yet. Either `available` or `pending`.

maxLength:5000

type string
required

Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup…

Allowed: "adjustment""advance""advance_funding""anticipation_repayment""application_fee""application_fee_refund""charge""connect_collection_transfer""contribution""issuing_authorization_hold""issuing_authorization_release""issuing_dispute""issuing_transaction""payment""payment_failure_refund""payment_refund""payout""payout_cancel""payout_failure""refund""refund_failure""reserve_transaction""reserved_funds""stripe_fee""stripe_fx_fee""tax_fee""topup""topup_reversal""transfer""transfer_cancel""transfer_failure""transfer_refund"