Skip to content

GET OMNI Status codes

Overview

Returns the Status Codes.

HTTP Request

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

Path Parameters

  • merchant_number (string, required)

Query Parameters

  • Product (string, required)
  • Version (string, required, default: v1)

Success Response (200)

Schema: StatusCodesGetResponse

Example

{
  "StatusCodesGetResponse": [
    {
      "StatusCodes": [
        {
          "StatusCode": "A",
          "StatusDescription": "Active"
        }
      ]
    }
  ],
  "APIResponse": {
    "CallSequence": 1234,
    "Status": "SUCCESS",
    "Version": "1.0.2",
    "Name": "INTERNAL NAME OF CALL"
  }
}

Fields

  • StatusCodes[].StatusCode (string, maxLength 1)
  • StatusCodes[].StatusDescription (string, maxLength 40)

Error Responses

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