List all 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 /v1/balance/history.

get/v1/balance_transactions

Query parameters

OR
integer

Only return transactions that were created during the given date interval.

currencystring currency

Only return transactions in a certain currency. Three-letter ISO currency code, in lowercase. Must be a supported currency.

ending_beforestring

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

expandstring[]

Specifies which fields in the response should be expanded.

limitinteger

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

payoutstring

For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.

sourcestring

Only returns transactions associated with the given object.

starting_afterstring

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

typestring

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.

Response

Successful response.

has_moreboolean required

True if this list has another page of items after this one that can be fetched.

object'list' required

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

urlstring required

The URL where this list can be accessed.

Changes

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

    • removed the required property data/items/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the default status

      response-required-property-removed

    • removed the required property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the default status

      response-required-property-removed

    • removed the required property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the default status

      response-required-property-removed

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

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/acss_debit/expected_debit_date to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/au_becs_debit/expected_debit_date to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/bacs_debit/expected_debit_date to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/nz_bank_account/expected_debit_date to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/sepa_debit/expected_debit_date to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/us_bank_account/expected_debit_date to the response with the default status

      response-optional-property-added

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

    • added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/card_present/anyOf[subschema #1: payment_method_options_card_present]/capture_method to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/amount_details/anyOf[subschema #1: PaymentFlowsAmountDetails]/line_items/data/items/payment_method_options/anyOf[subschema #1: PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItemResourcePaymentMethodOptions]/klarna/subscription_reference to the response with the default status

      response-optional-property-added

    • removed the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paypay from the response with the default status

      response-optional-property-removed

    • removed the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/paypay from the response with the default status

      response-optional-property-removed

    • added the new prevented enum value to the data/items/source/anyOf[subschema #6: Dispute]/status response property for the response status 200

      response-property-enum-value-added

    • added the new prevented enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/status response property for the response status default

      response-property-enum-value-added

    • added the new prevented enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/status response property for the response status default

      response-property-enum-value-added

    • added the new prevented enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/status response property for the response status default

      response-property-enum-value-added

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

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/location to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/reader to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/cashapp/transaction_id to the response with the default status

      response-optional-property-added

    • added the optional property data/items/source/anyOf[subschema #12: Refund]/destination_details/paypal/network_decline_code to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/destination_details/paypal/network_decline_code to the response with the 200 status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/destination_details/paypal/network_decline_code to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/destination_details/paypal/network_decline_code to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/destination_details/paypal/network_decline_code to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/destination_details/paypal/network_decline_code to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/destination_details/paypal/network_decline_code to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/destination_details/paypal/network_decline_code to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/refunds/data/items/destination_details/paypal/network_decline_code to the response with the default status

      response-optional-property-added

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

    • added the optional property data/items/balance_type to the response with the 200 status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/balance_type to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/balance_type to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/balance_type to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/affirm/location to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/affirm/reader to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/wechat_pay/location to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/wechat_pay/reader to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/billie/anyOf[subschema #1: payment_method_options_billie]/capture_method to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/satispay to the response with the default status

      response-optional-property-added

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

    • added the new stripe_balance_payment_debit enum value to the data/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new stripe_balance_payment_debit enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status default

      response-property-enum-value-added

    • added the new stripe_balance_payment_debit enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status default

      response-property-enum-value-added

    • added the new stripe_balance_payment_debit enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status default

      response-property-enum-value-added

    • added the new stripe_balance_payment_debit_reversal enum value to the data/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new stripe_balance_payment_debit_reversal enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status default

      response-property-enum-value-added

    • added the new stripe_balance_payment_debit_reversal enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status default

      response-property-enum-value-added

    • added the new stripe_balance_payment_debit_reversal enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status default

      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.