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

      Voucher Additional Data

      GET
      /pre-paid/vouchers/additional-data/{terminalId}/{operatorId}/{suppliertoken}

      🧾 Get Voucher Additional Data#

      Retrieves complementary information related to a previously purchased voucher. This may include redemption instructions, barcodes, QR codes, PDF links, or any other metadata required to deliver or display the voucher. It can also include the voucher code itself in case of delayed voucher issuance.

      🎯 Use Case – When Should This Method Be Used?#

      This endpoint should be called only if the purchase response includes the flag hasAdditionalData: true. It allows clients to fetch the full content or presentation details of the voucher after it has been issued.

      📥 Path Parameters#

      ParameterTypeDescription
      terminalIdstringID of the terminal that performed the purchase
      operatorIdstringID of the voucher provider/operator
      suplierTokenstringUnique reference used in the original purchase

      📤 Response#

      Returns a structured object with additional voucher content, which may include:
      voucherCode: The actual code (if not already returned)
      barcode / qrCode: Visual representation for scanning
      downloadUrl: Link to a PDF or printable version
      instructions: Textual redemption instructions
      expirationDate: Optional expiry info
      metadata: Any other operator-specific fields

      🧠 Usage Notes#

      This endpoint is only needed when hasAdditionalData is true in the purchase response.
      If the voucher was fully delivered in the purchase response, this call is unnecessary.
      ⏱️ If hasAdditionalData: true, clients should poll this endpoint every 5 seconds until the additional data is available.

      Request

      Path Params

      Header Params

      Request Code 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/additional-data///' \
--header 'U;' \
--header 'SH;' \
--header 'ST;'

      Responses

      🟢200OK
      application/json
      Body

      Example
      {
    "rc": 0,
    "items": [
        {
            "resultcode": 0,
            "resultmessage": "string",
            "redeemAccount": "string",
            "redeemInstructions": "string",
            "redeemCode": "string",
            "expiration": "string",
            "additionalData": {}
        }
    ]
}
      Modified at 2025-07-30 15:21:10
      Previous
      Vouchers Purchase
      Next
      Get Resolved Vouchers
      Built with