Skip to content
straddle API Docs
Get started
API Reference
Embed
Linked Bank Accounts

List linked bank accounts

embed.linked_bank_accounts.list(LinkedBankAccountListParams**kwargs) -> SyncPageNumberSchema[Data]
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.

ParametersExpand Collapse
account_id: Optional[str]

The unique identifier of the related account.

formatuuid
level: Optional[Literal["account", "platform"]]
One of the following:
"account"
"platform"
page_number: Optional[int]

Results page number. Starts at page 1.

formatint32
page_size: Optional[int]

Page size. Max value: 1000

formatint32
purpose: Optional[Literal["charges", "payouts", "billing"]]

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

One of the following:
"charges"
"payouts"
"billing"
sort_by: Optional[str]

Sort By.

sort_order: Optional[Literal["asc", "desc"]]

Sort Order.

One of the following:
"asc"
"desc"
status: Optional[Literal["created", "onboarding", "active", 3 more]]

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

One of the following:
"created"
"onboarding"
"active"
"rejected"
"inactive"
"canceled"
correlation_id: Optional[str]
request_id: Optional[str]
ReturnsExpand Collapse
Data
id: str

Unique identifier for the linked bank account.

formatuuid
account_id: Optional[str]

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

formatuuid
bank_account: DataBankAccount
account_holder: str
account_mask: str
institution_name: str
routing_number: str
created_at: datetime

Timestamp of when the bank account object was created.

formatdate-time
purposes: List[Literal["charges", "payouts", "billing"]]

The purposes for the linked bank account.

One of the following:
"charges"
"payouts"
"billing"
status: Literal["created", "onboarding", "active", 3 more]

The current status of the linked bank account.

One of the following:
"created"
"onboarding"
"active"
"rejected"
"inactive"
"canceled"
status_detail: DataStatusDetail
code: str

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

message: str

A human-readable message describing the current status.

reason: Literal["unverified", "in_review", "pending", 5 more]

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

One of the following:
"unverified"
"in_review"
"pending"
"stuck"
"verified"
"failed_verification"
"disabled"
"new"
source: Literal["watchtower"]

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

updated_at: datetime

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

formatdate-time
description: Optional[str]

Optional description for the bank account.

metadata: Optional[Dict[str, Optional[str]]]

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[str]

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

formatuuid

List linked bank accounts

import os
from straddle import Straddle

client = Straddle(
    api_key=os.environ.get("STRADDLE_API_KEY"),  # This is the default and can be omitted
)
page = client.embed.linked_bank_accounts.list()
page = page.data[0]
print(page.id)
{
  "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"
}
Returns Examples
{
  "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"
}