Interface AccountsApiListConnectedAccountsRequest

Request parameters for listConnectedAccounts operation in AccountsApi.

Export

AccountsApiListConnectedAccountsRequest

Hierarchy

  • AccountsApiListConnectedAccountsRequest

Properties

limit? metadata? offset? partner_application_status? processing_capabilities? q? sort? status? tilled_account type?

Properties

Optional Readonly limit

limit?: number

The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

Memberof

AccountsApiListConnectedAccounts

Optional Readonly metadata

metadata?: {
    [key: string]: string;
}

`metadata` key-value pairs to filter by. Only exact matches on the key-value pair(s) will be returned. Example: `?metadata[internal_customer_id]=7cb1159d-875e-47ae-a309-319fa7ff395b`.

Memberof

AccountsApiListConnectedAccounts

Type declaration

  • [key: string]: string

Optional Readonly offset

offset?: number

The (zero-based) offset of the first item in the collection to return.

Memberof

AccountsApiListConnectedAccounts

Optional Readonly partner_application_status

partner_application_status?: ListConnectedAccountsPartnerApplicationStatus[]

Only return Connected Partner Accounts whose partner application status is included in this array. Examples: `/v1/accounts/connected?partner_application_status=created,started` and `/v1/accounts/connected?partner_application_status=submitted`.

Memberof

AccountsApiListConnectedAccounts

Optional Readonly processing_capabilities

processing_capabilities?: ListConnectedAccountsProcessingCapabilities[]

Only return Connected Partner Accounts who have an active capability with the specified processing capabilities. Examples: `/v1/accounts/connected?processing_capabilities=card,debit` and `/v1/accounts/connected?processing_capabilities=card`.

Memberof

AccountsApiListConnectedAccounts

Optional Readonly q

q?: string

The partial search of text fields. Supports searching by `account.name`, `account.business_profile.legal_name`, `account.id`, `account.email`, `user.name`, `user.email`

Memberof

AccountsApiListConnectedAccounts

Optional Readonly sort

sort?: string

The sort parameters, value:direction. Possible values: `name`, `created_at`. Possible directions: `asc`, `desc` For example `name:asc`. Default: `created_at:desc`

Memberof

AccountsApiListConnectedAccounts

Optional Readonly status

status?: ListConnectedAccountsStatus[]

Only return Connected Accounts whose status is included in this array. Examples: `/v1/accounts/connected?status=active,partially_active` and `/v1/accounts/connected?status=account_review`.

Memberof

AccountsApiListConnectedAccounts

Readonly tilled_account

tilled_account: string

The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

Memberof

AccountsApiListConnectedAccounts

Optional Readonly type

type?: ListConnectedAccountsType

Only return Connected Accounts where the type matches the specified value.

Memberof

AccountsApiListConnectedAccounts

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc