Get all bank accounts for an organisation. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the organisation.
Get All Bank Accounts for an Organisation
Retrieves all bank accounts currently linked to a specific organisation.
A developer calls this endpoint to view the bank account details for an organisation, verify a specific account, or compare against existing records before adding, updating, or removing one.
The organisation is located via reference or externalIdentifier, at least one of which must be supplied.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string | Required (at least one of reference or externalIdentifier must be given) | The internal identifier (Reference/Code) of the organisation whose bank accounts should be retrieved. |
externalIdentifier | string | Required (at least one of reference or externalIdentifier must be given) | The external API identifier of the organisation whose bank accounts should be retrieved. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
bankAccountNumber | string, max 34 | Required | The bank account number, typically an IBAN. The 34-character maximum accommodates the longest IBAN formats. This is the only identifier per account; there is no separate account ID. |
bic | string, max 11 | Required | The Bank Identifier Code (BIC/SWIFT code) of the account's bank. |
isBankAccountNonIBAN | boolean | Optional | Indicates whether bankAccountNumber is a non-IBAN account number rather than a standard IBAN, relevant for accounts outside the SEPA area. |
isPreferredBankAccount | boolean | Optional | Indicates whether this is the organisation's preferred bank account, used as the default when multiple accounts are on file (for example for outgoing payments). An organisation can have no bank accounts, or one or more. If one or more accounts exist, exactly one of them will have this value set to true. |
The internal identifier of the model (i.e. Reference, Code, Name, depends on model).
The external API identifier of the model.
OK
The requested organisation was not found.