Usage Info

This method returns all stored information about a LocationBankAccount entity. Sensitive information like bank_account_number in BankAccount inside LocationBankAccount are masked by default and revealed only when specifically requested. Use this method when displaying location bank account, populating forms with existing data, or retrieving specific attributes for compliance verification.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
location_bank_account_id	string	Yes	The identifier for the LocationBankAccount to get details about.
show_sensitive_data	boolean	No	A boolean value that if true, indicates that sensitive data should shown. If the parameter is not provided, the value defaults to false and the sensitive data will be masked. The sensitive data for the LocationBankAccount is `bank_account_number`in bank_account field inside `bank_account` in the details.
verbose	boolean	No	A boolean value that when `true` includes the sub entities of the location bank account in the response. The sub entities for LocationBankAccount are: BankAccount.

Example

{
  "location_bank_account_id": "lba_4PYsekjAX8VMuAOfmW81C7",
  "show_sensitive_data": true,
  "verbose": true
}

Response

Data

Parameter	Type	Description
location_bank_account	object	The location bank account parameters are defined in the tables below.

LocationBankAccount Parameters

Parameter	Type	Description
location_bank_account_id	string	The ID of the Location Bank Account
bank_account_id	string	The Bank Account that is part of location.
bank_account_purposes	array	The list of purposes the bank account servers for the location. Must be one or more of the LOCATION_BANK_ACOUNT_PURPOSES.
bank_account	objects	The bank account object parameters are defined in the table below. Requires verbose to be `true` to be displayed.
created_at	string	The date-time when the LocationBankAccount was created. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).
updated_at	string	The date-time when the LocationBankAccount was last updated. If there has been no update, the value will be the same as the created_at value. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).

Bank Account Parameters

Parameter	Type	Description
bank_account_id	string	The ID of the Bank Account.
bank_account_ownership_type	string	The type of ownership of the bank account. Must be one of the BANK_ACCOUNT_OWNERSHIP_TYPES .
bank_account_type	string	The type of bank account. Must be one of the BANK_ACCOUNT_TYPES .
bank_routing_number	string	The routing number that identifies the bank where the account is. This field must be 9 characters long and only contain digits [0-9].
bank_account_number	string	The account number for the bank account. This field must only contain digits [0-9].
bank_name	string	The name of the bank. Note: Some workflows, such as the Business-Application-type workflow, will override this value by using the bank_routing_number to find the publicly available bank name.
created_at	string	The date-time when the Bank Account was created. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).
updated_at	string	The date-time when the Bank Account was last updated. If there has been no update, the value will be the same as the created_at value. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_4bMcsHNHiFUpZJqgWplmD",
    "version": "2025-03-24"
  },
  "data": {
    "location_bank_account": {
      "location_bank_account_id": "lba_31cIZ7tXEm29kMcpbi9Ifn",
      "bank_account_id": "ba_4D7RLVenGMNFhocD4IcUNM",
      "bank_account_purposes": [
        "FEES",
        "SETTLEMENT"
      ],
      "created_at": "2025-11-17T09:13:16.248Z",
      "updated_at": "2025-11-17T09:13:16.248Z"
    }
  }
}

Example with Verbose

{
  "meta": {
    "status": "SUCCESS",
    "version": "2025-03-24",
    "trace_id": "trc_CoFlm5EO82uLCce6nkl3p"
  },
  "data": {
    "location_bank_account": {
      "location_bank_account_id": "lba_31cIZ7tXEm29kMcpbi9Ifn",
      "bank_account_id": "ba_4D7RLVenGMNFhocD4IcUNM",
      "bank_account_purposes": [
        "FEES",
        "SETTLEMENT"
      ],
      "created_at": "2025-11-17T09:13:16.248Z",
      "updated_at": "2025-11-17T09:13:16.248Z",
      "bank_account": {
        "bank_account_id": "ba_4D7RLVenGMNFhocD4IcUNM",
        "bank_account_ownership_type": "BUSINESS",
        "bank_account_type": "SAVINGS",
        "bank_routing_number": "021000021",
        "bank_account_number": "*******321",
        "bank_name": "SC International",
        "created_at": "2025-11-17T08:48:33.505Z",
        "updated_at": "2025-11-17T08:48:33.505Z"
      }
    }
  }
}

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.