PaymentRequestStatusObj

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/azupay/main/json-schema/azupay-payment-request-status-obj-schema.json",
  "title": "PaymentRequestStatusObj",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/azupay-payment-request-api-openapi.yml#/components/schemas/PaymentRequestStatusObj",
  "type": "object",
  "properties": {
    "PaymentRequestStatus": {
      "type": "object",
      "required": [
        "paymentRequestId",
        "status",
        "createdDateTime"
      ],
      "additionalProperties": false,
      "properties": {
        "settledBy": {
          "type": "string",
          "description": "Specifies how this PaymentRequest was completed",
          "enum": [
            "PayID",
            "PayTo",
            "BSBAndAccountNumber"
          ]
        },
        "completedDatetime": {
          "type": "string",
          "format": "date-time",
          "description": "Timestamp when the payment was finalised in Azupay"
        },
        "createdDateTime": {
          "description": "Timestamp when the payment request was created",
          "format": "date-time",
          "type": "string"
        },
        "refundInformation": {
          "description": "This object is present when a partial refund is requested.",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "availableBalance": {
              "type": "string",
              "description": "The remaining balance after completion of all the refunds."
            },
            "requests": {
              "type": "array",
              "description": "An array of objects capturing log of completed refund requests",
              "items": {
                "type": "object",
                "description": "Refund information",
                "required": [
                  "refundTrigger"
                ],
                "properties": {
                  "dateTime": {
                    "type": "string",
                    "format": "date-time",
                    "deprecated": true,
                    "description": "Same as createdDateTime. Deprecated, Use `createdDateTime`"
                  },
                  "createdDateTime": {
                    "type": "string",
                    "format": "date-time",
                    "description": "Timestamp when refund request was initiated"
                  },
                  "completedDateTime": {
                    "type": "string",
                    "format": "date-time",
                    "description": "Timestamp when refund request was completed. Replaces deprecated `dateTime`."
                  },
                  "amount": {
                    "type": "string",
                    "description": "The refund amount"
                  },
                  "nppTransactionId": {
                    "description": "The identifier of the transaction in the NPP network. This is an identifier known by the initiating bank and serves as unique identifier for the refund.",
                    "type": "string"
                  },
                  "status": {
                    "description": "The status of the refund",
                    "type": "string",
                    "enum": [
                      "IN_PROGRESS",
                      "COMPLETE",
                      "FAILED"
                    ]
                  },
                  "refundTrigger": {
                    "description": "Channel that triggered this refund",
                    "type": "string",
                    "enum": [
                      "REFUND_API",
                      "PAYMENT_VALIDATION",
                      "WEBHOOK_ACTION"
                    ]
                  }
                }
              }
            }
          }
        },
        "failureReason": {
          "description": "If status is failed or returned, this field will describe the reason for the failure.",
          "type": "string"
        },
        "paymentRequestId": {
          "type": "string",
          "description": "An identifier generated by Azupay. Used to reference the object in subsequent operations such as getPaymentRequest and refundPaymentRequest"
        },
        "rbaSettlementDatetime": {
          "description": "Timestamp when the payment was settled by the RBA",
          "format": "date-time",
          "type": "string"
        },
        "returnCompletedDatetime": {
          "type": "string",
          "format": "date-time",
          "deprecated": true,
          "description": "Timestamp when the last refund was completed to either COMPLETED or FAILED. Use the `completedDateTime` on  each individual refund request instead."
        },
        "returnInitiator": {
          "description": "AUTOMATIC for returns initiated by Azupay due to incorrect amount or duplicate payment. MANUAL for returns initiated by client due to product fulfillment or other client error.",
          "enum": [
            "AUTOMATIC",
            "MANUAL"
          ],
          "type": "string"
        },
        "parentPaymentRequestId": {
          "type": "string",
          "description": "The paymentRequestId of a paymentRequest created with multiPayment set to true and for which this PaymentRequest was created and paid against."
        },
        "status": {
          "description": "Status of the requested payment.",
          "enum": [
            "WAITING",
            "EXPIRED",
            "COMPLETE",
            "RETURN_IN_PROGRESS",
            "RETURN_COMPLETE",
            "RETURN_FAILED"
          ],
          "type": "string"
        },
        "amountReceived": {
          "type": "number",
          "description": "The amount received from the customer"
        },
        "overpaymentAmount": {
          "type": "number",
          "description": "When the payment Request is `multiPayment` and has a `paymentAmount` defined, the payer can\noverpay by mistake in which case the extra amount is refunded back to their account. This value represents\nthe extra amount that was refunded back to the payer. If the payment was for the exact amount, the value of this\nfield is zero.\nThis field will only be present when the payment request is in `COMPLETE` state.\n"
        },
        "payerPaymentDescription": {
          "description": "The description supplied by the payer when making the payment",
          "type": "string"
        },
        "payerPaymentReference": {
          "description": "The reference supplied by the payer when making the payment",
          "type": "string"
        },
        "failedPaymentAttempts": {
          "description": "This object is present when the payer has made invalid payments",
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "attemptAmount": {
                "type": "number",
                "description": "The amount"
              },
              "attemptDateTime": {
                "type": "string",
                "description": "The date time"
              },
              "attemptFailureReason": {
                "type": "string",
                "description": "The reason for payment failure"
              }
            }
          }
        },
        "payerInformation": {
          "description": "This object is present when the payment is completed and your client is configured to expose payer information.",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "bsb": {
              "type": "string",
              "description": "The bsb"
            },
            "accountNumber": {
              "type": "string",
              "description": "The account number"
            },
            "fullLegalAccountName": {
              "type": "string",
              "description": "The full legal account name"
            }
          }
        },
        "nppTransactionId": {
          "description": "The identifier of the transaction in the NPP network. This is an identifier known by the initiating bank.",
          "type": "string"
        },
        "virtualBsb": {
          "description": "The BSB that can be used to pay for this payment request",
          "type": "string",
          "pattern": "^\\d{6}$",
          "minLength": 6,
          "maxLength": 6
        },
        "virtualAccountNumber": {
          "description": "The Account Number that can be used to pay for this payment request.",
          "type": "string",
          "pattern": "^\\d{5,9}$",
          "minLength": 5,
          "maxLength": 9
        },
        "paidViaVirtualAccount": {
          "deprecated": true,
          "description": "Please use `settledBy` instead. This field will be true if this payment request was paid using the `virtualBsb` and `virtualAccountNumber` instead of the `payID`.",
          "type": "boolean"
        },
        "paymentAgreementId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 40,
          "description": "ID of the payment agreement created for for this PaymentRequest.  This is only populated when a PayTo paymentInitiation is created using a paymentRequestId and completes successfully."
        }
      }
    }
  }
}