chargebackMessagePostRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/payrix/main/json-schema/payrix-chargeback-message-post-request-schema.json",
  "title": "chargebackMessagePostRequest",
  "x-generated": "2026-09-21",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/payrix-chargeback-messages-api-openapi.yml#/components/schemas/chargebackMessagePostRequest",
  "required": [
    "chargeback",
    "type"
  ],
  "type": "object",
  "properties": {
    "chargeback": {
      "type": "string",
      "description": "The identifier of the Chargeback resource that this chargebackMessage relates to."
    },
    "date": {
      "type": "string",
      "description": "The date of this chargebackMessage. \nThe date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016."
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/$defs/chargebackMessageType"
        },
        {
          "description": "The type of this chargebackMessage.\n\n<details>\n<summary>Valid Values</summary>\n\n- `assign` - **Assign the chargeback.**\n- `notate` - **Add a note to the chargeback.**\n- `acceptLiability` - **Accept Liability for the Chargeback amount.**\n- `createPreArbitration` - **Create a pre-arbitration case.**\n- `represent` - **Represent the chargeback.**\n- `respond` - **Respond to the chargeback.**\n- `requestArbitration` - **Request Arbitration. The Merchant wishes to enter arbitration to determine the outcome of the Chargeback.**\n- `createArbitration` - **Create an arbitration case.**\n- `requestPreArbitration` - **Request a pre-arbitration case.**\n- `requestResolutionToPreArbitration` - **Request resolution to a pre-arbitration case.**\n- `respondToDispute` - **Respond to a dispute.**\n- `respondToPreArbitration` - **Respond to a pre-arbitration case.**\n- `unaccept` - **Unaccept the chargeback.**\n\n</details>"
        }
      ]
    },
    "fromQueue": {
      "type": "string",
      "description": "The fromQueue element that specifies the queue in which the chargeback resided prior to the performance of the specified activity."
    },
    "toQueue": {
      "type": "string",
      "description": "The toQueue element that specifies queue to which the chargeback moved after the performance of the specified activity."
    },
    "contact": {
      "type": "string",
      "description": "The identifier of the Contact for this chargebackMessage."
    },
    "amount": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The amount that this chargebackMessage corresponds to. \nFor example, if the 'type' is set to '3' (Accept Liability), then this amount indicates that the liability should be for this amount. \nThis field is specified as an integer in cents.",
      "contentEncoding": "int64"
    },
    "currency": {
      "allOf": [
        {
          "oneOf": [
            {},
            {
              "$ref": "#/$defs/currency"
            }
          ]
        },
        {
          "description": "The currency of the amount in this resource. See <a href=\"https://www.iban.com/currency-codes\" target=\"_blank\">Currency codes</a>  for all valid values."
        }
      ]
    },
    "note": {
      "type": "string",
      "description": "A free-text note relating to this chargebackMessage."
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/$defs/chargebackMessageStatus"
        },
        {
          "description": "The current status of the Chargeback.\n\n<details>\n<summary>Valid Values</summary>\n\n- `requested` - **The chargeback has been requested.**\n- `processing` - **The chargeback is currently being processed.**\n- `failed` - **The chargeback process has failed.**\n- `denied` - **The chargeback has been denied.**\n- `processed` - **The chargeback has been successfully processed.**\n\n</details>"
        }
      ]
    },
    "imported": {
      "allOf": [
        {
          "$ref": "#/$defs/chargebackMessageImported"
        },
        {
          "description": "Whether the chargeback message was imported.\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Not imported.**\n- `1` - **Imported.**\n\n</details>"
        }
      ]
    },
    "inactive": {
      "allOf": [
        {
          "$ref": "#/$defs/inactive"
        },
        {
          "description": "Whether this resource is marked as inactive.\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n</details>"
        }
      ]
    },
    "frozen": {
      "allOf": [
        {
          "$ref": "#/$defs/frozen"
        },
        {
          "description": "Whether this resource is marked as frozen.\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n</details>"
        }
      ]
    }
  },
  "$defs": {
    "chargebackMessageImported": {
      "title": "chargebackMessageImported",
      "enum": [
        0,
        1
      ],
      "type": "integer"
    },
    "chargebackMessageStatus": {
      "title": "chargebackMessageStatus",
      "enum": [
        "requested",
        "processing",
        "failed",
        "denied",
        "processed"
      ],
      "type": "string"
    },
    "chargebackMessageType": {
      "title": "chargebackMessageType",
      "enum": [
        "assign",
        "notate",
        "acceptLiability",
        "createPreArbitration",
        "represent",
        "respond",
        "requestArbitration",
        "createArbitration",
        "requestPreArbitration",
        "requestResolutionToPreArbitration",
        "respondToDispute",
        "respondToPreArbitration",
        "unaccept"
      ],
      "type": "string"
    },
    "currency": {
      "title": "currency",
      "enum": [
        "AED",
        "AFN",
        "ALL",
        "AMD",
        "ANG",
        "AOA",
        "ARS",
        "AUD",
        "AWG",
        "AZN",
        "BAM",
        "BBD",
        "BDT",
        "BGN",
        "BHD",
        "BIF",
        "BMD",
        "BND",
        "BOB",
        "BOV",
        "BRL",
        "BSD",
        "BTN",
        "BWP",
        "BYN",
        "BZD",
        "CAD",
        "CDF",
        "CHE",
        "CHF",
        "CHW",
        "CLF",
        "CLP",
        "CNY",
        "COP",
        "COU",
        "CRC",
        "CUC",
        "CUP",
        "CVE",
        "CZK",
        "DJF",
        "DKK",
        "DOP",
        "DZD",
        "EGP",
        "ERN",
        "ETB",
        "EUR",
        "FJD",
        "FKP",
        "GBP",
        "GEL",
        "GHS",
        "GIP",
        "GMD",
        "GNF",
        "GTQ",
        "GYD",
        "HKD",
        "HNL",
        "HRK",
        "HTG",
        "HUF",
        "IDR",
        "ILS",
        "INR",
        "IQD",
        "IRR",
        "ISK",
        "JMD",
        "JOD",
        "JPY",
        "KES",
        "KGS",
        "KHR",
        "KMF",
        "KPW",
        "KRW",
        "KWD",
        "KYD",
        "KZT",
        "LAK",
        "LBP",
        "LKR",
        "LRD",
        "LSL",
        "LYD",
        "MAD",
        "MDL",
        "MGA",
        "MKD",
        "MMK",
        "MNT",
        "MOP",
        "MRU",
        "MUR",
        "MVR",
        "MWK",
        "MXN",
        "MXV",
        "MYR",
        "MZN",
        "NAD",
        "NGN",
        "NIO",
        "NOK",
        "NPR",
        "NZD",
        "OMR",
        "PAB",
        "PEN",
        "PGK",
        "PHP",
        "PKR",
        "PLN",
        "PYG",
        "QAR",
        "RON",
        "RSD",
        "RUB",
        "RWF",
        "SAR",
        "SBD",
        "SCR",
        "SDG",
        "SEK",
        "SGD",
        "SHP",
        "SLL",
        "SOS",
        "SRD",
        "SSP",
        "STN",
        "SVC",
        "SYP",
        "SZL",
        "THB",
        "TJS",
        "TMT",
        "TND",
        "TOP",
        "TRY",
        "TTD",
        "TWD",
        "TZS",
        "UAH",
        "UGX",
        "USD",
        "USN",
        "UYI",
        "UYU",
        "UZS",
        "VEF",
        "VND",
        "VUV",
        "WST",
        "XAF",
        "XAG",
        "XAU",
        "XBA",
        "XBB",
        "XBC",
        "XBD",
        "XCD",
        "XDR",
        "XOF",
        "XPD",
        "XPF",
        "XPT",
        "XSU",
        "XUA",
        "YER",
        "ZAR",
        "ZMW",
        "ZWL"
      ],
      "type": "string"
    },
    "frozen": {
      "title": "frozen",
      "enum": [
        0,
        1
      ],
      "type": "integer"
    },
    "inactive": {
      "title": "inactive",
      "enum": [
        0,
        1
      ],
      "type": "integer"
    }
  }
}