Package com.stripe.model

Class Balance

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.Balance
All Implemented Interfaces:
StripeObjectInterface
public class Balance extends ApiResource
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.

  • Constructor Details

    • Balance

      public Balance()

  • Method Details

    • retrieve

      public static Balance retrieve() throws StripeException
      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.
      Throws:
      StripeException

    • retrieve

      public static Balance retrieve(RequestOptions options) throws StripeException
      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.
      Throws:
      StripeException

    • retrieve

      public static Balance retrieve(Map<String,Object> params, RequestOptions options) throws StripeException
      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.
      Throws:
      StripeException

    • retrieve

      public static Balance retrieve(BalanceRetrieveParams params, RequestOptions options) throws StripeException
      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.
      Throws:
      StripeException

    • getAvailable

      public List<Balance.Available> getAvailable()
      Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the Transfers API or Payouts API. The available balance for each currency and payment type can be found in the source_types property.

    • getConnectReserved

      public List<Balance.ConnectReserved> getConnectReserved()
      Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the source_types property.

    • getInstantAvailable

      public List<Balance.InstantAvailable> getInstantAvailable()
      Funds that can be paid out using Instant Payouts.

    • getIssuing

      public Balance.Issuing getIssuing()

    • getLivemode

      public Boolean getLivemode()
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • getObject

      public String getObject()
      String representing the object's type. Objects of the same type share the same value.

      Equal to balance.

    • getPending

      public List<Balance.Pending> getPending()
      Funds that are not yet available in the balance, due to the 7-day rolling pay cycle. The pending balance for each currency, and for each payment type, can be found in the source_types property.

    • setAvailable

      public void setAvailable(List<Balance.Available> available)
      Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the Transfers API or Payouts API. The available balance for each currency and payment type can be found in the source_types property.

    • setConnectReserved

      public void setConnectReserved(List<Balance.ConnectReserved> connectReserved)
      Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the source_types property.

    • setInstantAvailable

      public void setInstantAvailable(List<Balance.InstantAvailable> instantAvailable)
      Funds that can be paid out using Instant Payouts.

    • setIssuing

      public void setIssuing(Balance.Issuing issuing)

    • setLivemode

      public void setLivemode(Boolean livemode)
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • setObject

      public void setObject(String object)
      String representing the object's type. Objects of the same type share the same value.

      Equal to balance.

    • setPending

      public void setPending(List<Balance.Pending> pending)
      Funds that are not yet available in the balance, due to the 7-day rolling pay cycle. The pending balance for each currency, and for each payment type, can be found in the source_types property.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object