Skip to content

GET Adjustment categories

Overview

Returns the adjustment categories used for DebiCheck. Adjustment Categories describe the different scenarios when adjustments may be made to instalments.

HTTP Request

GET /v1/realpay/{merchant_number}/general/adjustment_categories/{product}

Path Parameters

  • merchant_number (string, required)
  • product (string, required)

Query Parameters

  • Version (string, required, default: v1)

Request Body

None

Success Response (200)

Schema: AdjustmentCategoryGetResponse

Example

{
  "AdjustmentCategoryGetResponse": [
    {
      "AdjustmentCategory": "N",
      "AdjustmentCategoryDescription": "Never"
    }
  ],
  "APIResponse": {
    "CallSequence": 7271,
    "Status": "SUCCESS",
    "Version": "1.0.0",
    "Name": "INTERNAL NAME OF CALL"
  }
}

Fields

  • AdjustmentCategoryGetResponse[].AdjustmentCategory (string, maxLength 1)
  • AdjustmentCategoryGetResponse[].AdjustmentCategoryDescription (string, maxLength 100)

Error Responses

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