FrameSDK/com.framepayments.framesdk.accounts/AccountEndpoints/GetAccounts

GetAccounts

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.

Constructors

Link copied to clipboard
constructor(status: AccountObjects.AccountStatus? = null, type: AccountObjects.AccountType? = null, externalId: String? = null, includeDisabled: Boolean = false, page: Int? = null, perPage: Int? = null)

Properties

Link copied to clipboard
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.

Link copied to clipboard
open override val endpointURL: String

The fully qualified URL string for this endpoint.

Link copied to clipboard
val externalId: String? = null
Link copied to clipboard
open override val httpMethod: String

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

Link copied to clipboard
val includeDisabled: Boolean = false
Link copied to clipboard
val page: Int? = null
Link copied to clipboard
val perPage: Int? = null
Link copied to clipboard
open override val queryItems: List<QueryItem>?

Optional query-string parameters appended to endpointURL.

Link copied to clipboard
Link copied to clipboard