com.squareup.square.models

Class BankAccount

java.lang.Object

com.squareup.square.models.BankAccount

public class BankAccount
extends Object

This is a model class for BankAccount type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BankAccount.Builder Class to build instances of BankAccount.

Constructor Summary

Constructors

Constructor and Description

BankAccount(String id, String accountNumberSuffix, String country, String currency, String accountType, String holderName, String primaryBankIdentificationNumber, String status, boolean creditable, boolean debitable, String secondaryBankIdentificationNumber, String debitMandateReferenceId, String referenceId, String locationId, String fingerprint, Integer version, String bankName) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAccountNumberSuffix() Getter for AccountNumberSuffix.
String	getAccountType() Getter for AccountType.
String	getBankName() Getter for BankName.
String	getCountry() Getter for Country.
boolean	getCreditable() Getter for Creditable.
String	getCurrency() Getter for Currency.
boolean	getDebitable() Getter for Debitable.
String	getDebitMandateReferenceId() Getter for DebitMandateReferenceId.
String	getFingerprint() Getter for Fingerprint.
String	getHolderName() Getter for HolderName.
String	getId() Getter for Id.
String	getLocationId() Getter for LocationId.
String	getPrimaryBankIdentificationNumber() Getter for PrimaryBankIdentificationNumber.
String	getReferenceId() Getter for ReferenceId.
String	getSecondaryBankIdentificationNumber() Getter for SecondaryBankIdentificationNumber.
String	getStatus() Getter for Status.
Integer	getVersion() Getter for Version.
int	hashCode()
BankAccount.Builder	toBuilder() Builds a new BankAccount.Builder object.
String	toString() Converts this BankAccount into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

BankAccount

public BankAccount(String id,
                   String accountNumberSuffix,
                   String country,
                   String currency,
                   String accountType,
                   String holderName,
                   String primaryBankIdentificationNumber,
                   String status,
                   boolean creditable,
                   boolean debitable,
                   String secondaryBankIdentificationNumber,
                   String debitMandateReferenceId,
                   String referenceId,
                   String locationId,
                   String fingerprint,
                   Integer version,
                   String bankName)

Initialization constructor.

Parameters:

id - String value for id.

accountNumberSuffix - String value for accountNumberSuffix.

country - String value for country.

currency - String value for currency.

accountType - String value for accountType.

holderName - String value for holderName.

primaryBankIdentificationNumber - String value for primaryBankIdentificationNumber.

status - String value for status.

creditable - boolean value for creditable.

debitable - boolean value for debitable.

secondaryBankIdentificationNumber - String value for secondaryBankIdentificationNumber.

debitMandateReferenceId - String value for debitMandateReferenceId.

referenceId - String value for referenceId.

locationId - String value for locationId.

fingerprint - String value for fingerprint.

version - Integer value for version.

bankName - String value for bankName.

Method Detail

getId

public String getId()

Getter for Id. The unique, Square-issued identifier for the bank account.

Returns:

Returns the String

getAccountNumberSuffix

public String getAccountNumberSuffix()

Getter for AccountNumberSuffix. The last few digits of the account number.

Returns:

Returns the String

getCountry

public String getCountry()

Getter for Country. Indicates the country associated with another entity, such as a business. Values are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).

Returns:

Returns the String

getCurrency

public String getCurrency()

Getter for Currency. Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://wikipedia.org/wiki/ISO_4217).

Returns:

Returns the String

getAccountType

public String getAccountType()

Getter for AccountType. Indicates the financial purpose of the bank account.

Returns:

Returns the String

getHolderName

public String getHolderName()

Getter for HolderName. Name of the account holder. This name must match the name on the targeted bank account record.

Returns:

Returns the String

getPrimaryBankIdentificationNumber

public String getPrimaryBankIdentificationNumber()

Getter for PrimaryBankIdentificationNumber. Primary identifier for the bank. For more information, see [Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api).

Returns:

Returns the String

getSecondaryBankIdentificationNumber

public String getSecondaryBankIdentificationNumber()

Getter for SecondaryBankIdentificationNumber. Secondary identifier for the bank. For more information, see [Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api).

Returns:

Returns the String

getDebitMandateReferenceId

public String getDebitMandateReferenceId()

Getter for DebitMandateReferenceId. Reference identifier that will be displayed to UK bank account owners when collecting direct debit authorization. Only required for UK bank accounts.

Returns:

Returns the String

getReferenceId

public String getReferenceId()

Getter for ReferenceId. Client-provided identifier for linking the banking account to an entity in a third-party system (for example, a bank account number or a user identifier).

Returns:

Returns the String

getLocationId

public String getLocationId()

Getter for LocationId. The location to which the bank account belongs.

Returns:

Returns the String

getStatus

public String getStatus()

Getter for Status. Indicates the current verification status of a `BankAccount` object.

Returns:

Returns the String

getCreditable

public boolean getCreditable()

Getter for Creditable. Indicates whether it is possible for Square to send money to this bank account.

Returns:

Returns the boolean

getDebitable

public boolean getDebitable()

Getter for Debitable. Indicates whether it is possible for Square to take money from this bank account.

Returns:

Returns the boolean

getFingerprint

public String getFingerprint()

Getter for Fingerprint. A Square-assigned, unique identifier for the bank account based on the account information. The account fingerprint can be used to compare account entries and determine if the they represent the same real-world bank account.

Returns:

Returns the String

getVersion

public Integer getVersion()

Getter for Version. The current version of the `BankAccount`.

Returns:

Returns the Integer

getBankName

public String getBankName()

Getter for BankName. Read only. Name of actual financial institution. For example "Bank of America".

Returns:

Returns the String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this BankAccount into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public BankAccount.Builder toBuilder()

Builds a new BankAccount.Builder object. Creates the instance with the state of the current model.

Returns:

a new BankAccount.Builder object