FrameSDK/com.framepayments.framesdk.capabilities/CapabilityObjects/Capability

Capability

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.

Constructors

Link copied to clipboard
constructor(id: String?, object: String?, name: String?, accountId: String?, status: String?, disabledReason: String? = null, ineligibleReason: String? = null, errors: List<CapabilityObjects.CapabilityError>? = null, currentlyDue: List<String>? = null, created: String?, updated: String?, disabled: Boolean? = null)

Properties

Link copied to clipboard
@SerializedName(value = "account_id")
val accountId: String?

The ID of the merchant account that owns this capability.

Link copied to clipboard
val CapabilityObjects.Capability.actionableRequirements: List<String>

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

Link copied to clipboard
val CapabilityObjects.Capability.capabilityStatus: CapabilityObjects.CapabilityStatus

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

Link copied to clipboard
val created: String?

ISO 8601 timestamp when the capability was created.

Link copied to clipboard
@SerializedName(value = "currently_due")
val currentlyDue: List<String>? = null

List of requirement keys that must be addressed to activate or maintain the capability.

Link copied to clipboard
val disabled: Boolean? = null

Whether the capability has been explicitly disabled.

Link copied to clipboard
@SerializedName(value = "disabled_reason")
val disabledReason: String? = null

Human-readable explanation of why the capability is disabled, if applicable.

Link copied to clipboard
val errors: List<CapabilityObjects.CapabilityError>? = null

Why this capability has not been granted, derived from the latest concluded identity-verification run.

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

Link copied to clipboard
val id: String?

Unique identifier for the capability.

Link copied to clipboard
@SerializedName(value = "ineligible_reason")
val ineligibleReason: String? = null

Reason the account is ineligible to hold this capability, if applicable.

Link copied to clipboard
val CapabilityObjects.Capability.isOutstanding: Boolean

Mirrors the server's Capability#blocks_activation?.

Link copied to clipboard
val name: String?

The name identifier of the capability (e.g. "card_payments").

Link copied to clipboard
val object: String?

The object type string returned by the API (e.g. "capability").

Link copied to clipboard
val status: String?

Current status of the capability (e.g. "active", "inactive", "pending").

Link copied to clipboard
val updated: String?

ISO 8601 timestamp when the capability was last updated.