Update an existing bankaccount connected to an estate agent. This will fully overwrite the bankaccount with the data from the request.
Update a Bank Account for an EstateAgent
Updates the preferred status of an existing bank account linked to an estate agent.
This endpoint can only change isPreferredBankAccount from false to true; when that happens, the estate agent's current preferred bank account is automatically set to false, since exactly one bank account per estate agent can be preferred at any time. It is not possible to use this endpoint to set an account from preferred to not preferred. Neither bankAccountNumber nor bic can be changed through this endpoint.
The estate agent is located via reference or externalIdentifier, at least one of which must be supplied. The bank account itself is identified by bankAccountNumber, which must match an account already registered for the estate agent.
This endpoint only changes the preferred status of the bank account, from not preferred to preferred. It cannot change the account number or BIC, and it cannot set a preferred account back to not preferred, since an estate agent must always have exactly one preferred bank account whenever one or more accounts exist.
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 estate agent whose bank account should be updated. |
externalIdentifier | string | Required (at least one of reference or externalIdentifier must be given) | The external API identifier of the estate agent whose bank account should be updated. |
bankAccountNumber | string, max 34 | Required | The bank account number identifying which existing account to update. Must match an account already registered for the estate agent. This endpoint cannot rename or reassign the account number, and cannot change the account's bic. |
isPreferredBankAccount | boolean | Optional | Set to true to make this account the estate agent's preferred bank account, which automatically un-sets the previously preferred account. If this account is already preferred, sending true again has no effect and simply returns 200 OK with isPreferredBankAccount unchanged (still true). Setting this to false has no effect on the data, whether the account is currently preferred or not: the request still returns 200 OK, but the preferred status is not changed. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
bankAccountNumber | string, max 34 | Required | The bank account number of the updated account. |
isPreferredBankAccount | boolean | Optional | Indicates whether this account is the estate agent's preferred bank account after the request. Always true, since this endpoint can never leave an existing preferred account or a targeted account with false as the result. |
The internal identifier of the model (i.e. Reference, Code, Name, depends on model).
The external API identifier of the model.
The bank account was updated
The bank account data has validation issues