FrameSDK/com.framepayments.framesdk.accounts/AccountEndpoints

AccountEndpoints

sealed class AccountEndpoints : FrameNetworkingEndpoints

Sealed class defining all account API endpoints and their routing metadata.

Inheritors

DeleteAccountWith

RestrictAccount

UnrestrictAccount

GetPlaidLinkToken

CreatePhoneVerification

ConfirmPhoneVerification

Types

ConfirmPhoneVerification

data class ConfirmPhoneVerification(val accountId: String, val verificationId: String) : AccountEndpoints

Endpoint for confirming a phone verification with a one-time code.

object CreateAccount : AccountEndpoints

Endpoint for creating a new account.

CreatePhoneVerification

data class CreatePhoneVerification(val accountId: String) : AccountEndpoints

Endpoint for initiating a phone verification for an account.

DeleteAccountWith

data class DeleteAccountWith(val accountId: String) : AccountEndpoints

Endpoint for deleting an account by ID.

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.

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.

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.

data class UpdateAccount(val accountId: String) : AccountEndpoints

Endpoint for updating an existing account.

Properties

open override val endpointURL: String

The fully qualified URL string for this endpoint.

open override val httpMethod: String

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

open override val queryItems: List<QueryItem>?

Optional query-string parameters appended to endpointURL.