Mandate Cancellation Request

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/citi/main/json-schema/citi-mandate-cancellation-request-schema.json",
  "title": "Mandate Cancellation Request",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/citi-mandate-api-openapi.yml#/components/schemas/Mandate-Cancellation-Request",
  "type": "object",
  "required": [
    "mandate"
  ],
  "properties": {
    "mandate": {
      "$ref": "#/$defs/Mandate-Cancellation-Request-Mandate"
    }
  },
  "$defs": {
    "Mandate-Cancellation-Request-Mandate": {
      "type": "object",
      "title": "Mandate",
      "required": [
        "reason_code",
        "request_id",
        "country_code"
      ],
      "properties": {
        "reason_code": {
          "description": "Reason due to which mandate is being cancelled \n- For Brazil this is mandatory parameter with the allowed values: SLCR - Cancellation requested by receiver, SJUD - Cancellation by court order, OTHS - Other reasons",
          "type": "string",
          "enum": [
            "SLCR",
            "SJUD",
            "OTHS"
          ],
          "title": "reason_code"
        },
        "id": {
          "description": "Unique ID to identify the mandate \n- For Brazil this parameter is mandatory with min & max length 29 with format RRxxxxxxxxyyyyMMddBRkkkkkkkkk received during mandate initiation",
          "minLength": 1,
          "maxLength": 35,
          "type": "string",
          "title": "id"
        },
        "request_id": {
          "description": "Unique ID assigned to identify request made on the mandate \n- For Brazil this parameter is mandatory with max length 29 in format 'IC33479023yyyyMMddkkkkkkkkkkk', where First two characters will be 'IC', '33479023' is merchant bank code, 'yyyyMMdd' is mandate cancellation date, 'kkkkkkkkkkk' are unique alphanumeric characters",
          "minLength": 1,
          "maxLength": 35,
          "type": "string",
          "title": "request_id"
        },
        "country_code": {
          "description": "Country code",
          "enum": [
            "BR"
          ],
          "type": "string",
          "title": "country_code"
        }
      }
    }
  }
}