Skip to content

GET OMNI Products

Overview

Returns the Products per country.

HTTP Request

GET /v1/realpay/{merchant_number}/general/omni/products

Path Parameters

  • merchant_number (string, required)

Query Parameters

  • Version (string, required, default: v1)

Success Response (200)

Schema: ProductsGetResponse

Example

{
  "ProductsGetResponse": [
    {
      "Country": "South Africa",
      "Products": [
        { "ProductCode": "CYBSCARDZAR", "ProductDescription": "Recurring Card South Africa" }
      ]
    }
  ],
  "APIResponse": {
    "CallSequence": 1234,
    "Status": "SUCCESS",
    "Version": "1.0.2",
    "Name": "INTERNAL NAME OF CALL"
  }
}

Fields

  • ProductsGetResponse[].Country (string, maxLength 40)
  • ProductsGetResponse[].Products[].ProductCode (string, maxLength 10)
  • ProductsGetResponse[].Products[].ProductDescription (string, maxLength 50)

Error Responses

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