GET OMNI Frequency codes

Overview

Returns the frequency codes used for the specified Product. Frequency codes describe the frequency of recurring instalments.

HTTP Request

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

Path Parameters

merchant_number (string, required)

Query Parameters

: The Beneficiary User (previously known as Merchant Number).- Version (string, required, default: v1): Version of API to use. The current default is v1.

Success Response (200)

Schema: FrequencyGetResponse

Example

{
  "FrequencyGetResponse": [
    {
      "FrequencyCode": "WEEK",
      "FrequencyDescription": "Weekly",
      "CollectionDays": [
        {
          "CollectionDay": 1,
          "DayDescription": "Monday"
        }
      ]
    }
  ],
  "APIResponse": {
    "CallSequence": 1234,
    "Status": "SUCCESS",
    "Version": "1.0.2",
    "Name": "INTERNAL NAME OF CALL"
  }
}

Fields

FrequencyGetResponse[].FrequencyCode (string, maxLength 4)
FrequencyGetResponse[].FrequencyDescription (string, maxLength 30)
FrequencyGetResponse[].CollectionDays[].CollectionDay (integer, maxLength 2)
FrequencyGetResponse[].CollectionDays[].DayDescription (string, maxLength 40)

Error Responses

400 BadRequest
401 Unauthorized
404 NotFound
500 InternalError
503 ServiceUnavailable