Sign in

Retrieve a balance transaction

Retrieves the balance transaction with the given ID.

Note that this endpoint previously used the path /v1/balance/history/:id.

get/v1/balance/history/{id}

Path parameters

idstring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

amountinteger required

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_oninteger required

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

balance_type'issuing' | 'payments' | 'refund_and_dispute_prefunding' | 'risk_reserved' required

The balance that this transaction impacts.

createdinteger required

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

currencystring currency required

Three-letter ISO currency code, in lowercase. Must be a supported currency.

descriptionstring nullable

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

exchange_ratenumber nullable

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.

feeinteger required

Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed.

idstring required

Unique identifier for the object.

netinteger required

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

object'balance_transaction' required

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

reporting_categorystring required

Learn more about how reporting categories can help you understand balance transactions from an accounting perspective.

statusstring required

The transaction's net funds status in the Stripe balance, which are either available or pending.

type'adjustment' | 'advance' | 'advance_funding' | 'anticipation_repayment' | 'application_fee' | 'application_fee_refund' | 'charge' | 'climate_order_purchase' | 'climate_order_refund' | 'connect_collection_transfer' | 'contribution' | 'fee_credit_funding' | '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_hold' | 'reserve_release' | 'reserve_transaction' | 'reserved_funds' | 'stripe_balance_payment_debit' | 'stripe_balance_payment_debit_reversal' | 'stripe_fee' | 'stripe_fx_fee' | 'tax_fee' | 'tax_fund' | 'topup' | 'topup_reversal' | 'transfer' | 'transfer_cancel' | 'transfer_failure' | 'transfer_refund' required

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.

Changes

Changed in 16 of the 51 revisions of this API.2261118

  • e24a26de41884See the full diff
    • ▲

      removed the required property //////////// from the response with the status

      response-required-property-removed

    • ▲

      removed the required property ////////// from the response with the status

      response-required-property-removed

    • ▲

      removed the required property ////////// from the response with the status

      response-required-property-removed

    • ▲

      removed the required property //// from the response with the status

      response-required-property-removed

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

  • f83e937202596See the full diff
    • ○

      added the optional property /////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /////// to the response with the status

      response-optional-property-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

  • 62e8dc4ed8691See the full diff
    • ○

      added the optional property ////// to the response with the status

      response-optional-property-added

  • 1e483c60b4801See the full diff
    • ○

      added the optional property ////////// to the response with the status

      response-optional-property-added

  • eb1ac21ec19c6See the full diff
    • ●

      removed the optional property ////// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property //// from the response with the status

      response-optional-property-removed

    • ●

      added the new prevented enum value to the ////////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new prevented enum value to the //////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new prevented enum value to the //////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new prevented enum value to the // response property for the response status

      response-property-enum-value-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

  • 7b79777e9bbd2See the full diff
    • ○

      added the optional property /////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /////// to the response with the status

      response-optional-property-added

  • c4dc6dbe947e1See the full diff
    • ○

      added the optional property /////// to the response with the status

      response-optional-property-added

  • 2df8ec106d359See the full diff
    • ○

      added the optional property //////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /////////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /////// to the response with the status

      response-optional-property-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

  • 34998f9d7d7310See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property //////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

  • 0d3b125ef9f38See the full diff
    • ●

      added the new stripe_balance_payment_debit enum value to the //////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new stripe_balance_payment_debit enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new stripe_balance_payment_debit enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new stripe_balance_payment_debit enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new stripe_balance_payment_debit_reversal enum value to the //////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new stripe_balance_payment_debit_reversal enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new stripe_balance_payment_debit_reversal enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new stripe_balance_payment_debit_reversal enum value to the response property for the response status

      response-property-enum-value-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

Of the 51 revisions, 14 have no diff computed and 6 have a changelog that could not be searched.