Swagger Petstore - OpenAPI 3.0
GET/v1/balance

Retrieve account balance

Retrieves the current account balance based on the authentication used to make the request. The response includes available funds, pending funds, and funds held due to negative balances on connected accounts. Balance is broken down by currency and payment type.

1 parameter
expandarray<string>optional

Specifies which fields in the response should be expanded to include nested objects.

2 status codes
200Returns the balance object with available, pending, and reserved funds broken down by currency and payment type.
availablearray<BalanceAmount>required

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_types property.

connect_reservedarray<BalanceAmount>optional

Funds held due to negative balances on connected accounts where account.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.

instant_availablearray<BalanceAmountNet>optional

Funds that you can pay out using Instant Payouts.

issuingobjectoptional
livemodebooleanrequired

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

objectstringrequired

String representing the object's type. Objects of the same type share the same value.

Allowed:balance
pendingarray<BalanceAmount>required

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.

refund_and_dispute_prefundingobjectoptional
defaultError response.
errorobjectrequired

Error handling

The expand parameter accepts an array of field names to include nested objects in the response. No required parameters or constraints beyond valid authentication.