Get Vouchers List

Grants quick access to a list of available vouchers based on country and state IDs in the request. The response incorporates distinct categories of vouchers and details about each one. These details include voucher and merchant identifiers, descriptions, redemption locations, validity periods, and their respective balance options.

Request Body

• country_id (string): Specifies the country ID for filtering the voucher list.

• state_id (string): Denotes the state ID for further request customization. Can be empty.

Response

• categories (array): Holds unique categories within the available voucher list.

• vouchers (array): Provides a compilation of vouchers, along with detailed data such as:

  • voucher_id (string): Uniquely identifies vouchers.

  • merchant_id (string): Correlates vouchers with specific merchants.

  • image_id (string): Supplies a unique identifier for voucher-related graphics.

  • barcode_batch_id (string): Connects to batch-processed barcode data.

  • voucher_category_id (string): Assists with voucher categorization.

  • country_id (integer): Points to the country where voucher application is valid.

  • currency_id (integer): Cites the applicable currency type.

  • zone_id (integer): Specifies a zone for voucher restriction or allowance.

  • city_id (integer): Defines a city for further voucher application limitations.

  • name (string): Official name of the voucher.

  • description (string): Offers specific details about the voucher.

  • balance_options (string): Gives potential balance options for voucher recipients.

  • is_universal (integer): Informs whether voucher is applicable across all geographic locations.

  • bonus_amount (string): Indicates possible bonus amounts associated with the voucher.

  • bonus_percent (string): Gives probable bonus percentages linked to the voucher.

  • total_bonus_available (string): States the total available bonus amount for voucher.

  • total_bonus_remaining (string): Shares remaining bonus amount after voucher usage.

  • status (string): Shares status of the voucher—likely “approved” or “pending”.

  • validity_period (integer): Time (likely in days) for which the voucher is valid.

  • url (string): URL to be used for redeeming the voucher.

  • created_at (string): Specifies voucher creation timestamp.

  • updated_at (string): Specifies the most recent update timestamp for the voucher.

  • category_name (string): Legible name for the category associated with the voucher.

  • category_id (string): Identifier for the category associated with the voucher.

  • country_name (string): Name of the country where voucher is valid.

  • city_name (string): Name of the city where the voucher is valid.

  • image_url (string): URL of voucher infographics.

  • converted_balance_options (array): Converted values of balance options.

  • full_address (string): Complete geographical specifications for voucher redemption.

  • currency (json): Compiles standard currency parameters.

  • merchant (json): Assembles merchant-specific data.

  • state_id (integer): Provides a state ID for voucher application.

  • state_code (string): Lists a short code for the state of voucher application.