Mandate

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/upvest/refs/heads/main/json-schema/investment-api-mandate-schema.json",
  "title": "Mandate",
  "description": "A direct debit mandate authorizing fund collection.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "The mandate identifier.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "account_group_id": {
      "type": "string",
      "format": "uuid",
      "description": "The account group the mandate belongs to.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "iban": {
      "type": "string",
      "description": "The IBAN of the bank account.",
      "example": "example-value"
    },
    "status": {
      "type": "string",
      "enum": [
        "ACTIVE",
        "REVOKED"
      ],
      "description": "The mandate status.",
      "example": "ACTIVE"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the mandate was created.",
      "example": "2025-03-15T14:30:00Z"
    }
  }
}