This is an object representing your Stripe balance. You can retrieve it to see the balance currently on your Stripe account.
The top-levelavailable andpending comprise your “payments balance.”
Related guide:Balances and settlement time,Understanding Connect account balances
Attributes
- availablearray of objects
Available funds that you can transfer or pay out automatically by Stripe or explicitly through theTransfers API orPayouts 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, seeAccounting 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}}]}