Moov · Schema

Capability

A feature or permission that enables specific financial operations on a Moov account, such as the ability to send or receive funds.

BankingEmbedded FinanceFinancial InfrastructureMoney MovementPaymentsTransfers

Properties

Name Type Description
capability string Identifier for the capability type (e.g., "transfers.push", "collect-funds").
accountID string The account this capability belongs to.
status string Current activation status of the capability.
requirements array List of requirements that must be fulfilled to activate this capability.
disabledReason string Explanation of why the capability is disabled, if applicable.
createdOn string ISO 8601 timestamp when the capability was created.
updatedOn string ISO 8601 timestamp when the capability was last updated.
View JSON Schema on GitHub

JSON Schema

moov-capability-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Capability",
  "title": "Capability",
  "type": "object",
  "description": "A feature or permission that enables specific financial operations on a Moov account, such as the ability to send or receive funds.",
  "properties": {
    "capability": {
      "type": "string",
      "description": "Identifier for the capability type (e.g., \"transfers.push\", \"collect-funds\")."
    },
    "accountID": {
      "type": "string",
      "format": "uuid",
      "description": "The account this capability belongs to."
    },
    "status": {
      "type": "string",
      "description": "Current activation status of the capability.",
      "enum": [
        "enabled",
        "disabled",
        "pending",
        "in-review"
      ]
    },
    "requirements": {
      "type": "array",
      "description": "List of requirements that must be fulfilled to activate this capability.",
      "items": {
        "$ref": "#/components/schemas/CapabilityRequirement"
      }
    },
    "disabledReason": {
      "type": "string",
      "description": "Explanation of why the capability is disabled, if applicable."
    },
    "createdOn": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the capability was created."
    },
    "updatedOn": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the capability was last updated."
    }
  }
}