SETW API V3
    SETW API V3
    • LOGIN
      GET
    • GET_VOUCHER_INFO
      GET
    • GET_VOUCHERS
      GET

      GET_VOUCHERS

      GET
      /get_vouchers.php

      Get Vouchers#

      This endpoint retrieves voucher information based on the provided voucher number and authentication token. It is useful for obtaining details related to a specific voucher, including associated policy and product information.

      Request Parameters#

      token (string): A unique authentication token required to access the endpoint.
      voucher_number (string): The specific voucher number for which the details are being requested.

      Example Request#

      GET {{endpoint_url}}get_vouchers.php?token={{token}}&voucher_number=SUR2506
      

      Response Structure#

      The response is returned in JSON format and includes the following fields:
      type (string): The type of response (e.g., success or error).
      message (string): A message providing additional information about the response.
      data (array): An array of objects containing voucher details. Each object may include the following fields:
      FIRSTNAME (string): The first name associated with the voucher.
      LASTNAME (string): The last name associated with the voucher.
      POLICY_NUMBER (string): The policy number linked to the voucher.
      MASTER_PRODUCT_ID (string): The ID of the master product.
      MASTER_PRODUCT (string): The name of the master product.
      PRODUCT_CODE (string): The code for the product.
      PRODUCT (string): The name of the product.
      ISSUING_COUNTRY (string): The country where the voucher was issued.
      ISSUING_COUNTRY_ISO (string): The ISO code of the issuing country.
      ISSUED_ON (string): The date the voucher was issued.
      START_DATE (string): The start date of the voucher validity.
      END_DATE (string): The end date of the voucher validity.
      DOCUMENT_TYPE (string): The type of document associated with the voucher.
      DOCUMENT_NBR (string): The document number.
      STREET (string): The street address associated with the voucher.
      CITY (string): The city associated with the voucher.
      COUNTRY_CODE (string): The country code.
      PHONE (string): The phone number associated with the voucher.
      EMAIL (string): The email address associated with the voucher.
      ISO_COUNTRY (string): The ISO country code.
      TRAVEL_COUNTRY (string): The country where travel is planned.
      GENDER (string): The gender of the voucher holder.
      DATE_OF_BIRTH (string): The date of birth of the voucher holder.
      TRAVEL_AGENCY_ID (string): The ID of the travel agency.
      TRAVEL_AGENCY (string): The name of the travel agency.
      REGION (string): The region associated with the voucher.
      CNUMBER (string): A specific number associated with the voucher.
      PRODUCT_ID (string): The ID of the product.
      COMMENTS (string): Any additional comments related to the voucher.

      Example Response#

      {
        "type": "",
        "message": "",
        "data": [
          {
            "FIRSTNAME": "",
            "LASTNAME": "",
            "POLICY_NUMBER": "",
            "MASTER_PRODUCT_ID": "",
            "MASTER_PRODUCT": "",
            "PRODUCT_CODE": "",
            "PRODUCT": "",
            "ISSUING_COUNTRY": "",
            "ISSUING_COUNTRY_ISO": "",
            "ISSUED_ON": "",
            "START_DATE": "",
            "END_DATE": "",
            "DOCUMENT_TYPE": "",
            "DOCUMENT_NBR": "",
            "STREET": "",
            "CITY": "",
            "COUNTRY_CODE": "",
            "PHONE": "",
            "EMAIL": "",
            "ISO_COUNTRY": "",
            "TRAVEL_COUNTRY": "",
            "GENDER": "",
            "DATE_OF_BIRTH": "",
            "TRAVEL_AGENCY_ID": "",
            "TRAVEL_AGENCY": "",
            "REGION": "",
            "CNUMBER": "",
            "PRODUCT_ID": "",
            "COMMENTS": ""
          }
        ]
      }
      
      This structure allows for easy parsing and handling of voucher information by the client application.
      This endpoint retrieves voucher details based on the provided voucher number and authentication token.

      Request#

      Method: GET
      URL: {{endpoint_url}}get_vouchers.php

      Query Parameters#

      token (string): The authentication token required to access the voucher information.
      voucher_number (string): The unique identifier for the voucher you want to retrieve.

      Response#

      Status Code: 200
      Content-Type: application/json

      Response Body#

      The response will contain a JSON object with the following structure:
      type (string): Type of the response.
      message (string): Any relevant message regarding the request.
      data (array): An array of voucher details, where each voucher contains the following fields:
      FIRSTNAME (string): First name associated with the voucher.
      LASTNAME (string): Last name associated with the voucher.
      POLICY_NUMBER (string): Policy number linked to the voucher.
      MASTER_PRODUCT_ID (string): Identifier for the master product.
      MASTER_PRODUCT (string): Name of the master product.
      PRODUCT_CODE (string): Code for the specific product.
      PRODUCT (string): Name of the product.
      ISSUING_COUNTRY (string): Country where the voucher was issued.
      ISSUING_COUNTRY_ISO (string): ISO code of the issuing country.
      ISSUED_ON (string): Date when the voucher was issued.
      START_DATE (string): Start date of the voucher validity.
      END_DATE (string): End date of the voucher validity.
      DOCUMENT_TYPE (string): Type of document associated with the voucher.
      DOCUMENT_NBR (string): Document number associated with the voucher.
      STREET (string): Street address linked to the voucher.
      CITY (string): City linked to the voucher.
      COUNTRY_CODE (string): Country code linked to the voucher.
      PHONE (string): Phone number associated with the voucher.
      EMAIL (string): Email address associated with the voucher.
      ISO_COUNTRY (string): ISO country code.
      TRAVEL_COUNTRY (string): Country of travel associated with the voucher.
      GENDER (string): Gender of the voucher holder.
      DATE_OF_BIRTH (string): Date of birth of the voucher holder.
      TRAVEL_AGENCY_ID (string): Identifier for the travel agency.
      TRAVEL_AGENCY (string): Name of the travel agency.
      REGION (string): Region associated with the voucher.
      CNUMBER (string): Additional number associated with the voucher.
      PRODUCT_ID (string): Identifier for the product.
      COMMENTS (string): Any additional comments related to the voucher.
      This endpoint is useful for retrieving detailed information about a specific voucher using its unique identifier.
      GET {{endpoint_url}}get_vouchers.php

      Method#

      GET

      Description#

      This endpoint retrieves voucher information based on a provided voucher number and an authentication token. It is used to fetch details related to a specific voucher, which can include personal and policy-related information.

      Request Parameters#

      token (string): The authentication token required to access the voucher information.
      voucher_number (string): The unique identifier for the voucher you wish to retrieve.

      Expected Response#

      The response will return a JSON object containing the following structure:
      type (string): The type of response.
      message (string): A message indicating the status of the request.
      data (array): An array of objects, each containing the following fields:
      FIRSTNAME (string): The first name associated with the voucher.
      LASTNAME (string): The last name associated with the voucher.
      POLICY_NUMBER (string): The policy number linked to the voucher.
      MASTER_PRODUCT_ID (string): The ID of the master product.
      MASTER_PRODUCT (string): The name of the master product.
      PRODUCT_CODE (string): The code of the product.
      PRODUCT (string): The name of the product.
      ISSUING_COUNTRY (string): The country where the voucher was issued.
      ISSUING_COUNTRY_ISO (string): The ISO code of the issuing country.
      ISSUED_ON (string): The date the voucher was issued.
      START_DATE (string): The start date of the voucher validity.
      END_DATE (string): The end date of the voucher validity.
      DOCUMENT_TYPE (string): The type of document associated with the voucher.
      DOCUMENT_NBR (string): The document number.
      STREET (string): The street address.
      CITY (string): The city of residence.
      COUNTRY_CODE (string): The country code.
      PHONE (string): The contact phone number.
      EMAIL (string): The contact email address.
      ISO_COUNTRY (string): The ISO code of the country.
      TRAVEL_COUNTRY (string): The country of travel.
      GENDER (string): The gender of the voucher holder.
      DATE_OF_BIRTH (string): The date of birth of the voucher holder.
      TRAVEL_AGENCY_ID (string): The ID of the travel agency.
      TRAVEL_AGENCY (string): The name of the travel agency.
      REGION (string): The region of the voucher holder.
      CNUMBER (string): The C number associated with the voucher.
      PRODUCT_ID (string): The ID of the product.
      COMMENTS (string): Any additional comments regarding the voucher.

      Response Headers#

      Status: 200 OK - Indicates that the request was successful.
      Content-Type: application/json - The response is in JSON format.
      This endpoint is essential for applications that need to validate or display voucher information to users based on their voucher numbers.
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location -g --request GET '/get_vouchers.php?token={{token}}&voucher_number={{voucher_number}}&passenger_last_name={{passenger_last_name}}&passenger_document_number={{passenger_document_number}}'
      Response Response Example
      {}

      Request

      Query Params

      Responses

      🟢200Success
      application/json
      Body

      Modified at 2025-07-28 18:55:10
      Previous
      GET_VOUCHER_INFO
      Built with