[ Web Proxy ]
URL:
Viewing: https://docs.stripe.com/api/balance_transactions [Back]  [Original]

Balance Transactions | Stripe API Reference
Find anything
/
Ask AI

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?YesNo
Retrieve a balance transaction
GET/v1/balance_transactions/:id
List all balance transactions
GET/v1/balance_transactions

The Balance Transaction object

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.

    Show child attributes
  • 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 transactions net funds status in the Stripe balance, which are either available or pending.

  • 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_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
Expand all

  • objectstring

  • available_ontimestamp

  • balance_typeenum

  • createdtimestamp

  • exchange_ratenullable number

  • reporting_categorystring

The Balance Transaction object
{
"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",
"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 /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_wU7nrJCZspk1NPDxiQgAF05qsk_test_wU7nrJCZspk1NPDxiQgAF05q:"
Response
{
"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",
"status": "available",
"type": "transfer"
}

Web Proxy Viewer  |  New URL  |  Original Page