Stripe: List cash balance transactions

← Customers operations · Get started

Operation stripe.getcustomerscustomercashbalancetransactions

Provider route: GET /v1/customers/{customer}/cash_balance_transactions. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";

async function execute(input: Parameters<StripeIntegration["customers"]["getCustomersCustomerCashBalanceTransactions"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.customers.getCustomersCustomerCashBalanceTransactions(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.customers.get_customers_customer_cash_balance_transactions(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.customer	string	Required within parent	Maximum length: 5000
query	object	Optional	Additional keys: not allowed
query.ending_before	string	Optional	Maximum length: 5000
query.expand	array	Optional
query.expand[]	string	Each item	Maximum length: 5000
query.limit	integer	Optional
query.starting_after	string	Optional	Maximum length: 5000

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	object	Root	Customers with certain payments enabled have a cash balance, representing funds that were paid by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions represent when funds are moved into or out of this balance. This includes funding by the customer, allocation to payments, and refunds to the customer.
data	array	Required within parent	Details about each object.
data[]	Model	Each item	Expand Fund a test mode cash balance — response body
has_more	boolean	Required within parent	True if this list has another page of items after this one that can be fetched.
object	string	Required within parent	String representing the object’s type. Objects of the same type share the same value. Always has the value `list`. Known values: list
url	string	Required within parent	The URL where this list can be accessed. Maximum length: 5000

Referenced models: Fund a test mode cash balance — response body

Schemas

701 more schemas are linked from the tables above, on the schema pages.

Fund a test mode cash balance — response body

Field	Type	Presence	Description and constraints
$	object	Root	Customers with certain payments enabled have a cash balance, representing funds that were paid by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions represent when funds are moved into or out of this balance. This includes funding by the customer, allocation to payments, and refunds to the customer.
adjusted_for_overdraft	Model	Optional	Expand Fund a test mode cash balance — response body — adjusted for overdraft
applied_to_payment	Model	Optional	Expand Fund a test mode cash balance — response body — applied to payment
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currency	string	Required within parent	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). Maximum length: 5000
customer	JSON	Required within parent	The customer whose available cash balance changed as a result of this transaction.
customer (anyOf 1)	string	Alternative	Maximum length: 5000
customer (anyOf 2)	Model	Alternative	Expand Create a customer — response body
customer_account	JSON	Optional
customer_account (anyOf 1)	string	Alternative	The ID of an Account representing a customer whose available cash balance changed as a result of this transaction. Maximum length: 5000
customer_account (anyOf 2)	null	Alternative
ending_balance	JSON	Required within parent
ending_balance (anyOf 1)	integer	Alternative	The total available cash balance for the specified currency after this transaction was applied. Represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
ending_balance (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
funded	Model	Optional	Expand Fund a test mode cash balance — response body — funded
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
net_amount	JSON	Required within parent
net_amount (anyOf 1)	integer	Alternative	The amount by which the cash balance changed, represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance.
net_amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: customer_cash_balance_transaction
refunded_from_payment	Model	Optional	Expand Fund a test mode cash balance — response body — refunded from payment
transferred_to_balance	Model	Optional	Expand Fund a test mode cash balance — response body — transferred to balance
type	string	Required within parent	The type of the cash balance transaction. New types may be added in future. See [Customer Balance](https://docs.stripe.com/payments/customer-balance#types) to learn more about these types. Known values: adjusted_for_overdraft, applied_to_payment, funded, funding_reversed, refunded_from_payment, return_canceled, return_initiated, transferred_to_balance, unapplied_from_payment
unapplied_from_payment	Model	Optional	Expand Fund a test mode cash balance — response body — unapplied from payment

Referenced models: Create a customer — response body, Fund a test mode cash balance — response body — adjusted for overdraft, Fund a test mode cash balance — response body — applied to payment, Fund a test mode cash balance — response body — funded, Fund a test mode cash balance — response body — refunded from payment, Fund a test mode cash balance — response body — transferred to balance, Fund a test mode cash balance — response body — unapplied from payment

Fund a test mode cash balance — response body — adjusted for overdraft

Field	Type	Presence	Description and constraints
$	object	Root
balance_transaction	JSON	Required within parent	The [Balance Transaction](https://docs.stripe.com/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance.
balance_transaction (anyOf 1)	string	Alternative	Maximum length: 5000
balance_transaction (anyOf 2)	Model	Alternative	Expand Retrieve a balance transaction — balance get Balance History Id — response body
linked_transaction	JSON	Required within parent	The [Cash Balance Transaction](https://docs.stripe.com/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds.
linked_transaction (anyOf 1)	string	Alternative	Maximum length: 5000
linked_transaction (anyOf 2)	Model	Alternative	Expand Fund a test mode cash balance — response body

Referenced models: Retrieve a balance transaction — balance get Balance History Id — response body, Fund a test mode cash balance — response body

Fund a test mode cash balance — response body — applied to payment

Field	Type	Presence	Description and constraints
$	object	Root
payment_intent	JSON	Required within parent	The [Payment Intent](https://docs.stripe.com/api/payment_intents/object) that funds were applied to.
payment_intent (anyOf 1)	string	Alternative	Maximum length: 5000
payment_intent (anyOf 2)	Model	Alternative	Expand Cancel a Payment Intent — response body

Referenced models: Cancel a Payment Intent — response body

Fund a test mode cash balance — response body — funded

Field	Type	Presence	Description and constraints
$	object	Root
bank_transfer	Model	Required within parent	Expand Fund a test mode cash balance — response body — funded bank transfer

Referenced models: Fund a test mode cash balance — response body — funded bank transfer

Fund a test mode cash balance — response body — refunded from payment

Field	Type	Presence	Description and constraints
$	object	Root
refund	JSON	Required within parent	The [Refund](https://docs.stripe.com/api/refunds/object) that moved these funds into the customer's cash balance.
refund (anyOf 1)	string	Alternative	Maximum length: 5000
refund (anyOf 2)	Model	Alternative	Expand Cancel a refund — response body

Referenced models: Cancel a refund — response body

Fund a test mode cash balance — response body — transferred to balance

Field	Type	Presence	Description and constraints
$	object	Root
balance_transaction	JSON	Required within parent	The [Balance Transaction](https://docs.stripe.com/api/balance_transactions/object) that corresponds to funds transferred to your Stripe balance.
balance_transaction (anyOf 1)	string	Alternative	Maximum length: 5000
balance_transaction (anyOf 2)	Model	Alternative	Expand Retrieve a balance transaction — balance get Balance History Id — response body

Referenced models: Retrieve a balance transaction — balance get Balance History Id — response body

Fund a test mode cash balance — response body — unapplied from payment

Field	Type	Presence	Description and constraints
$	object	Root
payment_intent	JSON	Required within parent	The [Payment Intent](https://docs.stripe.com/api/payment_intents/object) that funds were unapplied from.
payment_intent (anyOf 1)	string	Alternative	Maximum length: 5000
payment_intent (anyOf 2)	Model	Alternative	Expand Cancel a Payment Intent — response body

Referenced models: Cancel a Payment Intent — response body

Pause a subscription — response body — presentment details

Field	Type	Presence	Description and constraints
$	object	Root
presentment_currency	string	Required within parent	Currency used for customer payments. Maximum length: 5000

Policy, approvals and errors

SDK function policy ID: stripe.getcustomerscustomercashbalancetransactions. Catalog operation: GetCustomersCustomerCashBalanceTransactions. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source