Usage Info

This method establishes a relationship between a BankAccount and a Location entity, specifying the purposes the account serves for the business (such as fees, settlements). Use this method when adding new financial accounts to a location profile.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
location_id	string	Yes	The Business to add this Owner to.
location_bank_account	object	No	The `location_bank_account` parameters are defined in the table below.

LocationBankAccount Parameters

Parameter	Type	Required	Description
bank_account_id	string	Yes	The Bank Account to be added to the Business.
bank_account_purposes	array of string	YES	The purpose(s) of the bank account in the business. Must be one or more of the LOCATION_BANK_ACCOUNT_PURPOSES.

Example

{
  "location_id": "l_7eobHllxknr7mfqbjnX2Pp",
  "location_bank_account": {
    "bank_account_id": "ba_6zNzQZHSf26V83BO3uW6dS",
    "bank_account_purposes": [
      "FEES",
      "SETTLEMENT"
    ]
  }
}

Response

Data

Parameter	Type	Description
location_bank_account	object	The `location_bank_account` parameters are defined in the table below.

Business Bank Account Parameters

Parameter	Type	Description
location_bank_account_id	string	The identifier for the LocationBankAccount just created.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_3S6w6VfAnOG0QtdrdMCmaz",
    "version": "2025-03-24"
  },
  "data": {
    "location_bank_account": {
      "location_bank_account_id": "lba_79HaMs4zgYfilF3xQuJy3J"
    }
  }
}

Errors

Error Code	HTTP Code	Possible Cause
ACCOUNT_CONFIGURATION_VIOLATION	400	Account configuration rule violations are described below.
BAD_REQUEST	400	Required parameters not provided. Invalid values provided. Enum value provided does not correspond to an available type.
ENTITY_NOT_FOUND	400	The `location_id` or `bank_account_id` provided does not exist.
SYSTEM_RULE_VIOLATION	400	System rule violations are described below.

Account Configuration Violations

When a ACCOUNT_CONFIGURATION_VIOLATION error occurs, the response will include additional entity_type and sub_code fields to provide more specific information:

Entity Type	Sub-code	Description
Location	FEATURE_NOT_ENABLED	Location feature is not enabled for this account.

System Rule Violations

When a SYSTEM_RULE_VIOLATION error occurs, the response will include additional entity_type and sub_code fields to provide more specific information:

Entity Type	Sub-code	Description
Location	DUPLICATE_BANK_ACCOUNT_ASSOCIATION	The Bank Account is already associated with this Location entity.
Subject Record	CROSS_SUBJECT_RECORD_REFERENCE	The referenced entities must belong to the same subject record. Associations cannot be created between entities that exist in different subject records. The Bank Account must belong to the same Subject Record as the Location specified in the location_id parameter.
Location	MAX_BANK_ACCOUNT_LIMIT	The maximum number of bank accounts allowed per Location has been reached.
Location	DUPLICATE_BANK_ACCOUNT_PURPOSE_ASSOCIATION	The purpose provided for the `bank_account` is already associated with this location.