Linked Bank Accounts
Create a linked bank account
List linked bank accounts
Update a linked bank account
Lookup a linked bank account
Unmask a linked bank account
Cancel a linked bank account
ModelsExpand Collapse
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 }
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.
status: "created" or "onboarding" or "active" or 3 more
The current status of the linked bank account.
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.
source: "watchtower"
Identifies the origin of the status change (e.g., watchtower). This helps in tracking the cause of status updates.
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.
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"
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
datafield contains a single JSON object. - "array" means the
datafield contains an array of objects. - "error" means the
datafield contains an error object with details of the issue. - "none" means no data is returned.
LinkedBankAccountUnmaskV1 = object { data, meta, response_type }
data: object { id, account_id, bank_account, 5 more }
id: string
Unique identifier for the linked bank account.
account_id: string
Unique identifier for the Straddle account related to this bank account.
bank_account: object { account_holder, account_number, institution_name, routing_number }
The bank account details associated with the linked bank account.
created_at: string
Timestamp of when the linked bank account was created.
status: "created" or "onboarding" or "active" or 3 more
The current status of the linked bank account.
status_detail: object { 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" or "in_review" or "pending" or 5 more
A machine-readable identifier for the specific status, useful for programmatic handling.
source: "watchtower"
Identifies the origin of the status change (e.g., watchtower). This helps in tracking the cause of status updates.
updated_at: string
Timestamp of when the linked bank account was last updated.
Metadata about the API request, including an identifier and timestamp.
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.
response_type: "object" or "array" or "error" or "none"
Indicates the structure of the returned content.
- "object" means the
datafield contains a single JSON object. - "array" means the
datafield contains an array of objects. - "error" means the
datafield contains an error object with details of the issue. - "none" means no data is returned.
LinkedBankAccountV1 = object { data, meta, response_type }
data: 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 }
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.
status: "created" or "onboarding" or "active" or 3 more
The current status of the linked bank account.
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.
source: "watchtower"
Identifies the origin of the status change (e.g., watchtower). This helps in tracking the cause of status updates.
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.
Metadata about the API request, including an identifier and timestamp.
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.
response_type: "object" or "array" or "error" or "none"
Indicates the structure of the returned content.
- "object" means the
datafield contains a single JSON object. - "array" means the
datafield contains an array of objects. - "error" means the
datafield contains an error object with details of the issue. - "none" means no data is returned.