FrameSDK/com.framepayments.framesdk.capabilities/CapabilityObjects

CapabilityObjects

Namespace for data models representing account capability resources.

Types

data class Capability(val id: String?, val object: String?, val name: String?, val accountId: String?, val status: String?, val disabledReason: String? = null, val ineligibleReason: String? = null, val errors: List<CapabilityObjects.CapabilityError>? = null, val currentlyDue: List<String>? = null, val created: String?, val updated: String?, val disabled: Boolean? = null)

Represents a single capability associated with a merchant account.

CapabilityError

data class CapabilityError(val id: String?, val object: String? = null, val code: String? = null, val message: String? = null, val requirementId: String? = null)

A server-derived conclusion about why a capability has not been granted.

CapabilityRequirement

data class CapabilityRequirement(val id: String?, val object: String?, val type: String?, val status: String?, val source: String? = null)

Describes a single outstanding requirement that must be satisfied before a capability can be enabled.

CapabilityRequirementKey

object CapabilityRequirementKey

currently_due keys the onboarding flow acts on.

CapabilityStatus

enum CapabilityStatus : Enum<CapabilityObjects.CapabilityStatus>

Mapped from the wire string; an unrecognized value degrades to UNKNOWN.

Properties

actionableRequirements

val CapabilityObjects.Capability.actionableRequirements: List<String>

currently_due keys the applicant can still resolve; a disabled capability publishes dead keys.

capabilityStatus

val CapabilityObjects.Capability.capabilityStatus: CapabilityObjects.CapabilityStatus

This capability's status, degrading an unrecognized value to CapabilityStatus.UNKNOWN.

hasActionableRequirements

val CapabilityObjects.Capability.hasActionableRequirements: Boolean

Whether work listed against this capability can still move it forward. The server blanks currently_due only for ineligible, so a disabled capability still publishes dead keys.

isOutstanding

val CapabilityObjects.Capability.isOutstanding: Boolean

Mirrors the server's Capability#blocks_activation?.