Skip to content

GET Frequency codes

Overview

Returns the frequency codes used for the specified Product. Frequency codes are used in the specified product to describe the frequency of recurring instalments.

HTTP Request

GET /v1/realpay/{merchant_number}/general/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.

Path Parameters

None

Request Body

None

Success Response (200)

Content-Type: application/json

Schema: FrequencyGetResponse

Example

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

Fields

  • FrequencyGetResponse[].FrequencyCode (string, maxLength 4): Frequency Code for DebiCheck
  • FrequencyGetResponse[].FrequencyDescription (string, maxLength 30): Frequency Description
  • FrequencyGetResponse[].CollectionDays[].CollectionDay (integer, maxLength 2): Collection Day Code for this Frequency
  • FrequencyGetResponse[].CollectionDays[].DayDescription (string, maxLength 40): Collection Day Description for this Frequency

Error Responses

  • 400 BadRequest: API Call successfully processed by the server, but errors are present in the request.
  • 401 Unauthorized: Unauthorized - Use OAuth2 Authentication to access the resource
  • 404 NotFound: The specified resource was not found
  • 500 InternalError: An Internal Server Error Occured. Contact Real Pay Support.
  • 503 ServiceUnavailable: Service Unavailable. Contact Real Pay Support.