Accounts

Accounts represent businesses using Straddle through your platform. Each account must complete automated verification before processing payments. Use accounts to manage your users' payment capabilities, track verification status, and control access to features. Accounts can be instantly created in sandbox and require additional verification for production access.

Lookup an account

client.Embed.Accounts.Get(ctx, accountID, query) (*AccountV1, error)

GET/v1/accounts/{account_id}

Update an account

client.Embed.Accounts.Update(ctx, accountID, params) (*AccountV1, error)

PUT/v1/accounts/{account_id}

Create an account

client.Embed.Accounts.New(ctx, params) (*AccountV1, error)

POST/v1/accounts

List accounts

client.Embed.Accounts.List(ctx, params) (*PageNumberSchema[AccountPagedV1Data], error)

GET/v1/accounts

Onboard an account

client.Embed.Accounts.Onboard(ctx, accountID, params) (*AccountV1, error)

POST/v1/accounts/{account_id}/onboard

Simulate status transitions for a sandbox account

client.Embed.Accounts.Simulate(ctx, accountID, params) (*AccountV1, error)

POST/v1/accounts/{account_id}/simulate

ModelsExpand Collapse

type AccountPagedV1 struct{…}

Data []AccountPagedV1Data

ID string

Unique identifier for the account.

formatuuid

AccessLevel string

The access level granted to the account. This is determined by your platform configuration. Use standard unless instructed otherwise by Straddle.

One of the following:

const AccountPagedV1DataAccessLevelStandard AccountPagedV1DataAccessLevel = "standard"

const AccountPagedV1DataAccessLevelManaged AccountPagedV1DataAccessLevel = "managed"

OrganizationID string

The unique identifier of the organization this account belongs to.

formatuuid

Status string

The current status of the account (e.g., 'active', 'inactive', 'pending').

One of the following:

const AccountPagedV1DataStatusCreated AccountPagedV1DataStatus = "created"

const AccountPagedV1DataStatusOnboarding AccountPagedV1DataStatus = "onboarding"

const AccountPagedV1DataStatusActive AccountPagedV1DataStatus = "active"

const AccountPagedV1DataStatusRejected AccountPagedV1DataStatus = "rejected"

const AccountPagedV1DataStatusInactive AccountPagedV1DataStatus = "inactive"

StatusDetail AccountPagedV1DataStatusDetail

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 string

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

One of the following:

const AccountPagedV1DataStatusDetailReasonUnverified AccountPagedV1DataStatusDetailReason = "unverified"

const AccountPagedV1DataStatusDetailReasonInReview AccountPagedV1DataStatusDetailReason = "in_review"

const AccountPagedV1DataStatusDetailReasonPending AccountPagedV1DataStatusDetailReason = "pending"

const AccountPagedV1DataStatusDetailReasonStuck AccountPagedV1DataStatusDetailReason = "stuck"

const AccountPagedV1DataStatusDetailReasonVerified AccountPagedV1DataStatusDetailReason = "verified"

const AccountPagedV1DataStatusDetailReasonFailedVerification AccountPagedV1DataStatusDetailReason = "failed_verification"

const AccountPagedV1DataStatusDetailReasonDisabled AccountPagedV1DataStatusDetailReason = "disabled"

const AccountPagedV1DataStatusDetailReasonTerminated AccountPagedV1DataStatusDetailReason = "terminated"

const AccountPagedV1DataStatusDetailReasonNew AccountPagedV1DataStatusDetailReason = "new"

Source string

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

Type string

The type of account (e.g., 'individual', 'business').

BusinessProfile BusinessProfileV1optional

Name string

The operating or trade name of the business.

Website string

URL of the business's primary marketing website.

formaturi

Address AddressV1optional

The address object is optional. If provided, it must be a valid address.

City string

City, district, suburb, town, or village.

Line1 string

Primary address line (e.g., street, PO Box).

PostalCode string

Postal or ZIP code.

State string

Two-letter state code.

Country stringoptional

The country of the address, in ISO 3166-1 alpha-2 format.

Line2 stringoptional

Secondary address line (e.g., apartment, suite, unit, or building).

Description stringoptional

A brief description of the business and its products or services.

Industry IndustryV1optional

Category stringoptional

The general category of the industry. Required if not providing MCC.

Mcc stringoptional

The Merchant Category Code (MCC) that best describes the business. Optional.

Sector stringoptional

The specific sector within the industry category. Required if not providing MCC.

LegalName stringoptional

The official registered name of the business.

Phone stringoptional

The primary contact phone number for the business.

SupportChannels SupportChannelsV1optional

Email stringoptional

The email address for customer support inquiries.

formatemail

Phone stringoptional

The phone number for customer support.

URL stringoptional

The URL of the business's customer support page or contact form.

formaturi

TaxID stringoptional

The business's tax identification number (e.g., EIN in the US).

UseCase stringoptional

A description of how the business intends to use Straddle's services.

Capabilities AccountPagedV1DataCapabilitiesoptional

ConsentTypes AccountPagedV1DataCapabilitiesConsentTypes

Internet CapabilityV1

Whether the internet payment authorization capability is enabled for the account.

CapabilityStatus CapabilityV1CapabilityStatus

One of the following:

const CapabilityV1CapabilityStatusActive CapabilityV1CapabilityStatus = "active"

const CapabilityV1CapabilityStatusInactive CapabilityV1CapabilityStatus = "inactive"

SignedAgreement CapabilityV1

Whether the signed agreement payment authorization capability is enabled for the account.

CapabilityStatus CapabilityV1CapabilityStatus

One of the following:

const CapabilityV1CapabilityStatusActive CapabilityV1CapabilityStatus = "active"

const CapabilityV1CapabilityStatusInactive CapabilityV1CapabilityStatus = "inactive"

CustomerTypes AccountPagedV1DataCapabilitiesCustomerTypes

Businesses CapabilityV1

CapabilityStatus CapabilityV1CapabilityStatus

One of the following:

const CapabilityV1CapabilityStatusActive CapabilityV1CapabilityStatus = "active"

const CapabilityV1CapabilityStatusInactive CapabilityV1CapabilityStatus = "inactive"

Individuals CapabilityV1

CapabilityStatus CapabilityV1CapabilityStatus

One of the following:

const CapabilityV1CapabilityStatusActive CapabilityV1CapabilityStatus = "active"

const CapabilityV1CapabilityStatusInactive CapabilityV1CapabilityStatus = "inactive"

PaymentTypes AccountPagedV1DataCapabilitiesPaymentTypes

Charges CapabilityV1

CapabilityStatus CapabilityV1CapabilityStatus

One of the following:

const CapabilityV1CapabilityStatusActive CapabilityV1CapabilityStatus = "active"

const CapabilityV1CapabilityStatusInactive CapabilityV1CapabilityStatus = "inactive"

Payouts CapabilityV1

CapabilityStatus CapabilityV1CapabilityStatus

One of the following:

const CapabilityV1CapabilityStatusActive CapabilityV1CapabilityStatus = "active"

const CapabilityV1CapabilityStatusInactive CapabilityV1CapabilityStatus = "inactive"

CreatedAt Timeoptional

Timestamp of when the account was created.

formatdate-time

ExternalID stringoptional

Unique identifier for the account in your database, used for cross-referencing between Straddle and your systems.

Metadata map[string, string]optional

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

Settings AccountPagedV1DataSettingsoptional

Charges AccountPagedV1DataSettingsCharges

DailyAmount int64

The maximum dollar amount of charges in a calendar day.

formatint32

FundingTime string

The amount of time it takes for a charge to be funded. This value is defined by Straddle.

One of the following:

const AccountPagedV1DataSettingsChargesFundingTimeImmediate AccountPagedV1DataSettingsChargesFundingTime = "immediate"

const AccountPagedV1DataSettingsChargesFundingTimeNextDay AccountPagedV1DataSettingsChargesFundingTime = "next_day"

const AccountPagedV1DataSettingsChargesFundingTimeOneDay AccountPagedV1DataSettingsChargesFundingTime = "one_day"

const AccountPagedV1DataSettingsChargesFundingTimeTwoDay AccountPagedV1DataSettingsChargesFundingTime = "two_day"

const AccountPagedV1DataSettingsChargesFundingTimeThreeDay AccountPagedV1DataSettingsChargesFundingTime = "three_day"

const AccountPagedV1DataSettingsChargesFundingTimeFourDay AccountPagedV1DataSettingsChargesFundingTime = "four_day"

const AccountPagedV1DataSettingsChargesFundingTimeFiveDay AccountPagedV1DataSettingsChargesFundingTime = "five_day"

LinkedBankAccountID string

The unique identifier of the linked bank account associated with charges. This value is defined by Straddle.

formatuuid

MaxAmount int64

The maximum amount of a single charge.

formatint32

MonthlyAmount int64

The maximum dollar amount of charges in a calendar month.

formatint32

MonthlyCount int64

The maximum number of charges in a calendar month.

formatint32

Payouts AccountPagedV1DataSettingsPayouts

DailyAmount int64

The maximum dollar amount of payouts in a day.

formatint32

FundingTime string

The amount of time it takes for a payout to be funded. This value is defined by Straddle.

One of the following:

const AccountPagedV1DataSettingsPayoutsFundingTimeImmediate AccountPagedV1DataSettingsPayoutsFundingTime = "immediate"

const AccountPagedV1DataSettingsPayoutsFundingTimeNextDay AccountPagedV1DataSettingsPayoutsFundingTime = "next_day"

const AccountPagedV1DataSettingsPayoutsFundingTimeOneDay AccountPagedV1DataSettingsPayoutsFundingTime = "one_day"

const AccountPagedV1DataSettingsPayoutsFundingTimeTwoDay AccountPagedV1DataSettingsPayoutsFundingTime = "two_day"

const AccountPagedV1DataSettingsPayoutsFundingTimeThreeDay AccountPagedV1DataSettingsPayoutsFundingTime = "three_day"

const AccountPagedV1DataSettingsPayoutsFundingTimeFourDay AccountPagedV1DataSettingsPayoutsFundingTime = "four_day"

const AccountPagedV1DataSettingsPayoutsFundingTimeFiveDay AccountPagedV1DataSettingsPayoutsFundingTime = "five_day"

LinkedBankAccountID string

The unique identifier of the linked bank account to use for payouts.

formatuuid

MaxAmount int64

The maximum amount of a single payout.

formatint32

MonthlyAmount int64

The maximum dollar amount of payouts in a month.

formatint32

MonthlyCount int64

The maximum number of payouts in a month.

formatint32

TermsOfService TermsOfServiceV1optional

AcceptedDate Time

The datetime of when the terms of service were accepted, in ISO 8601 format.

formatdate-time

AgreementType TermsOfServiceV1AgreementType

The type or version of the agreement accepted. Use embedded unless your platform was specifically enabled for direct agreements.

One of the following:

const TermsOfServiceV1AgreementTypeEmbedded TermsOfServiceV1AgreementType = "embedded"

const TermsOfServiceV1AgreementTypeDirect TermsOfServiceV1AgreementType = "direct"

AgreementURL string

The URL where the full text of the accepted agreement can be found.

AcceptedIP stringoptional

The IP address from which the terms of service were accepted.

AcceptedUserAgent stringoptional

The user agent string of the browser or application used to accept the terms.

UpdatedAt Timeoptional

Timestamp of the most recent update to the account.

formatdate-time

Meta PagedResponseMetadata

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

APIRequestID string

Unique identifier for this API request, useful for troubleshooting.

formatuuid

APIRequestTimestamp Time

Timestamp for this API request, useful for troubleshooting.

formatdate-time

MaxPageSize int64

Maximum allowed page size for this endpoint.

formatint32

PageNumber int64

Page number for paginated results.

formatint32

PageSize int64

Number of items per page in this response.

formatint32

SortBy string

The field that the results were sorted by.

SortOrder PagedResponseMetadataSortOrder

One of the following:

const PagedResponseMetadataSortOrderAsc PagedResponseMetadataSortOrder = "asc"

const PagedResponseMetadataSortOrderDesc PagedResponseMetadataSortOrder = "desc"

TotalItems int64

Total number of items returned in this response.

formatint32

TotalPages int64

The number of pages available.

formatint32

ResponseType AccountPagedV1ResponseType

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:

const AccountPagedV1ResponseTypeObject AccountPagedV1ResponseType = "object"

const AccountPagedV1ResponseTypeArray AccountPagedV1ResponseType = "array"

const AccountPagedV1ResponseTypeError AccountPagedV1ResponseType = "error"

const AccountPagedV1ResponseTypeNone AccountPagedV1ResponseType = "none"

type AccountV1 struct{…}

Data AccountV1Data

ID string

Unique identifier for the account.

formatuuid

AccessLevel string

The access level granted to the account. This is determined by your platform configuration. Use standard unless instructed otherwise by Straddle.

One of the following:

const AccountV1DataAccessLevelStandard AccountV1DataAccessLevel = "standard"

const AccountV1DataAccessLevelManaged AccountV1DataAccessLevel = "managed"

OrganizationID string

The unique identifier of the organization this account belongs to.

formatuuid

Status string

The current status of the account (e.g., 'active', 'inactive', 'pending').

One of the following:

const AccountV1DataStatusCreated AccountV1DataStatus = "created"

const AccountV1DataStatusOnboarding AccountV1DataStatus = "onboarding"

const AccountV1DataStatusActive AccountV1DataStatus = "active"

const AccountV1DataStatusRejected AccountV1DataStatus = "rejected"

const AccountV1DataStatusInactive AccountV1DataStatus = "inactive"

StatusDetail AccountV1DataStatusDetail

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 string

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

One of the following:

const AccountV1DataStatusDetailReasonUnverified AccountV1DataStatusDetailReason = "unverified"

const AccountV1DataStatusDetailReasonInReview AccountV1DataStatusDetailReason = "in_review"

const AccountV1DataStatusDetailReasonPending AccountV1DataStatusDetailReason = "pending"

const AccountV1DataStatusDetailReasonStuck AccountV1DataStatusDetailReason = "stuck"

const AccountV1DataStatusDetailReasonVerified AccountV1DataStatusDetailReason = "verified"

const AccountV1DataStatusDetailReasonFailedVerification AccountV1DataStatusDetailReason = "failed_verification"

const AccountV1DataStatusDetailReasonDisabled AccountV1DataStatusDetailReason = "disabled"

const AccountV1DataStatusDetailReasonTerminated AccountV1DataStatusDetailReason = "terminated"

const AccountV1DataStatusDetailReasonNew AccountV1DataStatusDetailReason = "new"

Source string

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

Type string

The type of account (e.g., 'individual', 'business').

BusinessProfile BusinessProfileV1optional

Name string

The operating or trade name of the business.

Website string

URL of the business's primary marketing website.

formaturi

Address AddressV1optional

The address object is optional. If provided, it must be a valid address.

City string

City, district, suburb, town, or village.

Line1 string

Primary address line (e.g., street, PO Box).

PostalCode string

Postal or ZIP code.

State string

Two-letter state code.

Country stringoptional

The country of the address, in ISO 3166-1 alpha-2 format.

Line2 stringoptional

Secondary address line (e.g., apartment, suite, unit, or building).

Description stringoptional

A brief description of the business and its products or services.

Industry IndustryV1optional

Category stringoptional

The general category of the industry. Required if not providing MCC.

Mcc stringoptional

The Merchant Category Code (MCC) that best describes the business. Optional.

Sector stringoptional

The specific sector within the industry category. Required if not providing MCC.

LegalName stringoptional

The official registered name of the business.

Phone stringoptional

The primary contact phone number for the business.

SupportChannels SupportChannelsV1optional

Email stringoptional

The email address for customer support inquiries.

formatemail

Phone stringoptional

The phone number for customer support.

URL stringoptional

The URL of the business's customer support page or contact form.

formaturi

TaxID stringoptional

The business's tax identification number (e.g., EIN in the US).

UseCase stringoptional

A description of how the business intends to use Straddle's services.

Capabilities AccountV1DataCapabilitiesoptional

ConsentTypes AccountV1DataCapabilitiesConsentTypes

Internet CapabilityV1

Whether the internet payment authorization capability is enabled for the account.

CapabilityStatus CapabilityV1CapabilityStatus

One of the following:

const CapabilityV1CapabilityStatusActive CapabilityV1CapabilityStatus = "active"

const CapabilityV1CapabilityStatusInactive CapabilityV1CapabilityStatus = "inactive"

SignedAgreement CapabilityV1

Whether the signed agreement payment authorization capability is enabled for the account.

CapabilityStatus CapabilityV1CapabilityStatus

One of the following:

const CapabilityV1CapabilityStatusActive CapabilityV1CapabilityStatus = "active"

const CapabilityV1CapabilityStatusInactive CapabilityV1CapabilityStatus = "inactive"

CustomerTypes AccountV1DataCapabilitiesCustomerTypes

Businesses CapabilityV1

CapabilityStatus CapabilityV1CapabilityStatus

One of the following:

const CapabilityV1CapabilityStatusActive CapabilityV1CapabilityStatus = "active"

const CapabilityV1CapabilityStatusInactive CapabilityV1CapabilityStatus = "inactive"

Individuals CapabilityV1

CapabilityStatus CapabilityV1CapabilityStatus

One of the following:

const CapabilityV1CapabilityStatusActive CapabilityV1CapabilityStatus = "active"

const CapabilityV1CapabilityStatusInactive CapabilityV1CapabilityStatus = "inactive"

PaymentTypes AccountV1DataCapabilitiesPaymentTypes

Charges CapabilityV1

CapabilityStatus CapabilityV1CapabilityStatus

One of the following:

const CapabilityV1CapabilityStatusActive CapabilityV1CapabilityStatus = "active"

const CapabilityV1CapabilityStatusInactive CapabilityV1CapabilityStatus = "inactive"

Payouts CapabilityV1

CapabilityStatus CapabilityV1CapabilityStatus

One of the following:

const CapabilityV1CapabilityStatusActive CapabilityV1CapabilityStatus = "active"

const CapabilityV1CapabilityStatusInactive CapabilityV1CapabilityStatus = "inactive"

CreatedAt Timeoptional

Timestamp of when the account was created.

formatdate-time

ExternalID stringoptional

Unique identifier for the account in your database, used for cross-referencing between Straddle and your systems.

Metadata map[string, string]optional

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

Settings AccountV1DataSettingsoptional

Charges AccountV1DataSettingsCharges

DailyAmount int64

The maximum dollar amount of charges in a calendar day.

formatint32

FundingTime string

The amount of time it takes for a charge to be funded. This value is defined by Straddle.

One of the following:

const AccountV1DataSettingsChargesFundingTimeImmediate AccountV1DataSettingsChargesFundingTime = "immediate"

const AccountV1DataSettingsChargesFundingTimeNextDay AccountV1DataSettingsChargesFundingTime = "next_day"

const AccountV1DataSettingsChargesFundingTimeOneDay AccountV1DataSettingsChargesFundingTime = "one_day"

const AccountV1DataSettingsChargesFundingTimeTwoDay AccountV1DataSettingsChargesFundingTime = "two_day"

const AccountV1DataSettingsChargesFundingTimeThreeDay AccountV1DataSettingsChargesFundingTime = "three_day"

const AccountV1DataSettingsChargesFundingTimeFourDay AccountV1DataSettingsChargesFundingTime = "four_day"

const AccountV1DataSettingsChargesFundingTimeFiveDay AccountV1DataSettingsChargesFundingTime = "five_day"

LinkedBankAccountID string

The unique identifier of the linked bank account associated with charges. This value is defined by Straddle.

formatuuid

MaxAmount int64

The maximum amount of a single charge.

formatint32

MonthlyAmount int64

The maximum dollar amount of charges in a calendar month.

formatint32

MonthlyCount int64

The maximum number of charges in a calendar month.

formatint32

Payouts AccountV1DataSettingsPayouts

DailyAmount int64

The maximum dollar amount of payouts in a day.

formatint32

FundingTime string

The amount of time it takes for a payout to be funded. This value is defined by Straddle.

One of the following:

const AccountV1DataSettingsPayoutsFundingTimeImmediate AccountV1DataSettingsPayoutsFundingTime = "immediate"

const AccountV1DataSettingsPayoutsFundingTimeNextDay AccountV1DataSettingsPayoutsFundingTime = "next_day"

const AccountV1DataSettingsPayoutsFundingTimeOneDay AccountV1DataSettingsPayoutsFundingTime = "one_day"

const AccountV1DataSettingsPayoutsFundingTimeTwoDay AccountV1DataSettingsPayoutsFundingTime = "two_day"

const AccountV1DataSettingsPayoutsFundingTimeThreeDay AccountV1DataSettingsPayoutsFundingTime = "three_day"

const AccountV1DataSettingsPayoutsFundingTimeFourDay AccountV1DataSettingsPayoutsFundingTime = "four_day"

const AccountV1DataSettingsPayoutsFundingTimeFiveDay AccountV1DataSettingsPayoutsFundingTime = "five_day"

LinkedBankAccountID string

The unique identifier of the linked bank account to use for payouts.

formatuuid

MaxAmount int64

The maximum amount of a single payout.

formatint32

MonthlyAmount int64

The maximum dollar amount of payouts in a month.

formatint32

MonthlyCount int64

The maximum number of payouts in a month.

formatint32

TermsOfService TermsOfServiceV1optional

AcceptedDate Time

The datetime of when the terms of service were accepted, in ISO 8601 format.

formatdate-time

AgreementType TermsOfServiceV1AgreementType

The type or version of the agreement accepted. Use embedded unless your platform was specifically enabled for direct agreements.

One of the following:

const TermsOfServiceV1AgreementTypeEmbedded TermsOfServiceV1AgreementType = "embedded"

const TermsOfServiceV1AgreementTypeDirect TermsOfServiceV1AgreementType = "direct"

AgreementURL string

The URL where the full text of the accepted agreement can be found.

AcceptedIP stringoptional

The IP address from which the terms of service were accepted.

AcceptedUserAgent stringoptional

The user agent string of the browser or application used to accept the terms.

UpdatedAt Timeoptional

Timestamp of the most recent update to the account.

formatdate-time

Meta ResponseMetadata

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

APIRequestID string

Unique identifier for this API request, useful for troubleshooting.

formatuuid

APIRequestTimestamp Time

Timestamp for this API request, useful for troubleshooting.

formatdate-time

ResponseType AccountV1ResponseType

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:

const AccountV1ResponseTypeObject AccountV1ResponseType = "object"

const AccountV1ResponseTypeArray AccountV1ResponseType = "array"

const AccountV1ResponseTypeError AccountV1ResponseType = "error"

const AccountV1ResponseTypeNone AccountV1ResponseType = "none"

type AddressV1 struct{…}

The address object is optional. If provided, it must be a valid address.

City string

City, district, suburb, town, or village.

Line1 string

Primary address line (e.g., street, PO Box).

PostalCode string

Postal or ZIP code.

State string

Two-letter state code.

Country stringoptional

The country of the address, in ISO 3166-1 alpha-2 format.

Line2 stringoptional

Secondary address line (e.g., apartment, suite, unit, or building).

type BusinessProfileV1 struct{…}

Name string

The operating or trade name of the business.

Website string

URL of the business's primary marketing website.

formaturi

Address AddressV1optional

The address object is optional. If provided, it must be a valid address.

City string

City, district, suburb, town, or village.

Line1 string

Primary address line (e.g., street, PO Box).

PostalCode string

Postal or ZIP code.

State string

Two-letter state code.

Country stringoptional

The country of the address, in ISO 3166-1 alpha-2 format.

Line2 stringoptional

Secondary address line (e.g., apartment, suite, unit, or building).

Description stringoptional

A brief description of the business and its products or services.

Industry IndustryV1optional

Category stringoptional

The general category of the industry. Required if not providing MCC.

Mcc stringoptional

The Merchant Category Code (MCC) that best describes the business. Optional.

Sector stringoptional

The specific sector within the industry category. Required if not providing MCC.

LegalName stringoptional

The official registered name of the business.

Phone stringoptional

The primary contact phone number for the business.

SupportChannels SupportChannelsV1optional

Email stringoptional

The email address for customer support inquiries.

formatemail

Phone stringoptional

The phone number for customer support.

URL stringoptional

The URL of the business's customer support page or contact form.

formaturi

TaxID stringoptional

The business's tax identification number (e.g., EIN in the US).

UseCase stringoptional

A description of how the business intends to use Straddle's services.

type CapabilityV1 struct{…}

CapabilityStatus CapabilityV1CapabilityStatus

One of the following:

const CapabilityV1CapabilityStatusActive CapabilityV1CapabilityStatus = "active"

const CapabilityV1CapabilityStatusInactive CapabilityV1CapabilityStatus = "inactive"

type IndustryV1 struct{…}

Category stringoptional

The general category of the industry. Required if not providing MCC.

Mcc stringoptional

The Merchant Category Code (MCC) that best describes the business. Optional.

Sector stringoptional

The specific sector within the industry category. Required if not providing MCC.

type SupportChannelsV1 struct{…}

Email stringoptional

The email address for customer support inquiries.

formatemail

Phone stringoptional

The phone number for customer support.

URL stringoptional

The URL of the business's customer support page or contact form.

formaturi

type TermsOfServiceV1 struct{…}

AcceptedDate Time

The datetime of when the terms of service were accepted, in ISO 8601 format.

formatdate-time

AgreementType TermsOfServiceV1AgreementType

The type or version of the agreement accepted. Use embedded unless your platform was specifically enabled for direct agreements.

One of the following:

const TermsOfServiceV1AgreementTypeEmbedded TermsOfServiceV1AgreementType = "embedded"

const TermsOfServiceV1AgreementTypeDirect TermsOfServiceV1AgreementType = "direct"

AgreementURL string

The URL where the full text of the accepted agreement can be found.

AcceptedIP stringoptional

The IP address from which the terms of service were accepted.

AcceptedUserAgent stringoptional

The user agent string of the browser or application used to accept the terms.

AccountsCapability Requests

Capabilities enable specific features and services for an Account. Use capability requests to unlock higher processing limits, new payment types, or additional platform features as your users' businesses grow. Track approval status and manage documentation requirements through a single interface.

Request a capability

client.Embed.Accounts.CapabilityRequests.New(ctx, accountID, params) (*CapabilityRequestPagedV1, error)

POST/v1/accounts/{account_id}/capability_requests

List capability requests

client.Embed.Accounts.CapabilityRequests.List(ctx, accountID, params) (*PageNumberSchema[CapabilityRequestPagedV1Data], error)

GET/v1/accounts/{account_id}/capability_requests

ModelsExpand Collapse

type CapabilityRequestPagedV1 struct{…}

Data []CapabilityRequestPagedV1Data

ID string

Unique identifier for the capability request.

formatuuid

AccountID string

The unique identifier of the account associated with this capability request.

formatuuid

Category string

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.

One of the following:

const CapabilityRequestPagedV1DataCategoryPaymentType CapabilityRequestPagedV1DataCategory = "payment_type"

const CapabilityRequestPagedV1DataCategoryCustomerType CapabilityRequestPagedV1DataCategory = "customer_type"

const CapabilityRequestPagedV1DataCategoryConsentType CapabilityRequestPagedV1DataCategory = "consent_type"

CreatedAt Time

Timestamp of when the capability request was created.

formatdate-time

Enable bool

Whether this capability request is to enable or disable the capability.

Status string

The current status of the capability request.

One of the following:

const CapabilityRequestPagedV1DataStatusActive CapabilityRequestPagedV1DataStatus = "active"

const CapabilityRequestPagedV1DataStatusInactive CapabilityRequestPagedV1DataStatus = "inactive"

const CapabilityRequestPagedV1DataStatusInReview CapabilityRequestPagedV1DataStatus = "in_review"

const CapabilityRequestPagedV1DataStatusRejected CapabilityRequestPagedV1DataStatus = "rejected"

const CapabilityRequestPagedV1DataStatusApproved CapabilityRequestPagedV1DataStatus = "approved"

const CapabilityRequestPagedV1DataStatusReviewing CapabilityRequestPagedV1DataStatus = "reviewing"

Type string

The specific type of capability being requested within the category.

One of the following:

const CapabilityRequestPagedV1DataTypeCharges CapabilityRequestPagedV1DataType = "charges"

const CapabilityRequestPagedV1DataTypePayouts CapabilityRequestPagedV1DataType = "payouts"

const CapabilityRequestPagedV1DataTypeIndividuals CapabilityRequestPagedV1DataType = "individuals"

const CapabilityRequestPagedV1DataTypeBusinesses CapabilityRequestPagedV1DataType = "businesses"

const CapabilityRequestPagedV1DataTypeSignedAgreement CapabilityRequestPagedV1DataType = "signed_agreement"

const CapabilityRequestPagedV1DataTypeInternet CapabilityRequestPagedV1DataType = "internet"

UpdatedAt Time

Timestamp of the most recent update to the capability request.

formatdate-time

Settings map[string, any]optional

Any specific settings or configurations related to the requested capability.

Meta PagedResponseMetadata

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

APIRequestID string

Unique identifier for this API request, useful for troubleshooting.

formatuuid

APIRequestTimestamp Time

Timestamp for this API request, useful for troubleshooting.

formatdate-time

MaxPageSize int64

Maximum allowed page size for this endpoint.

formatint32

PageNumber int64

Page number for paginated results.

formatint32

PageSize int64

Number of items per page in this response.

formatint32

SortBy string

The field that the results were sorted by.

SortOrder PagedResponseMetadataSortOrder

One of the following:

const PagedResponseMetadataSortOrderAsc PagedResponseMetadataSortOrder = "asc"

const PagedResponseMetadataSortOrderDesc PagedResponseMetadataSortOrder = "desc"

TotalItems int64

Total number of items returned in this response.

formatint32

TotalPages int64

The number of pages available.

formatint32

ResponseType CapabilityRequestPagedV1ResponseType

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:

const CapabilityRequestPagedV1ResponseTypeObject CapabilityRequestPagedV1ResponseType = "object"

const CapabilityRequestPagedV1ResponseTypeArray CapabilityRequestPagedV1ResponseType = "array"

const CapabilityRequestPagedV1ResponseTypeError CapabilityRequestPagedV1ResponseType = "error"

const CapabilityRequestPagedV1ResponseTypeNone CapabilityRequestPagedV1ResponseType = "none"