## List linked bank accounts

`$ straddle embed:linked-bank-accounts list`

**get** `/v1/linked_bank_accounts`

Returns a list of bank accounts associated with a specific Straddle account. The linked bank accounts are returned sorted by creation date, with the most recently created appearing first. This endpoint supports pagination to handle accounts with multiple linked bank accounts.

### Parameters

- `--account-id: optional string`

  Query param: The unique identifier of the related account.

- `--level: optional "account" or "platform"`

  Query param

- `--page-number: optional number`

  Query param: Results page number. Starts at page 1.

- `--page-size: optional number`

  Query param: Page size. Max value: 1000

- `--purpose: optional "charges" or "payouts" or "billing"`

  Query param: The purpose of the linked bank accounts to return. Possible values: 'charges', 'payouts', 'billing'.

- `--sort-by: optional string`

  Query param: Sort By.

- `--sort-order: optional "asc" or "desc"`

  Query param: Sort Order.

- `--status: optional "created" or "onboarding" or "active" or 3 more`

  Query param: The status of the linked bank accounts to return. Possible values: 'created', 'onboarding', 'active', 'inactive', 'rejected'.

- `--correlation-id: optional string`

  Header param: Optional client generated identifier to trace and debug a series of requests.

- `--request-id: optional string`

  Header param: Optional client generated identifier to trace and debug a request.

### Returns

- `linkedBankAccountPagedV1: object { data, meta, response_type }`

  - `data: array of object { id, account_id, bank_account, 8 more }`

    - `id: string`

      Unique identifier for the linked bank account.

    - `account_id: string`

      The unique identifier of the Straddle account related to this bank account.

    - `bank_account: object { account_holder, account_mask, institution_name, routing_number }`

      - `account_holder: string`

      - `account_mask: string`

      - `institution_name: string`

      - `routing_number: string`

    - `created_at: string`

      Timestamp of when the bank account object was created.

    - `purposes: array of "charges" or "payouts" or "billing"`

      The purposes for the linked bank account.

      - `"charges"`

      - `"payouts"`

      - `"billing"`

    - `status: "created" or "onboarding" or "active" or 3 more`

      The current status of the linked bank account.

      - `"created"`

      - `"onboarding"`

      - `"active"`

      - `"rejected"`

      - `"inactive"`

      - `"canceled"`

    - `status_detail: object { code, message, reason, source }`

      - `code: string`

        A machine-readable code for the specific status, useful for programmatic handling.

      - `message: string`

        A human-readable message describing the current status.

      - `reason: "unverified" or "in_review" or "pending" or 5 more`

        A machine-readable identifier for the specific status, useful for programmatic handling.

        - `"unverified"`

        - `"in_review"`

        - `"pending"`

        - `"stuck"`

        - `"verified"`

        - `"failed_verification"`

        - `"disabled"`

        - `"new"`

      - `source: "watchtower"`

        Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates.

        - `"watchtower"`

    - `updated_at: string`

      Timestamp of the most recent update to the linked bank account.

    - `description: optional string`

      Optional description for the bank account.

    - `metadata: optional map[string]`

      Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the linked bank account in a structured format.

    - `platform_id: optional string`

      The unique identifier of the Straddle Platform relatd to this bank account.

  - `meta: object { api_request_id, api_request_timestamp, max_page_size, 6 more }`

    Metadata about the API request, including an identifier, timestamp, and pagination details.

    - `api_request_id: string`

      Unique identifier for this API request, useful for troubleshooting.

    - `api_request_timestamp: string`

      Timestamp for this API request, useful for troubleshooting.

    - `max_page_size: number`

      Maximum allowed page size for this endpoint.

    - `page_number: number`

      Page number for paginated results.

    - `page_size: number`

      Number of items per page in this response.

    - `sort_by: string`

      The field that the results were sorted by.

    - `sort_order: "asc" or "desc"`

      - `"asc"`

      - `"desc"`

    - `total_items: number`

      Total number of items returned in this response.

    - `total_pages: number`

      The number of pages available.

  - `response_type: "object" or "array" or "error" or "none"`

    Indicates the structure of the returned content.

    - "object" means the `data` field contains a single JSON object.
    - "array" means the `data` field contains an array of objects.
    - "error" means the `data` field contains an error object with details of the issue.
    - "none" means no data is returned.

    - `"object"`

    - `"array"`

    - `"error"`

    - `"none"`

### Example

```cli
straddle embed:linked-bank-accounts list \
  --api-key 'My API Key'
```

#### Response

```json
{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "bank_account": {
        "account_holder": "account_holder",
        "account_mask": "account_mask",
        "institution_name": "institution_name",
        "routing_number": "routing_number"
      },
      "created_at": "2019-12-27T18:11:19.117Z",
      "purposes": [
        "charges"
      ],
      "status": "created",
      "status_detail": {
        "code": "code",
        "message": "message",
        "reason": "unverified",
        "source": "watchtower"
      },
      "updated_at": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "metadata": {
        "foo": "string"
      },
      "platform_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
    }
  ],
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z",
    "max_page_size": 0,
    "page_number": 0,
    "page_size": 0,
    "sort_by": "sort_by",
    "sort_order": "asc",
    "total_items": 0,
    "total_pages": 0
  },
  "response_type": "object"
}
```