Refunds

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/citi/main/json-schema/citi-refunds-schema.json",
  "title": "Refunds",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/citi-digitalpayments-api-openapi.yml#/components/schemas/Refunds",
  "type": "object",
  "required": [
    "instructed_amount",
    "instructed_currency",
    "original_payment"
  ],
  "properties": {
    "end_to_end_id": {
      "$ref": "#/$defs/RestrictedFINXMax128Text"
    },
    "instructed_amount": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 100000000000000,
      "description": "Instructed amount can either be the full original transaction amount or a partial amount."
    },
    "instructed_currency": {
      "description": "The ISO 4217 code for the transaction instructed amount currency.",
      "type": "string",
      "enum": [
        "BRL"
      ]
    },
    "additional_info": {
      "type": "string",
      "maxLength": 140,
      "description": "Additional or remittance information \n- For Brazil, the `refunds.additional_info` parameter is optional."
    },
    "original_payment": {
      "$ref": "#/$defs/Original_Payment"
    }
  },
  "$defs": {
    "Original_Payment": {
      "type": "object",
      "description": "Either populate UETR OR (`end_to_end_id` AND `value_date`) for the refund to be processed.",
      "properties": {
        "end_to_end_id": {
          "$ref": "#/$defs/RestrictedFINXMax128Text"
        },
        "uetr": {
          "type": "string",
          "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
          "description": "UUID v4 format unique end-to-end transaction reference."
        },
        "value_date": {
          "type": "string",
          "format": "date",
          "description": "Format YYYY-MM-DD Date in local time zone (e.g., EST for a United States RTP network transaction) when Citi's transaction processing application starts processing a transaction."
        }
      }
    },
    "RestrictedFINXMax128Text": {
      "maxLength": 35,
      "minLength": 1,
      "pattern": "^(?!\\s*$).+",
      "type": "string",
      "description": "Specifies a character string with a maximum length of 35 characters limited to character set X, that is, a-z A-Z / - ? : ( ) . , ‘ + . \n - For Brazil `end_to_end_id` parameter is mandatory and allowed max length is 35"
    }
  }
}