List accounts

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

GET/v1/accounts

Returns a list of accounts associated with your Straddle platform integration. The accounts are returned sorted by creation date, with the most recently created accounts appearing first. This endpoint supports advanced sorting and filtering options.

ParametersExpand Collapse

params EmbedAccountListParams

PageNumber param.Field[int64]optional

Query param: Results page number. Starts at page 1. Default value: 1

formatint32

PageSize param.Field[int64]optional

Query param: Page size. Default value: 100. Max value: 1000

formatint32

SearchText param.Field[string]optional

Query param

SortBy param.Field[string]optional

Query param: Sort By. Default value: 'id'.

SortOrder param.Field[EmbedAccountListParamsSortOrder]optional

Query param: Sort Order. Default value: 'asc'.

const EmbedAccountListParamsSortOrderAsc EmbedAccountListParamsSortOrder = "asc"

const EmbedAccountListParamsSortOrderDesc EmbedAccountListParamsSortOrder = "desc"

Status param.Field[EmbedAccountListParamsStatus]optional

Query param

const EmbedAccountListParamsStatusCreated EmbedAccountListParamsStatus = "created"

const EmbedAccountListParamsStatusOnboarding EmbedAccountListParamsStatus = "onboarding"

const EmbedAccountListParamsStatusActive EmbedAccountListParamsStatus = "active"

const EmbedAccountListParamsStatusRejected EmbedAccountListParamsStatus = "rejected"

const EmbedAccountListParamsStatusInactive EmbedAccountListParamsStatus = "inactive"

Type param.Field[EmbedAccountListParamsType]optional

Query param

const EmbedAccountListParamsTypeBusiness EmbedAccountListParamsType = "business"

CorrelationID param.Field[string]optional

Header param: Optional client generated identifier to trace and debug a series of requests.

RequestID param.Field[string]optional

Header param: Optional client generated identifier to trace and debug a request.

ReturnsExpand Collapse

type AccountPagedV1Data struct{…}

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.