Block And Filters Create Request

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/citi/main/json-schema/citi-blocks-and-filters-create-request-schema.json",
  "title": "Block And Filters Create Request",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/citi-blocks-filters-api-openapi.yml#/components/schemas/Blocks-And-Filters-Create-Request",
  "allOf": [
    {
      "$ref": "#/$defs/Block-Details"
    },
    {
      "type": "object"
    },
    {
      "required": [
        "account_number",
        "payment_method",
        "type",
        "start_date"
      ],
      "properties": {
        "filters": {
          "type": "array",
          "maxItems": 1,
          "items": {
            "$ref": "#/$defs/Filter-Request"
          }
        }
      }
    }
  ],
  "$defs": {
    "Block-Details": {
      "title": "Block Details",
      "allOf": [
        {
          "$ref": "#/$defs/Block-Update-Detail"
        },
        {
          "type": "object",
          "properties": {
            "account_number": {
              "description": "Merchant's VA Wallet number",
              "maxLength": 35,
              "minLength": 1,
              "type": "string",
              "title": "account_number"
            },
            "payment_method": {
              "description": "Method specified by the merchant for the transaction",
              "type": "string",
              "enum": [
                "ACH"
              ],
              "title": "payment_method"
            }
          }
        }
      ]
    },
    "Block-Update-Detail": {
      "title": "Block Update Detail",
      "type": "object",
      "properties": {
        "type": {
          "description": "Type of block",
          "type": "string",
          "enum": [
            "CREDIT",
            "DEBIT",
            "CREDIT_AND_DEBIT"
          ],
          "title": "type"
        },
        "start_date": {
          "description": "Effective start date for the block in YYYY-MM-DD format",
          "type": "string",
          "format": "date",
          "title": "start_date"
        }
      }
    },
    "Filter-Details": {
      "title": "Filter Details",
      "type": "object",
      "properties": {
        "start_date": {
          "description": "Effective start date for the filter in YYYY-MM-DD format (should be equal to or greater than current date)",
          "type": "string",
          "format": "date",
          "title": "start_date"
        },
        "end_date": {
          "description": "Effective end date for the filter in YYYY-MM-DD format (should be equal to or greater than start date)",
          "type": "string",
          "format": "date",
          "title": "end_date"
        },
        "amount_type": {
          "description": "Indicates if the amount is fixed or max",
          "type": "string",
          "enum": [
            "FIXED",
            "MAX"
          ],
          "title": "amount_type"
        },
        "amount": {
          "description": "Amount to be filtered from the customer's account",
          "minimum": 0.01,
          "maximum": 99999999.99,
          "type": "number",
          "title": "amount"
        },
        "sender_name": {
          "description": "Sender name of the sender party on which filter would be applied",
          "maxLength": 100,
          "minLength": 1,
          "type": "string",
          "title": "sender_name"
        }
      }
    },
    "Filter-Request": {
      "allOf": [
        {
          "$ref": "#/$defs/Filter-Details"
        },
        {
          "type": "object"
        },
        {
          "required": [
            "sender_id",
            "start_date",
            "end_date",
            "amount_type",
            "amount"
          ],
          "properties": {
            "sender_id": {
              "description": "Sender identifier of the sender party on which filter would be applied",
              "pattern": "^[A-Za-z0-9]{0,10}$",
              "type": "string",
              "title": "sender_id"
            },
            "sender_name": {
              "description": "Sender name of the sender party on which filter would be applied",
              "maxLength": 100,
              "minLength": 1,
              "type": "string",
              "title": "sender_name"
            }
          }
        }
      ]
    }
  }
}