Balances
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, Understanding Connect account balances
Was this section helpful? Yes No
Retrieve balance
GET / v1 / balance
The Balance object
Attributes
- available array 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_typesproperty. - pending array 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_typesproperty.
More attributes
- object string, value is "balance"
- connect _ reserved nullable array of objects Connect only
- instant _ available nullable array of objects
- issuing nullable object
- livemode boolean
- refund _ and _ dispute _ prefunding nullable object
The Balance 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 } } ]}
Retrieve balance
GET / v1 / balance
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.
Response
{ "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 } } ]}