PaymentStatusObj

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/azupay/main/json-schema/azupay-payment-status-obj-schema.json",
  "title": "PaymentStatusObj",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/azupay-payment-api-openapi.yml#/components/schemas/PaymentStatusObj",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "PaymentStatus"
  ],
  "properties": {
    "PaymentStatus": {
      "type": "object",
      "required": [
        "paymentId",
        "status",
        "createdDatetime"
      ],
      "properties": {
        "paymentId": {
          "type": "string",
          "description": "An identifier generated by Azupay. Used to reference the object in subsequent operations such as  getPayment.\n",
          "readOnly": true
        },
        "status": {
          "type": "string",
          "description": "Status of the requested payment.",
          "readOnly": true,
          "enum": [
            "CREATED",
            "SETTLED",
            "FAILED",
            "PENDING",
            "RETURNED"
          ]
        },
        "createdDatetime": {
          "type": "string",
          "format": "date-time",
          "description": "Timestamp when the payment request was created.",
          "readOnly": true
        },
        "settlementDatetime": {
          "type": "string",
          "format": "date-time",
          "description": "Timestamp when the payment was settled. Only if `status=SETTLED`.",
          "readOnly": true
        },
        "completedDatetime": {
          "type": "string",
          "format": "date-time",
          "description": "Timestamp when the payment was processed by Azupay. Only for `status` different than `CREATED`.\n",
          "readOnly": true
        },
        "failureReason": {
          "type": "string",
          "description": "A reason code for a payment that is in `status=FAILED`.",
          "readOnly": true
        },
        "returnedReason": {
          "type": "string",
          "description": "A reason code for a payment that is in `status=RETURNED`.",
          "readOnly": true
        },
        "returnedDatetime": {
          "type": "string",
          "format": "date-time",
          "description": "Timestamp when the payment was returned. Only if `status=RETURNED`.",
          "readOnly": true
        },
        "currentBalance": {
          "type": "number",
          "description": "The liquidity balance of the your account with Azupay. This balance is the funds remaining in your  account after the amount for this payment has been deducted. It is approximate only as other payments  processed in parallel will also have altered the available liquidity.\n",
          "readOnly": true
        },
        "nppTransactionId": {
          "description": "The identifier of the transaction in the NPP network. This is an identifier visible to the receiving bank.",
          "type": "string",
          "readOnly": true
        },
        "sentViaDE": {
          "description": "This field is set to true when the payment was sent via the direct entry (DE) network. When true,  this payment may take between 3 and 5 business days to settle.",
          "type": "boolean",
          "readOnly": true
        }
      }
    }
  }
}