Stripe: Retrieve balance

← Balance operations · Get started

Operation stripe.getbalance

Provider route: GET /v1/balance. 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["balance"]["getBalance"]>[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.balance.getBalance(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.balance.get_balance(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.expand	array	Optional
query.expand[]	string	Each item	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
$	Model	Root	Expand Retrieve balance — response body

Referenced models: Retrieve balance — response body

Schemas

Retrieve balance — response body

Field	Type	Presence	Description and constraints
$	object	Root	This is an object representing your Stripe balance. You can retrieve it to see the balance currently on your Stripe account. The top-level `available` and `pending` comprise your "payments balance." Related guide: [Balances and settlement time](https://docs.stripe.com/payments/balances), [Understanding Connect account balances](https://docs.stripe.com/connect/account-balances)
available	array	Required within parent	Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://docs.stripe.com/api#transfers) or [Payouts API](https://docs.stripe.com/api#payouts). You can find the available balance for each currency and payment type in the `source_types` property.
available[]	Model	Each item	Expand Retrieve balance — response body — pending item
connect_reserved	array	Optional	Funds held due to negative balances on connected accounts where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property.
connect_reserved[]	Model	Each item	Expand Retrieve balance — response body — pending item
instant_available	array	Optional	Funds that you can pay out using Instant Payouts.
instant_available[]	Model	Each item	Expand Retrieve balance — response body — instant available item
issuing	Model	Optional	Expand Retrieve balance — response body — issuing
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`.
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: balance
pending	array	Required within parent	Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the `source_types` property.
pending[]	Model	Each item	Expand Retrieve balance — response body — pending item
refund_and_dispute_prefunding	Model	Optional	Expand Retrieve balance — response body — refund and dispute prefunding

Referenced models: Retrieve balance — response body — pending item, Retrieve balance — response body — instant available item, Retrieve balance — response body — issuing, Retrieve balance — response body — refund and dispute prefunding

Retrieve balance — response body — pending item

Field	Type	Presence	Description and constraints
$	object	Root
amount	JSON	Required within parent
amount (anyOf 1)	integer	Alternative	Balance amount.
amount (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). Format: currency
source_types	Model	Optional	Expand Retrieve balance — response body — pending item source types

Referenced models: Retrieve balance — response body — pending item source types

Retrieve balance — response body — instant available item

Field	Type	Presence	Description and constraints
$	object	Root
amount	JSON	Required within parent
amount (anyOf 1)	integer	Alternative	Balance amount.
amount (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). Format: currency
net_available	array	Optional	Breakdown of balance by destination.
net_available[]	Model	Each item	Expand Retrieve balance — response body — instant available item net available item
source_types	Model	Optional	Expand Retrieve balance — response body — pending item source types

Referenced models: Retrieve balance — response body — pending item source types, Retrieve balance — response body — instant available item net available item

Retrieve balance — response body — issuing

Field	Type	Presence	Description and constraints
$	object	Root
available	array	Required within parent	Funds that are available for use.
available[]	Model	Each item	Expand Retrieve balance — response body — pending item

Referenced models: Retrieve balance — response body — pending item

Retrieve balance — response body — refund and dispute prefunding

Field	Type	Presence	Description and constraints
$	object	Root
available	array	Required within parent	Funds that are available for use.
available[]	Model	Each item	Expand Retrieve balance — response body — pending item
pending	array	Required within parent	Funds that are pending
pending[]	Model	Each item	Expand Retrieve balance — response body — pending item

Referenced models: Retrieve balance — response body — pending item

Retrieve balance — response body — pending item source types

Field	Type	Presence	Description and constraints
$	object	Root
bank_account	JSON	Optional
bank_account (anyOf 1)	integer	Alternative	Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
bank_account (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
card	JSON	Optional
card (anyOf 1)	integer	Alternative	Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
card (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fpx	JSON	Optional
fpx (anyOf 1)	integer	Alternative	Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
fpx (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve balance — response body — instant available item net available item

Field	Type	Presence	Description and constraints
$	object	Root
amount	JSON	Required within parent
amount (anyOf 1)	integer	Alternative	Net balance amount, subtracting fees from platform-set pricing.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
destination	string	Required within parent	ID of the external account for this net balance (not expandable). Maximum length: 5000
source_types	Model	Optional	Expand Retrieve balance — response body — pending item source types

Referenced models: Retrieve balance — response body — pending item source types

Policy, approvals and errors

SDK function policy ID: stripe.getbalance. Catalog operation: GetBalance. 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