Maintain OMNI Instalments

Overview

Add, edit, cancel and retrieve Instalments linked to Contracts.

Path

/v1/realpay/{merchant_number}/maintain/omni/instalments/{product}

Path Parameters

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

Common Query Parameters

• Version (string, required, default: v1)

---

POST Add Instalments

Add Instalments to an existing Contract.

Request Body Schema (POST)

InstalmentPostRequest (object)

Request Example (POST)

{
  "InstalmentPostRequest": [
    {
      "ContractSequence": 4567,
      "CollectionDate": "2024-12-25",
      "InstalmentAmount": 8333
    }
  ]
}

Success Response (200) Schema (POST)

InstalmentPostResponse

Response Example (POST)

{
  "InstalmentPostResponse": [
    {
      "Successful": [
        {
          "ContractSequence": 4567,
          "InstalmentSequence": 8901
        }
      ],
      "Failed": []
    }
  ],
  "APIResponse": {
    "CallSequence": 1122,
    "Status": "SUCCESS",
    "Version": "1.0.2",
    "Name": "INTERNAL NAME OF CALL"
  }
}

---

PUT Edit Instalments

Edit Instalments.

Request Body Schema (PUT)

InstalmentPutRequest (object)

Request Example (PUT)

{
  "InstalmentPutRequest": [
    {
      "ContractSequence": 4567,
      "InstalmentSequence": 8901,
      "CollectionDate": "2025-01-25",
      "InstalmentAmount": 9000
    }
  ]
}

Success Response (200) Schema (PUT)

InstalmentPutResponse

Response Example (PUT)

{
  "InstalmentPutResponse": [
    {
      "Successful": [
        {
          "ContractSequence": 4567,
          "InstalmentSequence": 8901
        }
      ],
      "Failed": []
    }
  ],
  "APIResponse": {
    "CallSequence": 3344,
    "Status": "SUCCESS",
    "Version": "1.0.2",
    "Name": "INTERNAL NAME OF CALL"
  }
}

---

DELETE Cancel Instalments

Cancel Instalments.

Query Parameters (DELETE)

• ContractSequence (integer, required)
• InstalmentSequence (integer, optional) // If omitted all remaining instalments may be cancelled (depending on rules)

Success Response (200) Schema (DELETE)

InstalmentDeleteResponse

Response Example (DELETE)

{
  "InstalmentDeleteResponse": [
    {
      "Successful": [
        {
          "ContractSequence": 4567,
          "InstalmentSequence": 8901
        }
      ],
      "Failed": []
    }
  ],
  "APIResponse": {
    "CallSequence": 5566,
    "Status": "SUCCESS",
    "Version": "1.0.2",
    "Name": "INTERNAL NAME OF CALL"
  }
}

---

GET Retrieve Instalments

Retrieve Instalments.

Query Parameters (GET)

• ContractSequence (integer, optional)
• InstalmentSequence (integer, optional)
• Status (string, optional)

Success Response (200) Schema (GET)

InstalmentGetResponse

Response Example (GET)

{
  "InstalmentGetResponse": [
    {
      "ContractSequence": 4567,
      "InstalmentSequence": 8901,
      "CollectionDate": "2025-01-25",
      "InstalmentAmount": 9000,
      "Status": "ACTIVE"
    }
  ],
  "APIResponse": {
    "CallSequence": 7788,
    "Status": "SUCCESS",
    "Version": "1.0.2",
    "Name": "INTERNAL NAME OF CALL"
  }
}

Error Responses

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