public class CreditorBankAccount
extends java.lang.Object
Represents a creditor bank account resource returned from the API.
Creditor Bank Accounts hold the bank details of a creditor. These are the bank accounts which your payouts will be sent to.
Note that creditor bank accounts must be unique, and so you will encounter a bank_account_exists error if you try to create a duplicate bank account. You may wish to handle this by updating the existing record instead, the ID of which will be provided as links[creditor_bank_account] in the error response.
Restricted: This API is not available for partner integrations.
| Modifier and Type | Class and Description |
|---|---|
static class |
CreditorBankAccount.Links |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getAccountHolderName()
Name of the account holder, as known by the bank.
|
java.lang.String |
getAccountNumberEnding()
Last two digits of account number.
|
java.lang.String |
getBankName()
Name of bank, taken from the bank details.
|
java.lang.String |
getCountryCode()
ISO 3166-1 alpha-2 code.
|
java.lang.String |
getCreatedAt()
Fixed timestamp, recording when this resource was created.
|
java.lang.String |
getCurrency()
ISO 4217 currency code, defaults to national currency of
country_code. |
java.lang.Boolean |
getEnabled()
Boolean value showing whether the bank account is enabled or disabled.
|
java.lang.String |
getId()
Unique identifier, beginning with “BA”.
|
CreditorBankAccount.Links |
getLinks() |
java.util.Map<java.lang.String,java.lang.String> |
getMetadata()
Key-value store of custom data.
|
public java.lang.String getAccountHolderName()
Name of the account holder, as known by the bank. Usually this is the same as the name stored with the linked creditor. This field will be transliterated, upcased and truncated to 18 characters.
public java.lang.String getAccountNumberEnding()
Last two digits of account number.
public java.lang.String getBankName()
Name of bank, taken from the bank details.
public java.lang.String getCountryCode()
ISO 3166-1 alpha-2 code. Defaults to the country code of the iban if supplied, otherwise is required.
public java.lang.String getCreatedAt()
Fixed timestamp, recording when this resource was created.
public java.lang.String getCurrency()
ISO 4217 currency code, defaults to national currency of country_code.
public java.lang.Boolean getEnabled()
Boolean value showing whether the bank account is enabled or disabled.
public java.lang.String getId()
Unique identifier, beginning with “BA”.
public CreditorBankAccount.Links getLinks()
public java.util.Map<java.lang.String,java.lang.String> getMetadata()
Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50 characters and values up to 500 characters.