CSQ Docs
    CSQ Docs
    CSQ API Doc
    • CSQ API Doc
    • Dummy Product Usage Guide
    • Prepaid
    • Vouchers
    • Get Dynamic Vouchers
      GET
    • Vouchers Purchase
      POST
    • Voucher Additional Data
      GET
    • Get Resolved Vouchers
      GET

      Get Dynamic Vouchers

      GET
      /pre-paid/vouchers/products/{terminalId}/{operatorId}

      📦 Get Dynamic Vouchers#

      Retrieves the list of available dynamic vouchers for a specific operatoId.

      🔍 Description#

      This method is used when the operator provides dynamic vouchers, which are not predefined and must be queried in real time.
      One common scenario for this method is checking available raffles or sweepstakes where tickets can still be purchased, thereby ensuring that only active products are offered for purchase.
      Although this step can be skipped for most voucher types, our support team can help you identify which products require its use beforehand.

      📥 Path Parameters#

      ParameterTypeDescription
      terminalIdstringIdentifier of the terminal making the request
      operatorIdstringIdentifier of the product

      📤 Response#

      Returns a list of dynamic vouchers, each including the following fields:
      id: Unique identifier of the dynamic voucher (used for purchasing)
      description: Human-readable vouchers description
      amountToSendX100, destinationAmountX100, serviceFeeX100, totalAmountX100: Amounts represented in hundredths of currency unit
      destinationCurrency: Currency used by the operator (e.g., EUR, USD)
      additionalData (optional, per product): A list of key-value pairs with informative data specific to the product.
      In addition, the root object may also contain a general additionalData field with informative data that applies to the whole response, not to a specific product.
      Both additionalData fields are optional and meant only for display; they are not required for placing a purchase.

      🧠 Usage Notes#

      This endpoint should be called before placing a purchase order when dealing with specific operators that require dynamic product validation prior to purchase — such as raffles or sweepstakes.
      If the response includes additionalData (at product or global level), you may display that information to the user, but it is not required during the purchase request.

      Request

      Path Params
      terminalId
      integer <int32>
      required
      operatorId
      integer <int32>
      required
      Header Params
      U
      string 
      required
      Default:
      {{U}}
      SH
      string 
      required
      Default:
      {{SH}}
      ST
      string 
      required
      Default:
      {{ST}}

      Request samples

      Shell
      JavaScript
      Java
      Swift
      Go
      PHP
      Python
      HTTP
      C
      C#
      Objective-C
      Ruby
      OCaml
      Dart
      R
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location --request GET 'https://evsb.csqworld.com/pre-paid/vouchers/products//' \
--header 'U;' \
--header 'SH;' \
--header 'ST;'

      Responses

      🟢200OK
      application/json
      Body
      rc
      integer <int32>
      optional
      items
      array[object (DynamicProductDto) {8}] 
      optional
      amountToSendX100
      integer <int32>
      optional
      destinationAmountX100
      integer <int32>
      optional
      serviceFeeX100
      integer <int32>
      optional
      totalAmountX100
      integer <int32>
      optional
      destinationCurrency
      string 
      optional
      id
      string 
      optional
      description
      string 
      optional
      additionalData
      array[object (AdditionalDataDto) {2}] 
      optional
      additionalData
      array[object (AdditionalDataDto) {2}] 
      optional
      key
      string 
      optional
      value
      string 
      optional
      Example
      {
    "rc": 0,
    "items": [
        {
            "amountToSendX100": 0,
            "destinationAmountX100": 0,
            "serviceFeeX100": 0,
            "totalAmountX100": 0,
            "destinationCurrency": "string",
            "id": "string",
            "description": "string",
            "additionalData": [
                {
                    "key": "string",
                    "value": "string"
                }
            ]
        }
    ],
    "additionalData": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}
      Modified at 2025-07-10 20:57:56
      Next
      Vouchers Purchase
      Built with