SubscriptionReqType

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/citi/main/json-schema/citi-subscription-req-type-schema.json",
  "title": "SubscriptionReqType",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/citi-account-notification-api-openapi.yml#/components/schemas/SubscriptionReqType",
  "required": [
    "accountIdentification",
    "branchIdentification",
    "creditDebitIndicator",
    "format",
    "requestType"
  ],
  "properties": {
    "requestType": {
      "type": "string",
      "description": "Specifies the action to perform on the specified subscription. You can create, modify, or delete subscriptions, based on the request type.",
      "enum": [
        "CREATE",
        "MODIFY",
        "DELETE"
      ]
    },
    "format": {
      "type": "string",
      "description": "Specifies the format to use for notifications - XML or JSON.",
      "enum": [
        "XML",
        "JSON"
      ]
    },
    "creditDebitIndicator": {
      "type": "string",
      "description": "The type of transaction for which you want notifications:\n\n* Credit \n* Debit \n* Both",
      "enum": [
        "DBIT",
        "CRDT",
        "BOTH"
      ]
    },
    "accountIdentification": {
      "minLength": 1,
      "maxLength": 34,
      "description": "The account number associated with the subscription."
    },
    "branchIdentification": {
      "type": "string",
      "description": "Citi branch ID associated with the account.",
      "minLength": 1,
      "maxLength": 35
    },
    "fromAmount": {
      "type": "string",
      "description": "The minimum amount of a transaction to trigger a notification. Notifications will not be sent for transaction amounts below this threshold."
    },
    "toAmount": {
      "type": "string",
      "description": "The maximium amount of a transaction to trigger a notification. Notifications will not be sent for transaction amounts above this limit."
    }
  }
}