Skip to main content

Get Privilege

This endpoint allows to get privilege information.

Request​

GET configUrl

Response​

On success:

{
  "value": {
    "id": required uint64,
    "startDate": optional string (date in format YYYY-MM-DD),
    "startTime": optional string (time in format HH:MM:SS),
    "endDate": optional string (date in format YYYY-MM-DD),
    "endTime": optional string (time in format HH:MM:SS),
    "daysOfWeek": optional uint8[] (monday - 1 ... sunday - 7),
    "dayStartTime": optional string (time in format HH:MM:SS),
    "dayEndTime": optional string (time in format HH:MM:SS),
    "configs": required array of {
      "cardType": string,
      "reward": optional {
        "type": required string (one of - discount, gift, certificate, plusX, etc.),
        "merchant": {
          "id": required uint64,
          // used to receive information about merchant, see `Get Merchant` section
          "configUrl": required string (as URL)
        },
        "certificate": optional {
          "provider": required string,
          "ids": optional string[],
          "value": optional number
        },
        "text": optional string,
        "termOfUse": optional string,
        "promoCodeType": optional string,
        "promoCode": optional string,
        // recommended display type is a first element in displayTypes
        "displayTypes": optional string[] (plainText, qr, barcodeCode128, barcodeEan13)  
      },
      "ad": optional {
        "name": required string,
        "description": optional string,
        "rewardText": optional string,
        "button": required {
          "text": optional string,
          "url": optional string
        },
        "image": optional string (as URL)
      }
    }
  }
}