Maintain OMNI Contracts

Overview

Create, cancel and retrieve Contracts. At least one User and Address is required to create a Contract.

Path

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

Path Parameters

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

Common Query Parameters

• Version (string, required, default: v1)

---

POST Create Contracts

Create Contracts.

Request Body Schema (POST)

ContractPostRequest (object)

Request Example (POST)

{
  "ContractPostRequest": [
    {
      "UserId": "ZA123123123123",
      "ContractNumber": "CNTR-00001",
      "Product": "DC",
      "FirstCollectionDate": "2024-11-25",
      "ContractAmount": 50000,
      "TotalNumberOfInstalments": 6,
      "InstalmentAmount": 8333,
      "Frequency": "M"
    }
  ]
}

Success Response (200) Schema (POST)

ContractPostResponse

Response Example (POST)

{
  "ContractPostResponse": [
    {
      "Successful": [
        {
          "ContractSequence": 4567,
          "ContractNumber": "CNTR-00001"
        }
      ],
      "Failed": []
    }
  ],
  "APIResponse": {
    "CallSequence": 9876,
    "Status": "SUCCESS",
    "Version": "1.0.2",
    "Name": "INTERNAL NAME OF CALL"
  }
}

---

DELETE Cancel Contracts

Cancel Contracts. Provide either ContractSequence or ContractNumber.

Query Parameters (DELETE)

• ContractSequence (integer, optional)
• ContractNumber (string, optional)

Success Response (200) Schema (DELETE)

ContractDeleteResponse

Response Example (DELETE)

{
  "ContractDeleteResponse": [
    {
      "Successful": [
        {
          "ContractSequence": 4567,
          "ContractNumber": "CNTR-00001"
        }
      ],
      "Failed": []
    }
  ],
  "APIResponse": {
    "CallSequence": 4321,
    "Status": "SUCCESS",
    "Version": "1.0.2",
    "Name": "INTERNAL NAME OF CALL"
  }
}

---

GET Retrieve Contracts

Retrieve Contracts.

Query Parameters (GET)

• ContractSequence (integer, optional)
• ContractNumber (string, optional)
• Product (string, optional)
• UserId (string, optional)

Success Response (200) Schema (GET)

ContractGetResponse

Response Example (GET)

{
  "ContractGetResponse": [
    {
      "ContractSequence": 4567,
      "ContractNumber": "CNTR-00001",
      "Product": "DC",
      "UserId": "ZA123123123123",
      "FirstCollectionDate": "2024-11-25",
      "ContractAmount": 50000,
      "RemainingAmount": 41667,
      "InstalmentAmount": 8333,
      "TotalNumberOfInstalments": 6,
      "RemainingInstalments": 5,
      "Frequency": "M",
      "Status": "ACTIVE"
    }
  ],
  "APIResponse": {
    "CallSequence": 2468,
    "Status": "SUCCESS",
    "Version": "1.0.2",
    "Name": "INTERNAL NAME OF CALL"
  }
}

Error Responses

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