Skip to content

Reports Instalment changes

Overview

Retrieve instalment change events within a date range for a product.

Path

/v1/realpay/{merchant_number}/reports/instalment_changes_report/{product}

Path Parameters

  • merchant_number (string, required)
  • product (string, required)

Common Query Parameters

  • Version (string, required, default: v1)

Filter Query Parameters

  • StartDate (string, required): Format YYYY-MM-DD HH24:MI
  • EndDate (string, required): Format YYYY-MM-DD HH24:MI
  • ClientNumber (string, optional)
  • ContractNumber (string, optional)
  • ContractSequence (integer, optional)

GET Instalment Changes Report

Retrieve instalment changes.

Success Response (200) Schema

InstalmentChangesReportGetResponse

Response Example (200)

{
  "InstalmentChangesReportGetResponse": [
    {
      "ChangeDate": "2024-05-04 09:45",
      "ClientNumber": "L11306666",
      "ContractNumber": "C1603",
      "ContractSequence": 9011154048,
      "InstalmentSequence": 10,
      "ChangeType": "EDIT",
      "FieldChanged": "Amount",
      "OldValue": "300.00",
      "NewValue": "350.00"
    }
  ],
  "APIResponse": {
    "CallSequence": 7271,
    "Status": "SUCCESS",
    "Version": "1.0.0",
    "Name": "INTERNAL NAME OF CALL"
  }
}

Error Responses

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