data class GetAccounts(val status: AccountObjects.AccountStatus? = null, val type: AccountObjects.AccountType? = null, val externalId: String? = null, val includeDisabled: Boolean = false, val page: Int? = null, val perPage: Int? = null) : AccountEndpoints

Endpoint for listing accounts with optional filters.

GetAccountWith

data class GetAccountWith(val accountId: String) : AccountEndpoints

Endpoint for retrieving a single account by ID.

GetPlaidLinkToken

data class GetPlaidLinkToken(val accountId: String, val androidPackageName: String) : AccountEndpoints

Endpoint for obtaining a Plaid Link token for an account.

RestrictAccount

data class RestrictAccount(val accountId: String) : AccountEndpoints

Endpoint for restricting an account from transacting.

SearchAccounts

data class SearchAccounts(val email: String? = null, val externalId: String? = null, val type: AccountObjects.AccountType? = null, val status: AccountObjects.AccountStatus? = null, val createdBefore: String? = null, val createdAfter: String? = null) : AccountEndpoints

Endpoint for searching accounts by criteria.

UnrestrictAccount

data class UnrestrictAccount(val accountId: String) : AccountEndpoints

Endpoint for removing a restriction from an account.

UpdateAccount

data class UpdateAccount(val accountId: String) : AccountEndpoints

Endpoint for updating an existing account.

Properties

additionalHeaders

open val additionalHeaders: Map<String, String>

Optional extra HTTP headers to attach to the request (e.g. Accept: application/json). Defaults to empty. Applied after the standard Frame Authorization/User-Agent headers but before Content-Type (set on POST/PATCH), so an entry may override the former but not the latter. Prefer supplemental headers like Accept; don't rely on this to set auth headers.

endpointURL

open override val endpointURL: String

The fully qualified URL string for this endpoint.

httpMethod

open override val httpMethod: String

HTTP method, e.g. "GET", "POST", "DELETE".

queryItems

open override val queryItems: List<QueryItem>?

Optional query-string parameters appended to endpointURL.