Package com.stripe.model.treasury

Class FinancialAccount

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.treasury.FinancialAccount

All Implemented Interfaces:

HasId, MetadataStore<FinancialAccount>, StripeActiveObject, StripeObjectInterface

public class FinancialAccount
extends ApiResource
implements HasId, MetadataStore<FinancialAccount>

Legacy FinancialAccounts are part of the v1 version of Treasury for platforms and do not support many of the features introduced in Treasury for platforms v2. Use Financial Accounts instead of building a new v1 integration.

Stripe Treasury for Platforms provides users with a container for money called a FinancialAccount that is separate from their Payments balance. FinancialAccounts serve as the source and destination of Treasury for Platform’s money movement APIs.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FinancialAccount.Balance	Balance information for the FinancialAccount.
static class	FinancialAccount.FinancialAddress	FinancialAddresses contain identifying information that resolves to a FinancialAccount.
static class	FinancialAccount.PlatformRestrictions	Restrictions that a Connect Platform has placed on this FinancialAccount.
static class	FinancialAccount.StatusDetails	For more details about StatusDetails, 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
FinancialAccount()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
FinancialAccount	close()	Closes a FinancialAccount.
FinancialAccount	close(RequestOptions options)	Closes a FinancialAccount.
FinancialAccount	close(FinancialAccountCloseParams params)	Closes a FinancialAccount.
FinancialAccount	close(FinancialAccountCloseParams params, RequestOptions options)	Closes a FinancialAccount.
FinancialAccount	close(Map<String,Object> params)	Closes a FinancialAccount.
FinancialAccount	close(Map<String,Object> params, RequestOptions options)	Closes a FinancialAccount.
static FinancialAccount	create(FinancialAccountCreateParams params)	Creates a new FinancialAccount.
static FinancialAccount	create(FinancialAccountCreateParams params, RequestOptions options)	Creates a new FinancialAccount.
static FinancialAccount	create(Map<String,Object> params)	Creates a new FinancialAccount.
static FinancialAccount	create(Map<String,Object> params, RequestOptions options)	Creates a new FinancialAccount.
boolean	equals(Object o)
List<String>	getActiveFeatures()	The array of paths to active Features in the Features hash.
FinancialAccount.Balance	getBalance()	Balance information for the FinancialAccount.
String	getCountry()	Two-letter country code (ISO 3166-1 alpha-2).
Long	getCreated()	Time at which the object was created.
FinancialAccountFeatures	getFeatures()	Encodes whether a FinancialAccount has access to a particular Feature, with a status enum and associated status_details.
List<FinancialAccount.FinancialAddress>	getFinancialAddresses()	The set of credentials that resolve to a FinancialAccount.
String	getId()	Unique identifier for the object.
Boolean	getIsDefault()
Boolean	getLivemode()	If the object exists in live mode, the value is true.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getNickname()	The nickname for the FinancialAccount.
String	getObject()	String representing the object's type.
List<String>	getPendingFeatures()	The array of paths to pending Features in the Features hash.
FinancialAccount.PlatformRestrictions	getPlatformRestrictions()	The set of functionalities that the platform can restrict on the FinancialAccount.
List<String>	getRestrictedFeatures()	The array of paths to restricted Features in the Features hash.
String	getStatus()	Status of this FinancialAccount.
FinancialAccount.StatusDetails	getStatusDetails()
List<String>	getSupportedCurrencies()	The currencies the FinancialAccount can hold a balance in.
int	hashCode()
static FinancialAccountCollection	list(FinancialAccountListParams params)	Returns a list of FinancialAccounts.
static FinancialAccountCollection	list(FinancialAccountListParams params, RequestOptions options)	Returns a list of FinancialAccounts.
static FinancialAccountCollection	list(Map<String,Object> params)	Returns a list of FinancialAccounts.
static FinancialAccountCollection	list(Map<String,Object> params, RequestOptions options)	Returns a list of FinancialAccounts.
static FinancialAccount	retrieve(String financialAccount)	Retrieves the details of a FinancialAccount.
static FinancialAccount	retrieve(String financialAccount, RequestOptions options)	Retrieves the details of a FinancialAccount.
static FinancialAccount	retrieve(String financialAccount, FinancialAccountRetrieveParams params, RequestOptions options)	Retrieves the details of a FinancialAccount.
static FinancialAccount	retrieve(String financialAccount, Map<String,Object> params, RequestOptions options)	Retrieves the details of a FinancialAccount.
FinancialAccountFeatures	retrieveFeatures()	Retrieves Features information associated with the FinancialAccount.
FinancialAccountFeatures	retrieveFeatures(FinancialAccountRetrieveFeaturesParams params)	Retrieves Features information associated with the FinancialAccount.
FinancialAccountFeatures	retrieveFeatures(FinancialAccountRetrieveFeaturesParams params, RequestOptions options)	Retrieves Features information associated with the FinancialAccount.
FinancialAccountFeatures	retrieveFeatures(Map<String,Object> params)	Retrieves Features information associated with the FinancialAccount.
FinancialAccountFeatures	retrieveFeatures(Map<String,Object> params, RequestOptions options)	Retrieves Features information associated with the FinancialAccount.
void	setActiveFeatures(List<String> activeFeatures)	The array of paths to active Features in the Features hash.
void	setBalance(FinancialAccount.Balance balance)	Balance information for the FinancialAccount.
void	setCountry(String country)	Two-letter country code (ISO 3166-1 alpha-2).
void	setCreated(Long created)	Time at which the object was created.
void	setFeatures(FinancialAccountFeatures features)	Encodes whether a FinancialAccount has access to a particular Feature, with a status enum and associated status_details.
void	setFinancialAddresses(List<FinancialAccount.FinancialAddress> financialAddresses)	The set of credentials that resolve to a FinancialAccount.
void	setId(String id)	Unique identifier for the object.
void	setIsDefault(Boolean isDefault)
void	setLivemode(Boolean livemode)	If the object exists in live mode, the value is true.
void	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
void	setNickname(String nickname)	The nickname for the FinancialAccount.
void	setObject(String object)	String representing the object's type.
void	setPendingFeatures(List<String> pendingFeatures)	The array of paths to pending Features in the Features hash.
void	setPlatformRestrictions(FinancialAccount.PlatformRestrictions platformRestrictions)	The set of functionalities that the platform can restrict on the FinancialAccount.
void	setResponseGetter(StripeResponseGetter responseGetter)	The array that contains reasons for a FinancialAccount closure.
void	setRestrictedFeatures(List<String> restrictedFeatures)	The array of paths to restricted Features in the Features hash.
void	setStatus(String status)	Status of this FinancialAccount.
void	setStatusDetails(FinancialAccount.StatusDetails statusDetails)
void	setSupportedCurrencies(List<String> supportedCurrencies)	The currencies the FinancialAccount can hold a balance in.
FinancialAccount	update(FinancialAccountUpdateParams params)	Updates the details of a FinancialAccount.
FinancialAccount	update(FinancialAccountUpdateParams params, RequestOptions options)	Updates the details of a FinancialAccount.
FinancialAccount	update(Map<String,Object> params)	Updates the details of a FinancialAccount.
FinancialAccount	update(Map<String,Object> params, RequestOptions options)	Updates the details of a FinancialAccount.
FinancialAccountFeatures	updateFeatures()	Updates the Features associated with a FinancialAccount.
FinancialAccountFeatures	updateFeatures(RequestOptions options)	Updates the Features associated with a FinancialAccount.
FinancialAccountFeatures	updateFeatures(FinancialAccountUpdateFeaturesParams params)	Updates the Features associated with a FinancialAccount.
FinancialAccountFeatures	updateFeatures(FinancialAccountUpdateFeaturesParams params, RequestOptions options)	Updates the Features associated with a FinancialAccount.
FinancialAccountFeatures	updateFeatures(Map<String,Object> params)	Updates the Features associated with a FinancialAccount.
FinancialAccountFeatures	updateFeatures(Map<String,Object> params, RequestOptions options)	Updates the Features associated with a FinancialAccount.

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

FinancialAccount

public FinancialAccount()

Method Details

close

public FinancialAccount close()
                       throws StripeException

Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.

Throws:

StripeException

close

public FinancialAccount close(RequestOptions options)
                       throws StripeException

Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.

Throws:

StripeException

close

public FinancialAccount close(Map<String,Object> params)
                       throws StripeException

Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.

Throws:

StripeException

close

public FinancialAccount close(Map<String,Object> params,
 RequestOptions options)
                       throws StripeException

Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.

Throws:

StripeException

close

public FinancialAccount close(FinancialAccountCloseParams params)
                       throws StripeException

Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.

Throws:

StripeException

close

public FinancialAccount close(FinancialAccountCloseParams params,
 RequestOptions options)
                       throws StripeException

Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.

Throws:

StripeException

create

public static FinancialAccount create(Map<String,Object> params)
                               throws StripeException

Creates a new FinancialAccount. Each connected account can have up to three FinancialAccounts by default.

Throws:

StripeException

create

public static FinancialAccount create(Map<String,Object> params,
 RequestOptions options)
                               throws StripeException

Creates a new FinancialAccount. Each connected account can have up to three FinancialAccounts by default.

Throws:

StripeException

create

public static FinancialAccount create(FinancialAccountCreateParams params)
                               throws StripeException

Creates a new FinancialAccount. Each connected account can have up to three FinancialAccounts by default.

Throws:

StripeException

create

public static FinancialAccount create(FinancialAccountCreateParams params,
 RequestOptions options)
                               throws StripeException

Creates a new FinancialAccount. Each connected account can have up to three FinancialAccounts by default.

Throws:

StripeException

list

public static FinancialAccountCollection list(Map<String,Object> params)
                                       throws StripeException

Returns a list of FinancialAccounts.

Throws:

StripeException

list

public static FinancialAccountCollection list(Map<String,Object> params,
 RequestOptions options)
                                       throws StripeException

Returns a list of FinancialAccounts.

Throws:

StripeException

list

public static FinancialAccountCollection list(FinancialAccountListParams params)
                                       throws StripeException

Returns a list of FinancialAccounts.

Throws:

StripeException

list

public static FinancialAccountCollection list(FinancialAccountListParams params,
 RequestOptions options)
                                       throws StripeException

Returns a list of FinancialAccounts.

Throws:

StripeException

retrieve

public static FinancialAccount retrieve(String financialAccount)
                                 throws StripeException

Retrieves the details of a FinancialAccount.

Throws:

StripeException

retrieve

public static FinancialAccount retrieve(String financialAccount,
 RequestOptions options)
                                 throws StripeException

Retrieves the details of a FinancialAccount.

Throws:

StripeException

retrieve

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

Retrieves the details of a FinancialAccount.

Throws:

StripeException

retrieve

public static FinancialAccount retrieve(String financialAccount,
 FinancialAccountRetrieveParams params,
 RequestOptions options)
                                 throws StripeException

Retrieves the details of a FinancialAccount.

Throws:

StripeException

retrieveFeatures

public FinancialAccountFeatures retrieveFeatures()
                                          throws StripeException

Retrieves Features information associated with the FinancialAccount.

Throws:

StripeException

retrieveFeatures

public FinancialAccountFeatures retrieveFeatures(Map<String,Object> params)
                                          throws StripeException

Retrieves Features information associated with the FinancialAccount.

Throws:

StripeException

retrieveFeatures

public FinancialAccountFeatures retrieveFeatures(Map<String,Object> params,
 RequestOptions options)
                                          throws StripeException

Retrieves Features information associated with the FinancialAccount.

Throws:

StripeException

retrieveFeatures

public FinancialAccountFeatures retrieveFeatures(FinancialAccountRetrieveFeaturesParams params)
                                          throws StripeException

Retrieves Features information associated with the FinancialAccount.

Throws:

StripeException

retrieveFeatures

public FinancialAccountFeatures retrieveFeatures(FinancialAccountRetrieveFeaturesParams params,
 RequestOptions options)
                                          throws StripeException

Retrieves Features information associated with the FinancialAccount.

Throws:

StripeException

update

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

Updates the details of a FinancialAccount.

Specified by:

update in interface MetadataStore<FinancialAccount>

Throws:

StripeException

update

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

Updates the details of a FinancialAccount.

Specified by:

update in interface MetadataStore<FinancialAccount>

Throws:

StripeException

update

public FinancialAccount update(FinancialAccountUpdateParams params)
                        throws StripeException

Updates the details of a FinancialAccount.

Throws:

StripeException

update

public FinancialAccount update(FinancialAccountUpdateParams params,
 RequestOptions options)
                        throws StripeException

Updates the details of a FinancialAccount.

Throws:

StripeException

updateFeatures

public FinancialAccountFeatures updateFeatures()
                                        throws StripeException

Updates the Features associated with a FinancialAccount.

Throws:

StripeException

updateFeatures

public FinancialAccountFeatures updateFeatures(RequestOptions options)
                                        throws StripeException

Updates the Features associated with a FinancialAccount.

Throws:

StripeException

updateFeatures

public FinancialAccountFeatures updateFeatures(Map<String,Object> params)
                                        throws StripeException

Updates the Features associated with a FinancialAccount.

Throws:

StripeException

updateFeatures

public FinancialAccountFeatures updateFeatures(Map<String,Object> params,
 RequestOptions options)
                                        throws StripeException

Updates the Features associated with a FinancialAccount.

Throws:

StripeException

updateFeatures

public FinancialAccountFeatures updateFeatures(FinancialAccountUpdateFeaturesParams params)
                                        throws StripeException

Updates the Features associated with a FinancialAccount.

Throws:

StripeException

updateFeatures

public FinancialAccountFeatures updateFeatures(FinancialAccountUpdateFeaturesParams params,
 RequestOptions options)
                                        throws StripeException

Updates the Features associated with a FinancialAccount.

Throws:

StripeException

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

The array that contains reasons for a FinancialAccount closure.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

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

getActiveFeatures

public List<String> getActiveFeatures()

The array of paths to active Features in the Features hash.

getBalance

public FinancialAccount.Balance getBalance()

Balance information for the FinancialAccount.

getCountry

public String getCountry()

Two-letter country code (ISO 3166-1 alpha-2).

getCreated

public Long getCreated()

Time at which the object was created. Measured in seconds since the Unix epoch.

getFeatures

public FinancialAccountFeatures getFeatures()

Encodes whether a FinancialAccount has access to a particular Feature, with a status enum and associated status_details. Stripe or the platform can control Features via the requested field.

getFinancialAddresses

public List<FinancialAccount.FinancialAddress> getFinancialAddresses()

The set of credentials that resolve to a FinancialAccount.

getIsDefault

public Boolean getIsDefault()

getLivemode

public Boolean getLivemode()

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

getNickname

public String getNickname()

The nickname for the FinancialAccount.

getObject

public String getObject()

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

Equal to treasury.financial_account.

getPendingFeatures

public List<String> getPendingFeatures()

The array of paths to pending Features in the Features hash.

getPlatformRestrictions

public FinancialAccount.PlatformRestrictions getPlatformRestrictions()

The set of functionalities that the platform can restrict on the FinancialAccount.

getRestrictedFeatures

public List<String> getRestrictedFeatures()

The array of paths to restricted Features in the Features hash.

getStatus

public String getStatus()

Status of this FinancialAccount.

One of closed, or open.

getStatusDetails

public FinancialAccount.StatusDetails getStatusDetails()

getSupportedCurrencies

public List<String> getSupportedCurrencies()

The currencies the FinancialAccount can hold a balance in. Three-letter ISO currency code, in lowercase.

setActiveFeatures

public void setActiveFeatures(List<String> activeFeatures)

The array of paths to active Features in the Features hash.

setBalance

public void setBalance(FinancialAccount.Balance balance)

Balance information for the FinancialAccount.

setCountry

public void setCountry(String country)

Two-letter country code (ISO 3166-1 alpha-2).

setCreated

public void setCreated(Long created)

Time at which the object was created. Measured in seconds since the Unix epoch.

setFeatures

public void setFeatures(FinancialAccountFeatures features)

Encodes whether a FinancialAccount has access to a particular Feature, with a status enum and associated status_details. Stripe or the platform can control Features via the requested field.

setFinancialAddresses

public void setFinancialAddresses(List<FinancialAccount.FinancialAddress> financialAddresses)

The set of credentials that resolve to a FinancialAccount.

setId

public void setId(String id)

Unique identifier for the object.

setIsDefault

public void setIsDefault(Boolean isDefault)

setLivemode

public void setLivemode(Boolean livemode)

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

setMetadata

public void setMetadata(Map<String,String> metadata)

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

setNickname

public void setNickname(String nickname)

The nickname for the FinancialAccount.

setObject

public void setObject(String object)

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

Equal to treasury.financial_account.

setPendingFeatures

public void setPendingFeatures(List<String> pendingFeatures)

The array of paths to pending Features in the Features hash.

setPlatformRestrictions

public void setPlatformRestrictions(FinancialAccount.PlatformRestrictions platformRestrictions)

The set of functionalities that the platform can restrict on the FinancialAccount.

setRestrictedFeatures

public void setRestrictedFeatures(List<String> restrictedFeatures)

The array of paths to restricted Features in the Features hash.

setStatus

public void setStatus(String status)

Status of this FinancialAccount.

One of closed, or open.

setStatusDetails

public void setStatusDetails(FinancialAccount.StatusDetails statusDetails)

setSupportedCurrencies

public void setSupportedCurrencies(List<String> supportedCurrencies)

The currencies the FinancialAccount can hold a balance in. Three-letter ISO currency code, in lowercase.

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

getId

public String getId()

Unique identifier for the object.

Specified by:

getId in interface HasId

getMetadata

public Map<String,String> getMetadata()

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

Specified by:

getMetadata in interface MetadataStore<FinancialAccount>