Mandate-Inquiry-Response

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/citi/main/json-schema/citi-mandate-inquiry-response-schema.json",
  "title": "Mandate-Inquiry-Response",
  "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-Inquiry-Response",
  "type": "array",
  "items": {
    "$ref": "#/$defs/Mandate-Response"
  },
  "$defs": {
    "Customer-Get-Status": {
      "type": "object",
      "title": "Customer Notification",
      "properties": {
        "account": {
          "title": "customer account",
          "description": "Account Details",
          "properties": {
            "number": {
              "description": "Customer's bank account number \n- This parameter is optional for Brazil with max length 20",
              "minLength": 1,
              "maxLength": 35,
              "type": "string",
              "title": "number"
            },
            "bank_id": {
              "description": "Customer bank's network identification \n- This parameter is optional for Brazil with max length 8",
              "minLength": 1,
              "maxLength": 35,
              "type": "string",
              "title": "bank_id"
            }
          }
        },
        "private_id": {
          "description": "Customer Tax or Legal Entity Id \n- This parameter is optional for Brazil with max length 11 or 14",
          "minLength": 1,
          "maxLength": 35,
          "type": "string",
          "title": "private_id"
        },
        "address": {
          "$ref": "#/$defs/Mandate-Address"
        }
      }
    },
    "Mandate-Address": {
      "type": "object",
      "description": "Mandate Address",
      "title": "Mandate Address",
      "properties": {
        "postal_code": {
          "description": "Postal code \n- This parameter is optional for Brazil with max length 7 for customer object",
          "minLength": 1,
          "maxLength": 35,
          "type": "string",
          "title": "postal_code"
        }
      }
    },
    "Mandate-Get-Status": {
      "type": "object",
      "title": "Mandate Notification",
      "properties": {
        "id": {
          "description": "Unique Id given during initiation to identify the mandate \n- This parameter is mandatory for Brazil with max length 29",
          "minLength": 1,
          "maxLength": 35,
          "type": "string",
          "title": "id"
        },
        "request_id": {
          "description": "Unique Id given during initiation to identify request made on the mandate \n- This parameter is mandatory for Brazil with max lenght 29",
          "minLength": 1,
          "maxLength": 35,
          "type": "string",
          "title": "request_id"
        },
        "status": {
          "description": "Mandate Current Status \n- This parameter is mandatory for Brazil",
          "type": "string",
          "enum": [
            "PENDING_AUTHORIZATION",
            "PENDING_ACKNOWLEDGEMENT",
            "ACTIVE",
            "EXPIRED",
            "REJECTED",
            "SUSPENDED",
            "CANCELLED"
          ],
          "title": "status"
        },
        "country_code": {
          "description": "Mandate country \n- This parameter is mandatory for Brazil",
          "enum": [
            "US",
            "BR",
            "GB",
            "IN"
          ],
          "type": "string",
          "title": "country_code"
        },
        "frequency": {
          "description": "Frequency in which payments are to be processed YEAR = Annual, MNTH = Monthly, QURT = Quarterly, MIAN = Semiannual, WEEK = Weekly, DAIL = Daily, ADHO = Ad hoc, INDA = Intraday, FRTN = Fortnightly & OOFF = One Off \n- This parameter is mandatory for Brazil",
          "type": "string",
          "enum": [
            "YEAR",
            "MNTH",
            "QURT",
            "MIAN",
            "WEEK",
            "DAIL",
            "ADHO",
            "INDA",
            "FRTN",
            "OOFF"
          ],
          "title": "frequency"
        },
        "count_per_period": {
          "description": "Number of instructions to be created and processed during the specified period \n- This parameter is mandatory for Brazil",
          "type": "number",
          "minimum": 1,
          "maximum": 99,
          "title": "count_per_period"
        },
        "auto_debit": {
          "description": "Specifies whether the direct debit instructions should be automatically re-submitted periodically \n- This parameter is mandatory for Brazil",
          "type": "boolean",
          "title": "auto_debit"
        },
        "expiry_date_time": {
          "description": "Date & Time when the mandate request will get expired (format-YYYYMMDDYhh:mm:ss.000Z where time should be in UTC) \n- This is mandatory parameter for Brazil",
          "type": "string",
          "format": "date-time",
          "title": "expiry_date_time"
        },
        "start_date": {
          "description": "Effective start date for the payment in YYYY-MM-DD format \n- This parameter is mandatory for Brazil",
          "type": "string",
          "format": "date",
          "title": "start_date"
        },
        "end_date": {
          "description": "Effective end date for the payment in YYYY-MM-DD format \n- This parameter is optional for Brazil",
          "type": "string",
          "format": "date",
          "title": "end_date"
        },
        "nature": {
          "description": "Mandate nature \n- This parameter is mandatory for Brazil",
          "type": "string",
          "enum": [
            "ELECTRONIC",
            "QRC",
            "PAPER"
          ],
          "title": "nature"
        },
        "reference_id": {
          "description": "Reference Id given by merchant such as contract/document number \n- This parameter is optional for Brazil with max length 35",
          "minLength": 1,
          "maxLength": 35,
          "type": "string",
          "title": "reference_id"
        },
        "additional_info": {
          "maxLength": 140,
          "minLength": 1,
          "type": "string",
          "description": "Additional information provided by payor \n- This parameter is mandatory for Brazil with max length 35",
          "title": "additional_info"
        },
        "currency_code": {
          "description": "Currency Code \n- This parameter is mandatory for Brazil",
          "enum": [
            "BRL"
          ],
          "type": "string",
          "title": "currency_code"
        },
        "amount": {
          "description": "Fixed amount to be collected from the customer's account \n- This parameter is optional for Brazil with max length 18 digits including 2 decimals",
          "minimum": 0.01,
          "maximum": 1000000000000000000,
          "type": "number",
          "title": "amount"
        },
        "max_amount": {
          "description": "Max amount to be collected from customer's account \n- This parameter is optional for Brazil with max length 18 digits including 2 decimals",
          "minimum": 0.01,
          "maximum": 1000000000000000000,
          "type": "number",
          "title": "max_amount"
        },
        "cancellation_requested_by": {
          "description": "Party who initiated mandate cancelation \n- This parameter is optional for Brazil with max length 15",
          "type": "string",
          "maxLength": 35,
          "minLength": 1,
          "title": "cancellation_requested_by"
        },
        "reason_code": {
          "description": "Reason Code for rejection/cancellation \n- This parameter is optional for Brazil with max length 4",
          "minLength": 1,
          "maxLength": 35,
          "type": "string",
          "title": "reason_code"
        },
        "description": {
          "description": "Description against the status or/and reason code \n- This parameter is optional for Brazil with max length 105",
          "minLength": 1,
          "maxLength": 105,
          "type": "string",
          "title": "description"
        },
        "audit_trail": {
          "description": "Series of events along with date & time stamp on the mandate \n- This parameter is mandatory for Brazil",
          "minLength": 1,
          "maxLength": 105,
          "type": "string",
          "title": "audit_trail"
        },
        "agreement_number": {
          "description": "Agreement number between merchant and customer \n- This parameter is optional for Brazil",
          "minLength": 1,
          "maxLength": 60,
          "type": "string",
          "title": "agreement_number"
        },
        "qr_string": {
          "type": "string",
          "maxLength": 512,
          "description": "Dynamic QR Code based on the merchant payload request \n- This parameter is optional for Brazil",
          "title": "qr_string"
        }
      }
    },
    "Mandate-Response": {
      "type": "object",
      "title": "Mandate Inquiry Notification",
      "properties": {
        "mandate": {
          "$ref": "#/$defs/Mandate-Get-Status"
        },
        "customer": {
          "$ref": "#/$defs/Customer-Get-Status"
        },
        "merchant": {
          "$ref": "#/$defs/Merchant-Get-Status"
        },
        "sender": {
          "$ref": "#/$defs/Sender-Get-Status"
        }
      }
    },
    "Merchant-Get-Status": {
      "type": "object",
      "title": "Merchant Notification",
      "properties": {
        "name": {
          "description": "Merchant Name \n- This parameter is mandatory for Brazil with max length 140",
          "minLength": 1,
          "maxLength": 140,
          "type": "string",
          "title": "name"
        },
        "private_id": {
          "description": "Merchant Tax or Legal Entity Id \n- This parameter is mandatory for Brazil with max length 11 or 14",
          "minLength": 1,
          "maxLength": 35,
          "type": "string",
          "title": "private_id"
        },
        "account": {
          "title": "merchant account",
          "description": "Account Details",
          "properties": {
            "bank_id": {
              "description": "Merchant bank's network identification \n- This parameter is mandatory for Brazil with max length 8",
              "minLength": 1,
              "maxLength": 35,
              "type": "string",
              "title": "bank_id"
            }
          }
        }
      }
    },
    "Sender-Get-Status": {
      "type": "object",
      "title": "Sender Notification",
      "properties": {
        "name": {
          "description": "Sender Name \n- This parameter is optional for Brazil with max length 140",
          "minLength": 1,
          "maxLength": 140,
          "type": "string",
          "title": "name"
        },
        "private_id": {
          "description": "Sender tax or Legal Entity Id \n- This parameter is optional for Brazil with max length 11 or 14",
          "minLength": 1,
          "maxLength": 35,
          "type": "string",
          "title": "private_id"
        }
      }
    }
  }
}