CustomerBankAccount Properties |
The GoCardlessCustomerBankAccount type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | account_holder_name |
Name of the account holder, as known by the bank. Usually this matches the name of the linked customer. This field will be transliterated, upcased and truncated to 18 characters.
|
| account_number |
For the CustomerBankAccount create API.
Bank account number - see local details for more information. Alternatively you can provide an iban.
|
| account_number_ending |
Last two digits of account number.
|
| bank_code |
For the CustomerBankAccount create API.
Bank code - see local details for more information. Alternatively you can provide an iban.
|
| bank_name |
Name of bank, taken from the bank details.
|
| branch_code |
Branch code - see local details for more information. Alternatively you can provide an iban.
|
| country_code |
ISO 3166-1 alpha-2 code. Defaults to the country code of the iban if supplied, otherwise is required.
|
| created_at |
Fixed timestamp, recording when this resource was created.
|
| currency |
ISO 4217 currency code, defaults to national currency of country_code.
|
| enabled |
Boolean value showing whether the bank account is enabled or disabled.
|
| iban |
International Bank Account Number. Alternatively you can provide local details. IBANs are not accepted for Swedish bank accounts denominated in SEK - you must supply local details.
|
| id |
Unique identifier, beginning with “BA”.
|
| IDEMPOTENCYKEY |
Not part of actual object sent to GoCardless. Used in HTTP header to prevent duplicating a successful request.
|
| links |
IDs of things that could be related:
customer,
customer_bank_account_token can be linked during CustomerBankAccount creation (through API) but we do NOT use it.
|
| metadata |
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.
|
See Also