Usage Info

This method terminates the relationship between a BankAccount and a Location entity. Use this when financial relationships change, such as when accounts are closed or reassigned to different purposes. This operation affects only the relationship, not the underlying BankAccount entity, which remains in the Subject Record.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
location_bank_account_id	string	Yes	The ID of the LocationBankAccount Entity.

Example

{
  "location_bank_account_id": "lba_79HaMs4zgYfilF3xQuJy3J"
}

Response

Data

An empty data object is returned when the completion is successful.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6zNzQZHSf26V83BO3uW6dS",
    "version": "2025-03-24"
  },
  "data": {}
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided. Invalid values provided.
ENTITY_NOT_FOUND	400	The `location_bank_account_id` provided does not exist.
ACCOUNT_CONFIGURATION_VIOLATION	400	Account configuration rule violations are described below.

ACCOUNT_CONFIGURATION_VIOLATION

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.