Package com.stripe.model

Class CashBalance

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.CashBalance

All Implemented Interfaces:

StripeActiveObject, StripeObjectInterface

public class CashBalance
extends ApiResource

A customer's Cash balance represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CashBalance.Settings	For more details about Settings, 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
CashBalance()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Map<String,Long>	getAvailable()	A hash of all cash balances available to this customer.
String	getCustomer()	The ID of the customer whose cash balance this object represents.
String	getCustomerAccount()	The ID of the account whose cash balance this object represents.
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.
CashBalance.Settings	getSettings()
int	hashCode()
static CashBalance	retrieve(String customer)	Retrieves a customer’s cash balance.
static CashBalance	retrieve(String customer, RequestOptions options)	Retrieves a customer’s cash balance.
static CashBalance	retrieve(String customer, CashBalanceRetrieveParams params, RequestOptions options)	Retrieves a customer’s cash balance.
static CashBalance	retrieve(String customer, Map<String,Object> params, RequestOptions options)	Retrieves a customer’s cash balance.
void	setAvailable(Map<String,Long> available)	A hash of all cash balances available to this customer.
void	setCustomer(String customer)	The ID of the customer whose cash balance this object represents.
void	setCustomerAccount(String customerAccount)	The ID of the account whose cash balance this object represents.
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	setResponseGetter(StripeResponseGetter responseGetter)	Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
void	setSettings(CashBalance.Settings settings)
CashBalance	update(CashBalanceUpdateParams params)	Changes the settings on a customer’s cash balance.
CashBalance	update(CashBalanceUpdateParams params, RequestOptions options)	Changes the settings on a customer’s cash balance.
CashBalance	update(Map<String,Object> params)	Changes the settings on a customer’s cash balance.
CashBalance	update(Map<String,Object> params, RequestOptions options)	Changes the settings on a customer’s cash balance.

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

CashBalance

public CashBalance()

Method Details

retrieve

public static CashBalance retrieve(String customer)
                            throws StripeException

Retrieves a customer’s cash balance.

Throws:

StripeException

retrieve

public static CashBalance retrieve(String customer,
 RequestOptions options)
                            throws StripeException

Retrieves a customer’s cash balance.

Throws:

StripeException

retrieve

public static CashBalance retrieve(String customer,
 Map<String,Object> params,
 RequestOptions options)
                            throws StripeException

Retrieves a customer’s cash balance.

Throws:

StripeException

retrieve

public static CashBalance retrieve(String customer,
 CashBalanceRetrieveParams params,
 RequestOptions options)
                            throws StripeException

Retrieves a customer’s cash balance.

Throws:

StripeException

update

public CashBalance update(Map<String,Object> params)
                   throws StripeException

Changes the settings on a customer’s cash balance.

Throws:

StripeException

update

public CashBalance update(Map<String,Object> params,
 RequestOptions options)
                   throws StripeException

Changes the settings on a customer’s cash balance.

Throws:

StripeException

update

public CashBalance update(CashBalanceUpdateParams params)
                   throws StripeException

Changes the settings on a customer’s cash balance.

Throws:

StripeException

update

public CashBalance update(CashBalanceUpdateParams params,
 RequestOptions options)
                   throws StripeException

Changes the settings on a customer’s cash balance.

Throws:

StripeException

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

Description copied from interface: StripeActiveObject

Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

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

getAvailable

public Map<String,Long> getAvailable()

A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the smallest currency unit.

getCustomer

public String getCustomer()

The ID of the customer whose cash balance this object represents.

getCustomerAccount

public String getCustomerAccount()

The ID of the account whose cash balance this object represents.

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 cash_balance.

getSettings

public CashBalance.Settings getSettings()

setAvailable

public void setAvailable(Map<String,Long> available)

A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the smallest currency unit.

setCustomer

public void setCustomer(String customer)

The ID of the customer whose cash balance this object represents.

setCustomerAccount

public void setCustomerAccount(String customerAccount)

The ID of the account whose cash balance this object represents.

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 cash_balance.

setSettings

public void setSettings(CashBalance.Settings settings)

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