Maintain OMNI Users

Overview

Create, edit, and retrieve User records.

Path

/v1/realpay/{merchant_number}/maintain/omni/users

Path Parameters

• merchant_number (string, required)

Common Query Parameters

• Version (string, required, default: v1)

---

POST Create User Records

Create User Records.

Request Body Schema (POST)

UserPostRequest (object)

Request Example (POST)

{
  "UserPostRequest": [
    {
      "Name": "Jack",
      "Surname": "Frost",
      "DOB": "1980-05-31",
      "Gender": "M",
      "DialCode": "+27",
      "Mobile": 827648862,
      "Email": "jack.frost@myemail.com",
      "Country": "ZA",
      "ID": 123123123123,
      "ClientId": "FROST01",
      "Contract": {
        "ContractNumber": "C1603",
        "InstalmentAmount": 123.45,
        "NumberOfInstalments": 1,
        "InstalmentStartDate": "YYYY-MM-DD HH24:MI",
        "TrackingCode": "00",
        "FrequencyCode": "MNTH",
        "CollectionDay": 25
      }
    }
  ]
}

Success Response (200) Schema (POST)

UserPostResponse

Response Example (POST)

{
  "UserPostResponse": [
    {
      "Successful": [
        {
          "UserId": "ZA123123123123",
          "Name": "Jack",
          "Surname": "Frost",
          "Contract": {
            "ContractNumber": "C1603",
            "InstalmentAmount": 123.45,
            "NumberOfInstalments": 1,
            "InstalmentStartDate": "YYYY-MM-DD HH24:MI",
            "TrackingCode": "00",
            "FrequencyCode": "MNTH",
            "CollectionDay": 25
          }
        }
      ],
      "Failed": []
    }
  ],
  "APIResponse": {
    "CallSequence": 1234,
    "Status": "SUCCESS",
    "Version": "1.0.2",
    "Name": "INTERNAL NAME OF CALL"
  }
}

---

PUT Edit User Records

Edit User Records.

Request Body Schema (PUT)

UserPutRequest (object)

Request Example (PUT)

{
  "UserPutRequest": [
    {
      "UserId": "ZA123123123123",
      "Email": "jack.frost.updated@myemail.com",
      "Mobile": 827648862
    }
  ]
}

Success Response (200) Schema (PUT)

UserPutResponse

Response Example (PUT)

{
  "UserPutResponse": [
    {
      "Successful": [
        {
          "UserId": "ZA123123123123",
          "Email": "jack.frost.updated@myemail.com"
        }
      ],
      "Failed": []
    }
  ],
  "APIResponse": {
    "CallSequence": 1234,
    "Status": "SUCCESS",
    "Version": "1.0.2",
    "Name": "INTERNAL NAME OF CALL"
  }
}

---

GET Retrieve User Record

Retrieve User Record.

Additional Query Parameters (GET)

• Product (string, required)
• UserId (string, optional)
• Email (string, optional)
• Mobile (string, optional)

Success Response (200) Schema (GET)

UserGetResponse

Response Example (GET)

{
  "UserGetResponse": [
    {
      "UserId": "ZA123123123123",
      "Name": "Jack",
      "Surname": "Frost",
      "Mobile": 827648862,
      "Email": "jack.frost@myemail.com",
      "Country": "ZA",
      "ID": 123123123123,
      "Contract": {
        "ContractNumber": "C1603",
        "InstalmentAmount": 123.45,
        "InstalmentStartDate": "YYYY-MM-DD HH24:MI",
        "TrackingCode": "00"
      }
    }
  ],
  "APIResponse": {
    "CallSequence": 1234,
    "Status": "SUCCESS",
    "Version": "1.0.2",
    "Name": "INTERNAL NAME OF CALL"
  }
}

Error Responses

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