Maintain OMNI Address Records

Overview

Create and edit Address records (required for Card Products).

Path

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

Path Parameters

• merchant_number (string, required)

Common Query Parameters

• Version (string, required, default: v1)

---

POST Create Address Records

Create Address Records.

Request Body Schema (POST)

AddressPostRequest (object)

Request Example (POST)

{
  "AddressPostRequest": [
    {
      "UserId": "ZA123123123123",
      "AddressType": "RE",
      "AddressLine1": "499 Tsitsa Street",
      "AddressCity": "Pretoria",
      "AddressCountry": "ZA",
      "AddressZipCode": "0001"
    }
  ]
}

Success Response (200) Schema (POST)

AddressPostResponse

Response Example (POST)

{
  "AddressPostResponse": [
    {
      "Successful": [
        {
          "UserId": "ZA123123123123",
          "AddressType": "RE"
        }
      ],
      "Failed": []
    }
  ],
  "APIResponse": {
    "CallSequence": 1234,
    "Status": "SUCCESS",
    "Version": "1.0.2",
    "Name": "INTERNAL NAME OF CALL"
  }
}

---

PUT Edit Address Records

Edit Address Records.

Request Body Schema (PUT)

AddressPutRequest (object)

Request Example (PUT)

{
  "AddressPutRequest": [
    {
      "UserId": "ZA123123123123",
      "AddressType": "RE",
      "AddressLine1": "500 Tsitsa Street",
      "AddressCity": "Pretoria",
      "AddressCountry": "ZA",
      "AddressZipCode": "0001"
    }
  ]
}

Success Response (200) Schema (PUT)

AddressPutResponse

Response Example (PUT)

{
  "AddressPutResponse": [
    {
      "Successful": [
        {
          "UserId": "ZA123123123123",
          "AddressType": "RE"
        }
      ],
      "Failed": []
    }
  ],
  "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