PaymentAgreementAmendmentStatusObj

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/azupay/main/json-schema/azupay-payment-agreement-amendment-status-obj-schema.json",
  "title": "PaymentAgreementAmendmentStatusObj",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/azupay-payment-agreement-api-openapi.yml#/components/schemas/PaymentAgreementAmendmentStatusObj",
  "type": "object",
  "required": [
    "PaymentAgreementAmendmentStatus"
  ],
  "properties": {
    "PaymentAgreementAmendmentStatus": {
      "type": "object",
      "required": [
        "paymentAgreementAmendmentId",
        "amendmentStatus",
        "createdDatetime"
      ],
      "properties": {
        "paymentAgreementAmendmentId": {
          "$ref": "#/$defs/azupayId"
        },
        "bilateralAmendmentStatus": {
          "type": "string",
          "description": "Use `amendmentStatus` instead.",
          "deprecated": true,
          "enum": [
            "PENDING",
            "COMPLETED",
            "DECLINED",
            "RECALLED",
            "TIMEDOUT"
          ]
        },
        "amendmentStatus": {
          "type": "string",
          "description": "Status of the requested payment agreement amendment.",
          "enum": [
            "PENDING",
            "COMPLETED",
            "DECLINED",
            "RECALLED",
            "TIMEDOUT"
          ]
        },
        "createdDatetime": {
          "type": "string",
          "format": "date-time",
          "description": "Timestamp when the payment agreement amendment was created"
        },
        "completedDatetime": {
          "type": "string",
          "format": "date-time",
          "description": "Timestamp when the amend payment agreement was completed.\nOnly for `amendmentStatus` different than `PENDING`.\n"
        }
      }
    }
  },
  "$defs": {
    "azupayId": {
      "type": "string",
      "description": "An identifier generated by Azupay. Used to reference the object in subsequent operations"
    }
  }
}