> ## Documentation Index
> Fetch the complete documentation index at: https://www.bloxs.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Add a bankaccount to an estate agent
> Add a new bank account to an estate agent.
## OpenAPI
````json POST /api/v1/relations/estateAgents/bankaccounts
{
"openapi": "3.0.4",
"info": {
"title": "Relations V1",
"description": "# Relation API Documentation\n\nWelcome to the Relationship Management API documentation. This API allows you to perform CRUD operations on various relationship types, including Owners, Persons, Suppliers, Estate Agents, and Organisations. \n\n## Authentication \n\nTo access the API, include your API key in the headers. Refer to our authentication documentation for details on obtaining and using your API key. \n\n## CRUD Operations \n\nThe API supports CRUD operations for the following relationship types: \n\n- **Owners**\n- **Persons**\n- **Suppliers**\n- **Estate Agents**\n- **Organisations**\n\nFor each relationship type, you can: \n\n- **GET**: Retrieve a list or apply filters.\n- **POST**: Add a new entry.\n- **PUT**: Update existing details.\n- **PATCH**: Apply partial updates.\n- **DELETE**: Remove an entry.\n\nThank you for choosing our Relation API. If you have any questions or need assistance, please contact our support team. \n",
"version": "v1"
},
"security": [
{}
],
"tags": [
{
"name": "Common"
},
{
"name": "CommunicationFormAPI"
},
{
"name": "EstateAgentAPI"
},
{
"name": "Metadata"
},
{
"name": "OrganisationAPI"
},
{
"name": "OwnerAPI"
},
{
"name": "PersonAPI"
},
{
"name": "RelationTypeAPI"
},
{
"name": "SupplierAPI"
},
{
"name": "SupplierTypeAPI"
}
],
"paths": {
"/api/v1/relations/estateAgents/bankaccounts": {
"post": {
"tags": [
"Relations"
],
"summary": "Add a bankaccount to an estate agent",
"description": "Add a new bank account to an estate agent.",
"operationId": "InsertEstateAgentBankAccount",
"parameters": [
{
"name": "reference",
"in": "query",
"description": "The internal identifier of the model (i.e. Reference, Code, Name, depends on model).",
"schema": {
"type": "string"
}
},
{
"name": "externalIdentifier",
"in": "query",
"description": "The external API identifier of the model.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BankAccount"
}
}
}
},
"responses": {
"200": {
"description": "The bank account was added to the estate agent",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BankAccount"
}
}
}
},
"400": {
"description": "The bank account data has validation issues",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorMessageModel"
}
}
}
}
},
"x-d360-narrative-url": "Add a Bank Account to an EstateAgent
Adds a new bank account to an existing estate agent's record.
A developer calls this endpoint to register a bank account for an estate agent, for example to enable outgoing payments. The estate agent to add the bank account to is located via reference or externalIdentifier, at least one of which must be supplied.
An estate agent can have at most one preferred bank account at any time: if the new account is added with isPreferredBankAccount set to true, the estate agent's current preferred bank account is automatically set to false. If the estate agent currently has no bank accounts at all, the new account is forced to be preferred, regardless of the value sent.
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 to add the bank account to. |
externalIdentifier | string | Required (at least one of reference or externalIdentifier must be given) | The external API identifier of the estate agent to add the bank account to. |
bankAccountNumber | string, max 34 | Required | The bank account number to add, typically an IBAN. The 34-character maximum accommodates the longest IBAN formats. Must not already exist for this estate agent; adding a duplicate is rejected with an error. |
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 new account should be set as the estate agent's preferred bank account. If set to true, the estate agent's current preferred bank account (if any) is automatically set to false. If this is the estate agent's first bank account, it is always forced to preferred regardless of the value sent. |
Response Fields
Field | Type | Required | Description |
|---|
bankAccountNumber | string, max 34 | Required | The bank account number that was added. |
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. |
isPreferredBankAccount | boolean | Optional | Indicates whether this account is now the estate agent's preferred bank account. Always true if this was the estate agent's first bank account. |