This is an object representing your Stripe balance. You can retrieve it to see the balance currently on your Stripe account.
You can also retrieve the balance history, which contains a list of transactions that contributed to the balance (charges, payouts, and so forth).
The available and pending amounts for each currency are broken down further by payment source types.
Related guide: Understanding Connect account balances
Attributes
- availablearray of objects
Available funds that you can transfer or pay out automatically by Stripe or explicitly through the Transfers API or Payouts API. You can find the available balance for each currency and payment type in the
source_
property.types - pendingarray of objects
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_
property.types
More attributes
- objectstring
- connect_
reservednullable array of objectsConnect only - instant_
availablenullable array of objects - issuingnullable object
- livemodeboolean
- refund_
and_ dispute_ prefundingnullable object
{ "object": "balance", "available": [ { "amount": 666670, "currency": "usd", "source_types": { "card": 666670 } } ], "connect_reserved": [ { "amount": 0, "currency": "usd" } ], "livemode": false, "pending": [ { "amount": 61414, "currency": "usd", "source_types": { "card": 61414 } } ]}
Retrieves the current account balance, based on the authentication that was used to make the request. For a sample request, see Accounting for negative balances.
Parameters
No parameters.
Returns
Returns a balance object for the account that was authenticated in the request.
{ "object": "balance", "available": [ { "amount": 666670, "currency": "usd", "source_types": { "card": 666670 } } ], "connect_reserved": [ { "amount": 0, "currency": "usd" } ], "livemode": false, "pending": [ { "amount": 61414, "currency": "usd", "source_types": { "card": 61414 } } ]}
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
The Charge
object represents a single attempt to move money into your Stripe account. PaymentIntent confirmation is the most common way to create Charges, but transferring money to a different Stripe account through Connect also creates Charges. Some legacy payment flows create Charges directly, which is not recommended for new integrations.