Skip to content

Reports OMNI Contract Changes Report

Overview

Retrieve Contract Records changed within the specified date range for the Product.

Path

/v1/realpay/{merchant_number}/reports/omni/contract_changes_report/{product}

Path Parameters

  • merchant_number (string, required)
  • product (string, required) – Product Code

Query Parameters

  • StartDate (string, required, format: YYYY-MM-DD)
  • EndDate (string, required, format: YYYY-MM-DD)- Version (string, required, default: v1)

HTTP Request

GET /v1/realpay/{merchant_number}/reports/omni/contract_changes_report/{product}

Success Response (200) Schema

ContractChangesGetResponse

Response Example

{
  "ContractChangesGetResponse": [
    {
      "UserId": "ZA123123123123",
      "ContractSequence": 4567,
      "ContractNumber": "CNTR-00001",
      "InstalmentStartDate": "2024-11-25",
      "NumberOfInstalments": 6,
      "FrequencyCode": "M",
      "CollectionDay": 25,
      "InstalmentAmount": 8333.0,
      "InstalmentMinimumAmount": 8000.0,
      "InstalmentMaximumAmount": 9000.0,
      "InactiveDate": "",
      "ResultCode": "RP01",
      "UserDefinedField1": "UDF1",
      "UserDefinedField2": "UDF2",
      "UserDefinedField3": null,
      "UserDefinedField4": null,
      "UserDefinedField5": null,
      "ContractInstalments": [
        {
          "InstalmentSequence": 8901,
          "InstalmentActionDate": "2024-12-25 00:00",
          "InstalmentAmount": 8333.0,
          "InstalmentStatus": "ACTIVE"
        }
      ]
    }
  ],
  "APIResponse": {
    "CallSequence": 2020,
    "Status": "SUCCESS",
    "Version": "1.0.2",
    "Name": "INTERNAL NAME OF CALL"
  }
}

Error Responses

  • 400 BadRequest
  • 401 Unauthorized
  • 404 NotFound
  • 500 InternalError
  • 503 ServiceUnavailable