Package com.stripe.model

Class Balance

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.Balance

All Implemented Interfaces:

StripeActiveObject, 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.

The top-level available and pending comprise your "payments balance."

Related guide: Balances and settlement time, Understanding Connect account balances

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Balance.Available	For more details about Available, please refer to the API Reference.
static class	Balance.ConnectReserved	For more details about ConnectReserved, please refer to the API Reference.
static class	Balance.InstantAvailable	For more details about InstantAvailable, please refer to the API Reference.
static class	Balance.Issuing	For more details about Issuing, please refer to the API Reference.
static class	Balance.Pending	For more details about Pending, please refer to the API Reference.
static class	Balance.RefundAndDisputePrefunding	For more details about RefundAndDisputePrefunding, please refer to the API Reference.
static class	Balance.TransitBalancesTotal	For more details about TransitBalancesTotal, please refer to the API Reference.

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

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON, INTERNAL_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(Object other)
boolean	equals(Object o)
List<Balance.Available>	getAvailable()	Available funds that you can transfer or pay out automatically by Stripe or explicitly through the Transfers API or Payouts API.
List<Balance.ConnectReserved>	getConnectReserved()	Funds held due to negative balances on connected accounts where account.controller.requirement_collection is application, which includes Custom accounts.
List<Balance.InstantAvailable>	getInstantAvailable()	Funds that you can pay out using Instant Payouts.
Balance.Issuing	getIssuing()
Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
String	getObject()	String representing the object's type.
List<Balance.Pending>	getPending()	Funds that aren't available in the balance yet.
Balance.RefundAndDisputePrefunding	getRefundAndDisputePrefunding()
Balance.TransitBalancesTotal	getTransitBalancesTotal()
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(Map<String,Object> params, RequestOptions options)	Retrieves the current account balance, based on the authentication that was used to make the request.
void	setAvailable(List<Balance.Available> available)	Available funds that you can transfer or pay out automatically by Stripe or explicitly through the Transfers API or Payouts API.
void	setConnectReserved(List<Balance.ConnectReserved> connectReserved)	Funds held due to negative balances on connected accounts where account.controller.requirement_collection is application, which includes Custom accounts.
void	setInstantAvailable(List<Balance.InstantAvailable> instantAvailable)	Funds that you can pay out using Instant Payouts.
void	setIssuing(Balance.Issuing issuing)
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.
void	setObject(String object)	String representing the object's type.
void	setPending(List<Balance.Pending> pending)	Funds that aren't available in the balance yet.
void	setRefundAndDisputePrefunding(Balance.RefundAndDisputePrefunding refundAndDisputePrefunding)
void	setResponseGetter(StripeResponseGetter responseGetter)	Amount coming from FPX, a Malaysian payment method.
void	setTransitBalancesTotal(Balance.TransitBalancesTotal transitBalancesTotal)

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.stripe.model.StripeActiveObject

trySetResponseGetter

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

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

Amount coming from FPX, a Malaysian payment method.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

responseGetter - the StripeResponseGetter instance to use for making further requests.

getAvailable

public List<Balance.Available> getAvailable()

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.

getConnectReserved

public List<Balance.ConnectReserved> getConnectReserved()

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.

getInstantAvailable

public List<Balance.InstantAvailable> getInstantAvailable()

Funds that you can pay 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 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.

getRefundAndDisputePrefunding

public Balance.RefundAndDisputePrefunding getRefundAndDisputePrefunding()

getTransitBalancesTotal

public Balance.TransitBalancesTotal getTransitBalancesTotal()

setAvailable

public void setAvailable(List<Balance.Available> available)

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.

setConnectReserved

public void setConnectReserved(List<Balance.ConnectReserved> connectReserved)

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.

setInstantAvailable

public void setInstantAvailable(List<Balance.InstantAvailable> instantAvailable)

Funds that you can pay 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 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.

setRefundAndDisputePrefunding

public void setRefundAndDisputePrefunding(Balance.RefundAndDisputePrefunding refundAndDisputePrefunding)

setTransitBalancesTotal

public void setTransitBalancesTotal(Balance.TransitBalancesTotal transitBalancesTotal)

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