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

List linked bank accounts

LinkedBankAccountPagedV1 Embed.LinkedBankAccounts.List(LinkedBankAccountListParams?parameters, CancellationTokencancellationToken = default)
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
LinkedBankAccountListParams parameters
string accountID

Query param: The unique identifier of the related account.

formatuuid
Level level

Query param

"account"Account
"platform"Platform
Int pageNumber

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

formatint32
Int pageSize

Query param: Page size. Max value: 1000

formatint32
Purpose purpose

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

"charges"Charges
"payouts"Payouts
"billing"Billing
string sortBy

Query param: Sort By.

SortOrder sortOrder

Query param: Sort Order.

"asc"Asc
"desc"Desc
Status status

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

"created"Created
"onboarding"Onboarding
"active"Active
"rejected"Rejected
"inactive"Inactive
"canceled"Canceled
string correlationID

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

string requestID

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

ReturnsExpand Collapse
class LinkedBankAccountPagedV1:
required IReadOnlyList<Data> Data
required string ID

Unique identifier for the linked bank account.

formatuuid
required string? AccountID

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

formatuuid
required BankAccount BankAccount
required string AccountHolder
required string AccountMask
required string InstitutionName
required string RoutingNumber
required DateTimeOffset CreatedAt

Timestamp of when the bank account object was created.

formatdate-time
required IReadOnlyList<Purpose> Purposes

The purposes for the linked bank account.

One of the following:
"charges"Charges
"payouts"Payouts
"billing"Billing
required Status Status

The current status of the linked bank account.

One of the following:
"created"Created
"onboarding"Onboarding
"active"Active
"rejected"Rejected
"inactive"Inactive
"canceled"Canceled
required StatusDetail StatusDetail
required string Code

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

required string Message

A human-readable message describing the current status.

required Reason Reason

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

One of the following:
"unverified"Unverified
"in_review"InReview
"pending"Pending
"stuck"Stuck
"verified"Verified
"failed_verification"FailedVerification
"disabled"Disabled
"new"New
required Source Source

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

required DateTimeOffset UpdatedAt

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

formatdate-time
string? Description

Optional description for the bank account.

IReadOnlyDictionary<string, string>? Metadata

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

string? PlatformID

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

formatuuid
required PagedResponseMetadata Meta

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

required string ApiRequestID

Unique identifier for this API request, useful for troubleshooting.

formatuuid
required DateTimeOffset ApiRequestTimestamp

Timestamp for this API request, useful for troubleshooting.

formatdate-time
required Int MaxPageSize

Maximum allowed page size for this endpoint.

formatint32
required Int PageNumber

Page number for paginated results.

formatint32
required Int PageSize

Number of items per page in this response.

formatint32
required string SortBy

The field that the results were sorted by.

required SortOrder SortOrder
One of the following:
"asc"Asc
"desc"Desc
required Int TotalItems

Total number of items returned in this response.

formatint32
required Int TotalPages

The number of pages available.

formatint32
required ResponseType ResponseType

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.
One of the following:
"object"Object
"array"Array
"error"Error
"none"None

List linked bank accounts

LinkedBankAccountListParams parameters = new();

var page = await client.Embed.LinkedBankAccounts.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}
{
  "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"
}