com.stripe.model

Class BankAccount

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.BankAccount

All Implemented Interfaces:

ExternalAccount, HasId, MetadataStore<BankAccount>, PaymentSource

public class BankAccount
extends ApiResource
implements ExternalAccount, PaymentSource, MetadataStore<BankAccount>

Nested Class Summary

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

ApiResource.RequestMethod, ApiResource.RequestType

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 and Description
BankAccount()

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(java.lang.Object other)
BankAccount	delete() Delete a specified external account for a given account.
BankAccount	delete(java.util.Map<java.lang.String,java.lang.Object> params) Delete a specified external account for a given account.
BankAccount	delete(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Delete a specified external account for a given account.
BankAccount	delete(RequestOptions options) Delete a specified external account for a given account.
boolean	equals(java.lang.Object o)
java.lang.String	getAccount() Get id of expandable `account` object.
java.lang.String	getAccountHolderName() The name of the person or business that owns the bank account.
java.lang.String	getAccountHolderType() The type of entity that holds the account.
Account	getAccountObject() Get expanded `account`.
java.lang.String	getBankName() Name of the bank associated with the routing number (e.g., `WELLS FARGO`).
java.lang.String	getCountry() Two-letter ISO code representing the country the bank account is located in.
java.lang.String	getCurrency() Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.
java.lang.String	getCustomer() Get id of expandable `customer` object.
Customer	getCustomerObject() Get expanded `customer`.
java.lang.Boolean	getDefaultForCurrency() Whether this bank account is the default external account for its currency.
java.lang.Boolean	getDeleted() Always true for a deleted object.
java.lang.String	getFingerprint() Uniquely identifies this particular bank account.
java.lang.String	getId() Unique identifier for the object.
java.lang.String	getLast4()
java.util.Map<java.lang.String,java.lang.String>	getMetadata() Set of key-value pairs that you can attach to an object.
java.lang.String	getObject() String representing the object's type.
java.lang.String	getRoutingNumber() The routing transit number for the bank account.
java.lang.String	getStatus() For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`.
int	hashCode()
void	setAccount(java.lang.String id)
void	setAccountHolderName(java.lang.String accountHolderName) The name of the person or business that owns the bank account.
void	setAccountHolderType(java.lang.String accountHolderType) The type of entity that holds the account.
void	setAccountObject(Account expandableObject)
void	setBankName(java.lang.String bankName) Name of the bank associated with the routing number (e.g., `WELLS FARGO`).
void	setCountry(java.lang.String country) Two-letter ISO code representing the country the bank account is located in.
void	setCurrency(java.lang.String currency) Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.
void	setCustomer(java.lang.String id)
void	setCustomerObject(Customer expandableObject)
void	setDefaultForCurrency(java.lang.Boolean defaultForCurrency) Whether this bank account is the default external account for its currency.
void	setDeleted(java.lang.Boolean deleted) Always true for a deleted object.
void	setFingerprint(java.lang.String fingerprint) Uniquely identifies this particular bank account.
void	setId(java.lang.String id) Unique identifier for the object.
void	setLast4(java.lang.String last4)
void	setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata) Set of key-value pairs that you can attach to an object.
void	setObject(java.lang.String object) String representing the object's type.
void	setRoutingNumber(java.lang.String routingNumber) The routing transit number for the bank account.
void	setStatus(java.lang.String status) For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`.
BankAccount	update(BankAccountUpdateOnAccountParams params) Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency.
BankAccount	update(BankAccountUpdateOnAccountParams params, RequestOptions options) Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency.
BankAccount	update(BankAccountUpdateOnCustomerParams params) Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency.
BankAccount	update(BankAccountUpdateOnCustomerParams params, RequestOptions options) Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency.
BankAccount	update(java.util.Map<java.lang.String,java.lang.Object> params) Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency.
BankAccount	update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency.
BankAccount	verify() Verify a specified bank account for a given customer.
BankAccount	verify(BankAccountVerifyParams params) Verify a specified bank account for a given customer.
BankAccount	verify(BankAccountVerifyParams params, RequestOptions options) Verify a specified bank account for a given customer.
BankAccount	verify(java.util.Map<java.lang.String,java.lang.Object> params) Verify a specified bank account for a given customer.
BankAccount	verify(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Verify a specified bank account for a given customer.
BankAccount	verify(RequestOptions options) Verify a specified bank account for a given customer.

Methods inherited from class com.stripe.net.ApiResource

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

Methods inherited from class com.stripe.model.StripeObject

equals, getLastResponse, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BankAccount

public BankAccount()

Method Detail

getAccount

public java.lang.String getAccount()

Get id of expandable `account` object.

setAccount

public void setAccount(java.lang.String id)

getAccountObject

public Account getAccountObject()

Get expanded `account`.

setAccountObject

public void setAccountObject(Account expandableObject)

getCustomer

public java.lang.String getCustomer()

Get id of expandable `customer` object.

setCustomer

public void setCustomer(java.lang.String id)

getCustomerObject

public Customer getCustomerObject()

Get expanded `customer`.

setCustomerObject

public void setCustomerObject(Customer expandableObject)

update

public BankAccount update(java.util.Map<java.lang.String,java.lang.Object> params)
                   throws StripeException

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

Updates the account_holder_name, account_holder_type, and metadata of a bank account belonging to a customer. Other bank account details are not editable, by design.

Specified by:

update in interface ExternalAccount

Specified by:

update in interface MetadataStore<BankAccount>

Throws:

StripeException

update

public BankAccount update(java.util.Map<java.lang.String,java.lang.Object> params,
                          RequestOptions options)
                   throws StripeException

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

Updates the account_holder_name, account_holder_type, and metadata of a bank account belonging to a customer. Other bank account details are not editable, by design.

Specified by:

update in interface ExternalAccount

Specified by:

update in interface MetadataStore<BankAccount>

Throws:

StripeException

update

public BankAccount update(BankAccountUpdateOnAccountParams params)
                   throws StripeException

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

Updates the account_holder_name, account_holder_type, and metadata of a bank account belonging to a customer. Other bank account details are not editable, by design.

Throws:

StripeException

update

public BankAccount update(BankAccountUpdateOnAccountParams params,
                          RequestOptions options)
                   throws StripeException

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

Updates the account_holder_name, account_holder_type, and metadata of a bank account belonging to a customer. Other bank account details are not editable, by design.

Throws:

StripeException

update

public BankAccount update(BankAccountUpdateOnCustomerParams params)
                   throws StripeException

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

Updates the account_holder_name, account_holder_type, and metadata of a bank account belonging to a customer. Other bank account details are not editable, by design.

Throws:

StripeException

update

public BankAccount update(BankAccountUpdateOnCustomerParams params,
                          RequestOptions options)
                   throws StripeException

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

Updates the account_holder_name, account_holder_type, and metadata of a bank account belonging to a customer. Other bank account details are not editable, by design.

Throws:

StripeException

delete

public BankAccount delete()
                   throws StripeException

Delete a specified external account for a given account.

Delete a specified source for a given customer.

Specified by:

delete in interface ExternalAccount

Throws:

StripeException

delete

public BankAccount delete(RequestOptions options)
                   throws StripeException

Delete a specified external account for a given account.

Delete a specified source for a given customer.

Specified by:

delete in interface ExternalAccount

Throws:

StripeException

delete

public BankAccount delete(java.util.Map<java.lang.String,java.lang.Object> params)
                   throws StripeException

Delete a specified external account for a given account.

Delete a specified source for a given customer.

Specified by:

delete in interface ExternalAccount

Throws:

StripeException

delete

public BankAccount delete(java.util.Map<java.lang.String,java.lang.Object> params,
                          RequestOptions options)
                   throws StripeException

Delete a specified external account for a given account.

Delete a specified source for a given customer.

Specified by:

delete in interface ExternalAccount

Throws:

StripeException

verify

public BankAccount verify()
                   throws StripeException

Verify a specified bank account for a given customer.

Throws:

StripeException

verify

public BankAccount verify(RequestOptions options)
                   throws StripeException

Verify a specified bank account for a given customer.

Throws:

StripeException

verify

public BankAccount verify(java.util.Map<java.lang.String,java.lang.Object> params)
                   throws StripeException

Verify a specified bank account for a given customer.

Throws:

StripeException

verify

public BankAccount verify(java.util.Map<java.lang.String,java.lang.Object> params,
                          RequestOptions options)
                   throws StripeException

Verify a specified bank account for a given customer.

Throws:

StripeException

verify

public BankAccount verify(BankAccountVerifyParams params)
                   throws StripeException

Verify a specified bank account for a given customer.

Throws:

StripeException

verify

public BankAccount verify(BankAccountVerifyParams params,
                          RequestOptions options)
                   throws StripeException

Verify a specified bank account for a given customer.

Throws:

StripeException

getAccountHolderName

public java.lang.String getAccountHolderName()

The name of the person or business that owns the bank account.

getAccountHolderType

public java.lang.String getAccountHolderType()

The type of entity that holds the account. This can be either `individual` or `company`.

getBankName

public java.lang.String getBankName()

Name of the bank associated with the routing number (e.g., `WELLS FARGO`).

getCountry

public java.lang.String getCountry()

Two-letter ISO code representing the country the bank account is located in.

getCurrency

public java.lang.String getCurrency()

Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.

getDefaultForCurrency

public java.lang.Boolean getDefaultForCurrency()

Whether this bank account is the default external account for its currency.

getDeleted

public java.lang.Boolean getDeleted()

Always true for a deleted object.

getFingerprint

public java.lang.String getFingerprint()

Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

getLast4

public java.lang.String getLast4()

getObject

public java.lang.String getObject()

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

getRoutingNumber

public java.lang.String getRoutingNumber()

The routing transit number for the bank account.

getStatus

public java.lang.String getStatus()

For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated.

For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated.

setAccountHolderName

public void setAccountHolderName(java.lang.String accountHolderName)

The name of the person or business that owns the bank account.

setAccountHolderType

public void setAccountHolderType(java.lang.String accountHolderType)

The type of entity that holds the account. This can be either `individual` or `company`.

setBankName

public void setBankName(java.lang.String bankName)

Name of the bank associated with the routing number (e.g., `WELLS FARGO`).

setCountry

public void setCountry(java.lang.String country)

Two-letter ISO code representing the country the bank account is located in.

setCurrency

public void setCurrency(java.lang.String currency)

Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.

setDefaultForCurrency

public void setDefaultForCurrency(java.lang.Boolean defaultForCurrency)

Whether this bank account is the default external account for its currency.

setDeleted

public void setDeleted(java.lang.Boolean deleted)

Always true for a deleted object.

setFingerprint

public void setFingerprint(java.lang.String fingerprint)

Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

setId

public void setId(java.lang.String id)

Unique identifier for the object.

setLast4

public void setLast4(java.lang.String last4)

setMetadata

public void setMetadata(java.util.Map<java.lang.String,java.lang.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.

setObject

public void setObject(java.lang.String object)

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

setRoutingNumber

public void setRoutingNumber(java.lang.String routingNumber)

The routing transit number for the bank account.

setStatus

public void setStatus(java.lang.String status)

For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated.

For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated.

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

getId

public java.lang.String getId()

Unique identifier for the object.

Specified by:

getId in interface HasId

getMetadata

public java.util.Map<java.lang.String,java.lang.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<BankAccount>