Skip to main content

Get complete voucher information

GET 
/vouchers/:voucher_id

Get complete vouchers information

Request​

Path Parameters

    voucher_id stringrequired

    Voucher ID

Responses​

Successful operation

Schema

    amount number

    The monetary value of the voucher

    apply_over_taxes boolean

    Indicates if the voucher discount applies over the taxes

    code string

    Unique code to identify and redeem the voucher

    conditions string[]

    List of conditions and restrictions for using the voucher

    description string

    Human readable description of the voucher offer

    partner

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    branch string

    Branch name. Could be used to identify call-center or store that start the policy process.

    brand string

    Brand name

    client_id string

    Client id generated by bolttech

    name string

    Partner name

    partner_id string

    Partner id generated by bolttech

    payment_properties

    object

    allowed_banks string[]

    List of supported bank names

    allowed_banks_digits string[]

    List of supported bank identification numbers

    allowed_payment_methods string[]

    List of supported payment methods

    quantity_used number

    Number of times the voucher has been redeemed

    product

    object[]

  • Array [

    • internal_id string

    Unique internal identifier for the product

    internal_products undefined[]
    metadata object

    Additional metadata associated with the product

    name string

    Name of the product

    price

    object

    amount float

    commission

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    apply_over_taxes boolean
    commission_value float
    description string
    type string

    Possible values: [FIXED, PERCENTAGE]

    value string
    rate number

    Tax rate

    currency_code CurrencyCodeEnum (string)

    Possible values: [AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, ZMW]

    Currency codes Enum

    discount

    object[]

  • Array [

    • additional_details object

    Additional details that do not have a specific field to store it.

    apply_over_taxes boolean
    commission_value float
    description string
    type string

    Possible values: [FIXED, PERCENTAGE]

    value string
    rate number

    Tax rate

  • ]

    • premium

    object

    net float
    total float

    taxes

    object[]

  • Array [

    • description string

    Human readable description of the tax

    type string

    Type/category of the tax being applied

    value float

    Numeric value of the amount

    rate number

    Tax rate

  • ]

    • product_id string

    General product identifier

    product_package string

    Package identifier that the product belongs to

    product_status string

    Current status of the product

    provider string

    Provider identifier for the product

    score number

    Product rating or score value

  • ]

    • terms_and_conditional

    object

    max_discount_value number
    minimum_purchase_amount number
    quantity_limit number
    quantity_used number
    type string

    Category or type of voucher

    validity

    object

    expires_at string
    start_at string
Loading...