## List linked bank accounts

`embed.linked_bank_accounts.list(**kwargs) -> PageNumberSchema<{ id, account_id, bank_account, 8 more}>`

**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: String`

  The unique identifier of the related account.

- `level: :account | :platform`

  - `:account`

  - `:platform`

- `page_number: Integer`

  Results page number. Starts at page 1.

- `page_size: Integer`

  Page size. Max value: 1000

- `purpose: :charges | :payouts | :billing`

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

  - `:charges`

  - `:payouts`

  - `:billing`

- `sort_by: String`

  Sort By.

- `sort_order: :asc | :desc`

  Sort Order.

  - `:asc`

  - `:desc`

- `status: :created | :onboarding | :active | 3 more`

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

  - `:created`

  - `:onboarding`

  - `:active`

  - `:rejected`

  - `:inactive`

  - `:canceled`

- `correlation_id: String`

- `request_id: String`

### Returns

- `{ 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: { account_holder, account_mask, institution_name, routing_number}`

    - `account_holder: String`

    - `account_mask: String`

    - `institution_name: String`

    - `routing_number: String`

  - `created_at: Time`

    Timestamp of when the bank account object was created.

  - `purposes: Array[:charges | :payouts | :billing]`

    The purposes for the linked bank account.

    - `:charges`

    - `:payouts`

    - `:billing`

  - `status: :created | :onboarding | :active | 3 more`

    The current status of the linked bank account.

    - `:created`

    - `:onboarding`

    - `:active`

    - `:rejected`

    - `:inactive`

    - `:canceled`

  - `status_detail: { 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 | :in_review | :pending | 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: Time`

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

  - `description: String`

    Optional description for the bank account.

  - `metadata: Hash[Symbol, 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: String`

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

### Example

```ruby
require "straddle"

straddle = Straddle::Client.new(
  api_key: "My API Key",
  environment: "production" # defaults to "sandbox"
)

page = straddle.embed.linked_bank_accounts.list

puts(page)
```

#### 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"
}
```