Maintain OMNI Express

Overview

Create express transactions that combine User, Contract and single Instalment setup in one request.

Path

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

Path Parameters

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

Common Query Parameters

• Version (string, required, default: v1)

---

POST Create Express Transaction

Create Express Transaction.

Request Body Schema (POST)

ExpressPostRequest (object)

Request Example (POST)

{
  "ExpressPostRequest": [
    {
      "User": {
        "UserId": "ZA123123123123",
        "FirstName": "Jane",
        "LastName": "Doe",
        "DateOfBirth": "1990-01-01"
      },
      "Contract": {
        "ContractNumber": "EXP-00001",
        "Product": "DC",
        "FirstCollectionDate": "2024-11-25",
        "ContractAmount": 10000,
        "TotalNumberOfInstalments": 1,
        "InstalmentAmount": 10000,
        "Frequency": "O"
      }
    }
  ]
}

Success Response (200) Schema (POST)

ExpressPostResponse

Response Example (POST)

{
  "ExpressPostResponse": [
    {
      "Successful": [
        {
          "UserId": "ZA123123123123",
          "ContractSequence": 7777,
          "ContractNumber": "EXP-00001",
          "InstalmentSequence": 9999
        }
      ],
      "Failed": []
    }
  ],
  "APIResponse": {
    "CallSequence": 9900,
    "Status": "SUCCESS",
    "Version": "1.0.2",
    "Name": "INTERNAL NAME OF CALL"
  }
}

Error Responses

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