Linked Bank Accounts

Create a linked bank account

client.embed.linkedBankAccounts.create(, ?): LinkedBankAccountV1 { data, meta, response_type }

post/v1/linked_bank_accounts

List linked bank accounts

client.embed.linkedBankAccounts.list(?, ?): PageNumberSchema<Data { id, account_id, bank_account, 8 more } >

get/v1/linked_bank_accounts

Update a linked bank account

client.embed.linkedBankAccounts.update(, , ?): LinkedBankAccountV1 { data, meta, response_type }

put/v1/linked_bank_accounts/{linked_bank_account_id}

Lookup a linked bank account

client.embed.linkedBankAccounts.get(, ?, ?): LinkedBankAccountV1 { data, meta, response_type }

get/v1/linked_bank_accounts/{linked_bank_account_id}

Unmask a linked bank account

client.embed.linkedBankAccounts.unmask(, ?, ?): LinkedBankAccountUnmaskV1 { data, meta, response_type }

get/v1/linked_bank_accounts/{linked_bank_account_id}/unmask

Cancel a linked bank account

client.embed.linkedBankAccounts.cancel(, ?, ?): LinkedBankAccountV1 { data, meta, response_type }

patch/v1/linked_bank_accounts/{linked_bank_account_id}/cancel

ModelsExpand Collapse

LinkedBankAccountPagedV1 { data, meta, response_type }

data: Array<Data { id, account_id, bank_account, 8 more } >

id: string

Unique identifier for the linked bank account.

formatuuid

account_id: string | null

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

formatuuid

bank_account: BankAccount { 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.

formatdate-time

purposes: Array<"charges" | "payouts" | "billing">

The purposes for the linked bank account.

Accepts one of the following:

"charges"

"payouts"

"billing"

status: "created" | "onboarding" | "active" | 3 more

The current status of the linked bank account.

Accepts one of the following:

"created"

"onboarding"

"active"

"rejected"

"inactive"

"canceled"

status_detail: StatusDetail { 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.

Accepts one of the following:

"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.

Accepts one of the following:

"watchtower"

updated_at: string

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

formatdate-time

description?: string | null

Optional description for the bank account.

metadata?: Record<string, string | null> | null

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 | null

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

formatuuid

meta: PagedResponseMetadata { 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.

formatuuid

api_request_timestamp: string

Timestamp for this API request, useful for troubleshooting.

formatdate-time

max_page_size: number

Maximum allowed page size for this endpoint.

formatint32

page_number: number

Page number for paginated results.

formatint32

page_size: number

Number of items per page in this response.

formatint32

sort_by: string

The field that the results were sorted by.

sort_order: "asc" | "desc"

Accepts one of the following:

"asc"

"desc"

total_items: number

Total number of items returned in this response.

formatint32

total_pages: number

The number of pages available.

formatint32

response_type: "object" | "array" | "error" | "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.

Accepts one of the following:

"object"

"array"

"error"

"none"

LinkedBankAccountUnmaskV1 { data, meta, response_type }

data: Data { id, account_id, bank_account, 5 more }

id: string

Unique identifier for the linked bank account.

formatuuid

account_id: string

Unique identifier for the Straddle account related to this bank account.

formatuuid

bank_account: BankAccount { account_holder, account_number, institution_name, routing_number }

The bank account details associated with the linked bank account.

account_holder: string

account_number: string

institution_name: string

routing_number: string

created_at: string

Timestamp of when the linked bank account was created.

formatdate-time

status: "created" | "onboarding" | "active" | 3 more

The current status of the linked bank account.

Accepts one of the following:

"created"

"onboarding"

"active"

"rejected"

"inactive"

"canceled"

status_detail: StatusDetail { code, message, reason, source }

Additional details about the current status of the linked bank account.

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.

Accepts one of the following:

"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.

Accepts one of the following:

"watchtower"

updated_at: string

Timestamp of when the linked bank account was last updated.

formatdate-time

metadata?: Record<string, string | null> | null

meta: ResponseMetadata { api_request_id, api_request_timestamp }

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

api_request_id: string

Unique identifier for this API request, useful for troubleshooting.

formatuuid

api_request_timestamp: string

Timestamp for this API request, useful for troubleshooting.

formatdate-time

response_type: "object" | "array" | "error" | "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.

Accepts one of the following:

"object"

"array"

"error"

"none"

LinkedBankAccountV1 { data, meta, response_type }

data: Data { id, account_id, bank_account, 8 more }

id: string

Unique identifier for the linked bank account.

formatuuid

account_id: string | null

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

formatuuid

bank_account: BankAccount { 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.

formatdate-time

purposes: Array<"charges" | "payouts" | "billing">

The purposes for the linked bank account.

Accepts one of the following:

"charges"

"payouts"

"billing"

status: "created" | "onboarding" | "active" | 3 more

The current status of the linked bank account.

Accepts one of the following:

"created"

"onboarding"

"active"

"rejected"

"inactive"

"canceled"

status_detail: StatusDetail { 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.

Accepts one of the following:

"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.

Accepts one of the following:

"watchtower"

updated_at: string

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

formatdate-time

description?: string | null

Optional description for the bank account.

metadata?: Record<string, string | null> | null

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 | null

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

formatuuid

meta: ResponseMetadata { api_request_id, api_request_timestamp }

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

api_request_id: string

Unique identifier for this API request, useful for troubleshooting.

formatuuid

api_request_timestamp: string

Timestamp for this API request, useful for troubleshooting.

formatdate-time

response_type: "object" | "array" | "error" | "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.

Accepts one of the following:

"object"

"array"

"error"

"none"