Skip to content

Reports OMNI Instalment Changes Report

Overview

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

Path

/v1/realpay/{merchant_number}/reports/omni/instalment_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/instalment_changes_report/{product}

Success Response (200) Schema

InstalmentChangesGetResponse

Response Example

{
  "InstalmentChangesGetResponse": [
    {
      "UserId": "ZA123123123123",
      "ContractNumber": "CNTR-00001",
      "ContractSequence": 4567,
      "InstalmentActionDate": "2024-12-25 00:00",
      "TrackingCode": "TRK1",
      "InstalmentAmount": 8333.0,
      "InstalmentReferenceNumber": "REF-0001",
      "InstalmentSequence": 8901,
      "InstalmentStatus": "ACTIVE",
      "InstalmentResult": "RP01",
      "LastUpdateDate": "2024-11-26 10:15"
    }
  ],
  "APIResponse": {
    "CallSequence": 4040,
    "Status": "SUCCESS",
    "Version": "1.0.2",
    "Name": "INTERNAL NAME OF CALL"
  }
}

Error Responses

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