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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Balance.Details
static class	Balance.Money

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
Balance()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(java.lang.Object other)
boolean	equals(java.lang.Object o)
java.util.List<Balance.Money>	getAvailable()	Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the Transfers API or Payouts API.
java.util.List<Balance.Money>	getConnectReserved()	Funds held due to negative balances on connected Custom accounts.
java.util.List<Balance.Money>	getInstantAvailable()	Funds that can be paid out using Instant Payouts.
Balance.Details	getIssuing()
java.lang.Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
java.lang.String	getObject()	String representing the object's type.
java.util.List<Balance.Money>	getPending()	Funds that are not yet available in the balance, due to the 7-day rolling pay cycle.
int	hashCode()
static Balance	retrieve()	Retrieves the current account balance, based on the authentication that was used to make the request.
static Balance	retrieve(RequestOptions options)	Retrieves the current account balance, based on the authentication that was used to make the request.
static Balance	retrieve(BalanceRetrieveParams params, RequestOptions options)	Retrieves the current account balance, based on the authentication that was used to make the request.
static Balance	retrieve(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Retrieves the current account balance, based on the authentication that was used to make the request.
void	setAvailable(java.util.List<Balance.Money> available)	Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the Transfers API or Payouts API.
void	setConnectReserved(java.util.List<Balance.Money> connectReserved)	Funds held due to negative balances on connected Custom accounts.
void	setInstantAvailable(java.util.List<Balance.Money> instantAvailable)	Funds that can be paid out using Instant Payouts.
void	setIssuing(Balance.Details issuing)
void	setLivemode(java.lang.Boolean livemode)	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
void	setObject(java.lang.String object)	String representing the object's type.
void	setPending(java.util.List<Balance.Money> pending)	Funds that are not yet available in the balance, due to the 7-day rolling pay cycle.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Balance

public Balance()

Method Detail

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(java.util.Map<java.lang.String,java.lang.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 java.util.List<Balance.Money> 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 java.util.List<Balance.Money> 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 java.util.List<Balance.Money> getInstantAvailable()

Funds that can be paid out using Instant Payouts.

getIssuing

public Balance.Details getIssuing()

getLivemode

public java.lang.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 java.lang.String getObject()

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

Equal to balance.

getPending

public java.util.List<Balance.Money> 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(java.util.List<Balance.Money> 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(java.util.List<Balance.Money> 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(java.util.List<Balance.Money> instantAvailable)

Funds that can be paid out using Instant Payouts.

setIssuing

public void setIssuing(Balance.Details issuing)

setLivemode

public void setLivemode(java.lang.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(java.lang.String object)

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

Equal to balance.

setPending

public void setPending(java.util.List<Balance.Money> 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(java.lang.Object o)

Overrides:

equals in class java.lang.Object

canEqual

protected boolean canEqual(java.lang.Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object