Accounts
Lookup an account
Update an account
List accounts
Onboard an account
Simulate status transitions for a sandbox account
ModelsExpand Collapse
class AccountPagedV1: …
data: List[Data]
id: str
Unique identifier for the account.
access_level: Literal["standard", "managed"]
The access level granted to the account. This is determined by your platform configuration. Use standard unless instructed otherwise by Straddle.
organization_id: str
The unique identifier of the organization this account belongs to.
status: Literal["created", "onboarding", "active", 2 more]
The current status of the account (e.g., 'active', 'inactive', 'pending').
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", 6 more]
A machine-readable identifier for the specific status, useful for programmatic handling.
source: Literal["watchtower"]
Identifies the origin of the status change (e.g., bank_decline, watchtower). This helps in tracking the cause of status updates.
type: Literal["business"]
The type of account (e.g., 'individual', 'business').
business_profile: Optional[BusinessProfileV1]
name: str
The operating or trade name of the business.
website: str
URL of the business's primary marketing website.
address: Optional[AddressV1]
The address object is optional. If provided, it must be a valid address.
address1: str
Primary address line (e.g., street, PO Box).
city: Optional[str]
City, district, suburb, town, or village.
state: Optional[str]
Two-letter state code.
zip: str
Zip or postal code.
address2: Optional[str]
Secondary address line (e.g., apartment, suite, unit, or building).
country: Optional[str]
The country of the address, in ISO 3166-1 alpha-2 format.
line1: Optional[str]
Primary address line (e.g., street, PO Box).
line2: Optional[str]
Secondary address line (e.g., apartment, suite, unit, or building).
postal_code: Optional[str]
Postal or ZIP code.
description: Optional[str]
A brief description of the business and its products or services.
industry: Optional[IndustryV1]
category: Optional[str]
The general category of the industry. Required if not providing MCC.
mcc: Optional[str]
The Merchant Category Code (MCC) that best describes the business. Optional.
sector: Optional[str]
The specific sector within the industry category. Required if not providing MCC.
legal_name: Optional[str]
The official registered name of the business.
phone: Optional[str]
The primary contact phone number for the business.
support_channels: Optional[SupportChannelsV1]
email: Optional[str]
The email address for customer support inquiries.
phone: Optional[str]
The phone number for customer support.
url: Optional[str]
The URL of the business's customer support page or contact form.
tax_id: Optional[str]
The business's tax identification number (e.g., EIN in the US).
use_case: Optional[str]
A description of how the business intends to use Straddle's services.
capabilities: Optional[DataCapabilities]
consent_types: DataCapabilitiesConsentTypes
Whether the internet payment authorization capability is enabled for the account.
capability_status: Literal["active", "inactive"]
Whether the signed agreement payment authorization capability is enabled for the account.
capability_status: Literal["active", "inactive"]
customer_types: DataCapabilitiesCustomerTypes
capability_status: Literal["active", "inactive"]
capability_status: Literal["active", "inactive"]
payment_types: DataCapabilitiesPaymentTypes
capability_status: Literal["active", "inactive"]
capability_status: Literal["active", "inactive"]
created_at: Optional[datetime]
Timestamp of when the account was created.
external_id: Optional[str]
Unique identifier for the account in your database, used for cross-referencing between Straddle and your systems.
metadata: Optional[Dict[str, Optional[str]]]
Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the account in a structured format.
settings: Optional[DataSettings]
charges: DataSettingsCharges
daily_amount: int
The maximum dollar amount of charges in a calendar day.
funding_time: Literal["immediate", "next_day", "one_day", 2 more]
The amount of time it takes for a charge to be funded. This value is defined by Straddle.
linked_bank_account_id: str
The unique identifier of the linked bank account associated with charges. This value is defined by Straddle.
max_amount: int
The maximum amount of a single charge.
monthly_amount: int
The maximum dollar amount of charges in a calendar month.
monthly_count: int
The maximum number of charges in a calendar month.
payouts: DataSettingsPayouts
daily_amount: int
The maximum dollar amount of payouts in a day.
funding_time: Literal["immediate", "next_day", "one_day", 2 more]
The amount of time it takes for a payout to be funded. This value is defined by Straddle.
linked_bank_account_id: str
The unique identifier of the linked bank account to use for payouts.
max_amount: int
The maximum amount of a single payout.
monthly_amount: int
The maximum dollar amount of payouts in a month.
monthly_count: int
The maximum number of payouts in a month.
terms_of_service: Optional[TermsOfServiceV1]
accepted_date: datetime
The datetime of when the terms of service were accepted, in ISO 8601 format.
agreement_type: Literal["embedded", "direct"]
The type or version of the agreement accepted. Use embedded unless your platform was specifically enabled for direct agreements.
agreement_url: Optional[str]
The URL where the full text of the accepted agreement can be found.
accepted_ip: Optional[str]
The IP address from which the terms of service were accepted.
accepted_user_agent: Optional[str]
The user agent string of the browser or application used to accept the terms.
updated_at: Optional[datetime]
Timestamp of the most recent update to the account.
Metadata about the API request, including an identifier, timestamp, and pagination details.
api_request_id: str
Unique identifier for this API request, useful for troubleshooting.
api_request_timestamp: datetime
Timestamp for this API request, useful for troubleshooting.
max_page_size: int
Maximum allowed page size for this endpoint.
page_number: int
Page number for paginated results.
page_size: int
Number of items per page in this response.
sort_by: str
The field that the results were sorted by.
sort_order: Literal["asc", "desc"]
total_items: int
Total number of items returned in this response.
total_pages: int
The number of pages available.
response_type: Literal["object", "array", "error", "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.
class AccountV1: …
data: Data
id: str
Unique identifier for the account.
access_level: Literal["standard", "managed"]
The access level granted to the account. This is determined by your platform configuration. Use standard unless instructed otherwise by Straddle.
organization_id: str
The unique identifier of the organization this account belongs to.
status: Literal["created", "onboarding", "active", 2 more]
The current status of the account (e.g., 'active', 'inactive', 'pending').
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", 6 more]
A machine-readable identifier for the specific status, useful for programmatic handling.
source: Literal["watchtower"]
Identifies the origin of the status change (e.g., bank_decline, watchtower). This helps in tracking the cause of status updates.
type: Literal["business"]
The type of account (e.g., 'individual', 'business').
business_profile: Optional[BusinessProfileV1]
name: str
The operating or trade name of the business.
website: str
URL of the business's primary marketing website.
address: Optional[AddressV1]
The address object is optional. If provided, it must be a valid address.
address1: str
Primary address line (e.g., street, PO Box).
city: Optional[str]
City, district, suburb, town, or village.
state: Optional[str]
Two-letter state code.
zip: str
Zip or postal code.
address2: Optional[str]
Secondary address line (e.g., apartment, suite, unit, or building).
country: Optional[str]
The country of the address, in ISO 3166-1 alpha-2 format.
line1: Optional[str]
Primary address line (e.g., street, PO Box).
line2: Optional[str]
Secondary address line (e.g., apartment, suite, unit, or building).
postal_code: Optional[str]
Postal or ZIP code.
description: Optional[str]
A brief description of the business and its products or services.
industry: Optional[IndustryV1]
category: Optional[str]
The general category of the industry. Required if not providing MCC.
mcc: Optional[str]
The Merchant Category Code (MCC) that best describes the business. Optional.
sector: Optional[str]
The specific sector within the industry category. Required if not providing MCC.
legal_name: Optional[str]
The official registered name of the business.
phone: Optional[str]
The primary contact phone number for the business.
support_channels: Optional[SupportChannelsV1]
email: Optional[str]
The email address for customer support inquiries.
phone: Optional[str]
The phone number for customer support.
url: Optional[str]
The URL of the business's customer support page or contact form.
tax_id: Optional[str]
The business's tax identification number (e.g., EIN in the US).
use_case: Optional[str]
A description of how the business intends to use Straddle's services.
capabilities: Optional[DataCapabilities]
consent_types: DataCapabilitiesConsentTypes
Whether the internet payment authorization capability is enabled for the account.
capability_status: Literal["active", "inactive"]
Whether the signed agreement payment authorization capability is enabled for the account.
capability_status: Literal["active", "inactive"]
customer_types: DataCapabilitiesCustomerTypes
capability_status: Literal["active", "inactive"]
capability_status: Literal["active", "inactive"]
payment_types: DataCapabilitiesPaymentTypes
capability_status: Literal["active", "inactive"]
capability_status: Literal["active", "inactive"]
created_at: Optional[datetime]
Timestamp of when the account was created.
external_id: Optional[str]
Unique identifier for the account in your database, used for cross-referencing between Straddle and your systems.
metadata: Optional[Dict[str, Optional[str]]]
Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the account in a structured format.
settings: Optional[DataSettings]
charges: DataSettingsCharges
daily_amount: int
The maximum dollar amount of charges in a calendar day.
funding_time: Literal["immediate", "next_day", "one_day", 2 more]
The amount of time it takes for a charge to be funded. This value is defined by Straddle.
linked_bank_account_id: str
The unique identifier of the linked bank account associated with charges. This value is defined by Straddle.
max_amount: int
The maximum amount of a single charge.
monthly_amount: int
The maximum dollar amount of charges in a calendar month.
monthly_count: int
The maximum number of charges in a calendar month.
payouts: DataSettingsPayouts
daily_amount: int
The maximum dollar amount of payouts in a day.
funding_time: Literal["immediate", "next_day", "one_day", 2 more]
The amount of time it takes for a payout to be funded. This value is defined by Straddle.
linked_bank_account_id: str
The unique identifier of the linked bank account to use for payouts.
max_amount: int
The maximum amount of a single payout.
monthly_amount: int
The maximum dollar amount of payouts in a month.
monthly_count: int
The maximum number of payouts in a month.
terms_of_service: Optional[TermsOfServiceV1]
accepted_date: datetime
The datetime of when the terms of service were accepted, in ISO 8601 format.
agreement_type: Literal["embedded", "direct"]
The type or version of the agreement accepted. Use embedded unless your platform was specifically enabled for direct agreements.
agreement_url: Optional[str]
The URL where the full text of the accepted agreement can be found.
accepted_ip: Optional[str]
The IP address from which the terms of service were accepted.
accepted_user_agent: Optional[str]
The user agent string of the browser or application used to accept the terms.
updated_at: Optional[datetime]
Timestamp of the most recent update to the account.
Metadata about the API request, including an identifier and timestamp.
api_request_id: str
Unique identifier for this API request, useful for troubleshooting.
api_request_timestamp: datetime
Timestamp for this API request, useful for troubleshooting.
response_type: Literal["object", "array", "error", "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.
class AddressV1: …
The address object is optional. If provided, it must be a valid address.
address1: str
Primary address line (e.g., street, PO Box).
city: Optional[str]
City, district, suburb, town, or village.
state: Optional[str]
Two-letter state code.
zip: str
Zip or postal code.
address2: Optional[str]
Secondary address line (e.g., apartment, suite, unit, or building).
country: Optional[str]
The country of the address, in ISO 3166-1 alpha-2 format.
line1: Optional[str]
Primary address line (e.g., street, PO Box).
line2: Optional[str]
Secondary address line (e.g., apartment, suite, unit, or building).
postal_code: Optional[str]
Postal or ZIP code.
class BusinessProfileV1: …
name: str
The operating or trade name of the business.
website: str
URL of the business's primary marketing website.
address: Optional[AddressV1]
The address object is optional. If provided, it must be a valid address.
address1: str
Primary address line (e.g., street, PO Box).
city: Optional[str]
City, district, suburb, town, or village.
state: Optional[str]
Two-letter state code.
zip: str
Zip or postal code.
address2: Optional[str]
Secondary address line (e.g., apartment, suite, unit, or building).
country: Optional[str]
The country of the address, in ISO 3166-1 alpha-2 format.
line1: Optional[str]
Primary address line (e.g., street, PO Box).
line2: Optional[str]
Secondary address line (e.g., apartment, suite, unit, or building).
postal_code: Optional[str]
Postal or ZIP code.
description: Optional[str]
A brief description of the business and its products or services.
industry: Optional[IndustryV1]
category: Optional[str]
The general category of the industry. Required if not providing MCC.
mcc: Optional[str]
The Merchant Category Code (MCC) that best describes the business. Optional.
sector: Optional[str]
The specific sector within the industry category. Required if not providing MCC.
legal_name: Optional[str]
The official registered name of the business.
phone: Optional[str]
The primary contact phone number for the business.
support_channels: Optional[SupportChannelsV1]
email: Optional[str]
The email address for customer support inquiries.
phone: Optional[str]
The phone number for customer support.
url: Optional[str]
The URL of the business's customer support page or contact form.
tax_id: Optional[str]
The business's tax identification number (e.g., EIN in the US).
use_case: Optional[str]
A description of how the business intends to use Straddle's services.
class CapabilityV1: …
capability_status: Literal["active", "inactive"]
class IndustryV1: …
category: Optional[str]
The general category of the industry. Required if not providing MCC.
mcc: Optional[str]
The Merchant Category Code (MCC) that best describes the business. Optional.
sector: Optional[str]
The specific sector within the industry category. Required if not providing MCC.
class SupportChannelsV1: …
email: Optional[str]
The email address for customer support inquiries.
phone: Optional[str]
The phone number for customer support.
url: Optional[str]
The URL of the business's customer support page or contact form.
class TermsOfServiceV1: …
accepted_date: datetime
The datetime of when the terms of service were accepted, in ISO 8601 format.
agreement_type: Literal["embedded", "direct"]
The type or version of the agreement accepted. Use embedded unless your platform was specifically enabled for direct agreements.
agreement_url: Optional[str]
The URL where the full text of the accepted agreement can be found.
accepted_ip: Optional[str]
The IP address from which the terms of service were accepted.
accepted_user_agent: Optional[str]
The user agent string of the browser or application used to accept the terms.
AccountsCapability Requests
Request a capability
List capability requests
ModelsExpand Collapse
class CapabilityRequestPagedV1: …
data: List[Data]
id: str
Unique identifier for the capability request.
account_id: str
The unique identifier of the account associated with this capability request.
category: Literal["payment_type", "customer_type", "consent_type"]
The category of the requested capability. Use payment_type for charges and payouts, customer_type to define individuals or businesses, and consent_type for signed_agreement or internet payment authorization.
created_at: datetime
Timestamp of when the capability request was created.
status: Literal["active", "inactive", "in_review", 3 more]
The current status of the capability request.
type: Literal["charges", "payouts", "individuals", 3 more]
The specific type of capability being requested within the category.
updated_at: datetime
Timestamp of the most recent update to the capability request.
settings: Optional[Dict[str, object]]
Any specific settings or configurations related to the requested capability.
Metadata about the API request, including an identifier, timestamp, and pagination details.
api_request_id: str
Unique identifier for this API request, useful for troubleshooting.
api_request_timestamp: datetime
Timestamp for this API request, useful for troubleshooting.
max_page_size: int
Maximum allowed page size for this endpoint.
page_number: int
Page number for paginated results.
page_size: int
Number of items per page in this response.
sort_by: str
The field that the results were sorted by.
sort_order: Literal["asc", "desc"]
total_items: int
Total number of items returned in this response.
total_pages: int
The number of pages available.
response_type: Literal["object", "array", "error", "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.