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