Validate a voucher

1 min

GET

https://api.fictive.com/REST/api/vouchers/{voucherCode}/validate

This endpoint will provide the ability to validate a voucher against the specific purchase the account is attempting to make

Path Parameters

voucherCodestringrequired

Query Parameters

paymentDatesToCalculateinteger
paymentDatesStartDatestring
clientUserIdstring

Header Parameters

X-TokenIdstring
Description
The eSuite Token Id
X-SessionIdstring
Description
The eSuite Session Id
X-Versionstringrequired
Description
The eSuite Version
Originstring
Description
The eSuite Origin

Responses

200OK

FictiveGlobal.Api.Rest.Dtos.v1.Voucher
Description
Voucher
- purchaseInfoFictiveGlobal.Api.Rest.Dtos.v1.VoucherPurchaseInfo
  Description
  Purchase info
  - purchasePricenumber<double>
    Description
    Purchase price
  - discountPricenumber<double>
    Description
    Discount price
  - renewalPricenumber<double>
    Description
    Renewal price
  - nextPaymentsDatesstring[]
    Example
    Description
    Next payments dates
- voucherInfoFictiveGlobal.Api.Rest.Dtos.v1.VoucherInfo
  Description
  Voucher info
  - startDatestring<date-time>
    Example
    2021-09-21T05:33:26.6043032
    Description
    Start date
  - expiryDatestring<date-time>
    Example
    2021-09-21T05:33:26.6043032
    Description
    Expiry date
  - offerInfoFictiveGlobal.Api.Rest.Dtos.v1.VoucherOfferInfo
    Description
    Offer info
    - namestring
      Description
      Gets or sets the Name.
    - descriptionstring
      Description
      Gets or sets the Description.
    - usageTypeinteger<int32>
      Description
      Gets or sets the UsageType.
    - applicationDataFictiveGlobal.Api.Rest.Dtos.v1.ApplicationData
      Description
      Gets or sets the ApplicationData.
      - namestring
        Description
        Gets or sets the Name.
      - messagestring
        Description
        Gets or sets the Message.
      - message2string
        Description
        Gets or sets the Message2.
    - addCreditsFictiveGlobal.Api.Rest.Dtos.v1.AddCredits
      Description
      Gets or sets the AddCredits.
      - amountinteger<int32>
        Description
        Gets or sets the Amount.
      - currencystring
        Description
        Gets or sets the Currency.
      - paymentDetailsRequiredboolean
        Description
        Gets or sets the PaymentDetailsRequired.
    - lowStartFictiveGlobal.Api.Rest.Dtos.v1.LowStart
      Description
      Gets or sets the LowStart.
      - percentagenumber<double>
        Description
        Gets or sets the Percentage.
      - numberOfPeriodsinteger<int32>
        Description
        Gets or sets the NumberOfPeriods.
      - lockInPeriodsinteger<int32>
        Description
        Gets or sets the lockInPeriods.
      - closeSubOnExpiryboolean
        Description
        Gets or sets the CloseSubOnExpiry.
      - serviceIdsinteger[]
        Example
        Description
        Gets or sets the ServiceIds.
      - paymentDetailsRequiredboolean
        Description
        Gets or sets the PaymentDetailsRequired.
    - percentageDiscountFictiveGlobal.Api.Rest.Dtos.v1.PercentageDiscount
      Description
      Gets or sets the PercentageDiscount
      - percentagenumber<double>
        Description
        Gets or sets the Percentage.
      - paymentDetailsRequiredboolean
        Description
        Gets or sets the PaymentDetailsRequired.
      - productIdsinteger[]
        Example
        Description
        Gets or sets the Products Ids.
    - freePeriodFictiveGlobal.Api.Rest.Dtos.v1.FreePeriod
      Description
      Gets or sets the FreePeriod
      - numberOfPeriodsinteger<int32>
        Description
        Gets or sets the NumberOfPeriods.
      - serviceIdsinteger[]
        Example
        Description
        Gets or sets the ServiceIds.
      - paymentDetailsRequiredboolean
        Description
        Gets or sets the PaymentDetailsRequired.
    - groupDiscountFictiveGlobal.Api.Rest.Dtos.v1.GroupDiscount
      Description
      Gets or sets the GroupDiscount
      - activationCodeActivatedboolean
        Description
        Activation code activated
      - metaDataFictiveGlobal.Api.Rest.Dtos.v1.GroupDiscountOfferType
        Description
        Meta data
        qualifyingItemCountinteger<int32>
        Description
        Qualifying item count
        freeItemCountOrDiscountAmountnumber<double>
        Description
        Free item count or discount amount
        productIdsinteger[]
        Example
        Description
        Product ids
        configurationTypestring
        Description
        Configuration type
        productSourcestring
        Description
        Product source
        customParametersobject
        Example
        [object Object]
        Description
        Custom parameters
    - fixedPriceDiscountFictiveGlobal.Api.Rest.Dtos.v1.FixedPriceDiscount
      Description
      Gets or sets the FixedPriceDiscount
      - discountAmountsFictiveGlobal.Api.Rest.Dtos.v1.Offers.DiscountAmount[]
        Description
        The discount amounts associated to the fixed price discount.
        valuenumber<double>
        Description
        Discount value.
        currencystring
        Description
        Currency for the discount value.
      - paymentDetailsRequiredboolean
        Description
        Value that indicates if payment details are required.
      - subscriptionSettingsFictiveGlobal.Api.Rest.Dtos.v1.Offers.SubscriptionSettings
        Description
        Subscription settings.
        enabledboolean
        Description
        Value that indicates if subscriptions are enabled.
        numberOfPeriodsinteger<int32>
        Description
        The number of periods the offer applies to.
        lockInPeriodsinteger<int32>
        Description
        The number of lock in periods of the offer.
        closeSubOnExpiryboolean
        Description
        Value that indicates if the subscription should close on expiry.
        serviceIdsinteger[]
        Example
        Description
        The services that the offer will apply to.
      - productSettingsFictiveGlobal.Api.Rest.Dtos.v1.Offers.ProductSettings
        Description
        Product settings.
        enabledboolean
        Description
        Value that indicates if products are enabled.
        productIdsinteger[]
        Example
        Description
        The products that the offer will apply to.
      - miscellaneousChargeSettingsFictiveGlobal.Api.Rest.Dtos.v1.Offers.MiscellaneousChargeSettings
        Description
        Miscellaneous charge settings.
        enabledboolean
        Description
        /// Value that indicates if the offer was enabled for miscellaneous charge.

401Not Authorized

403Offer is not for this affiate/account.

404Not Found

500Internal Server Error

curl

curl --request GET \
     --url https://api.fictive.com/REST/api/vouchers/{voucherCode}/validate \
     --header 'accept: application/json' \
     --header 'x-version: string'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-version", "string");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.fictive.com/REST/api/vouchers/{voucherCode}/validate", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.fictive.com/REST/api/vouchers/{voucherCode}/validate")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-version"] = "string"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.fictive.com/REST/api/vouchers/{voucherCode}/validate"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'x-version': 'string'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// OK
{
  "purchaseInfo": {
    "purchasePrice": "",
    "discountPrice": "",
    "renewalPrice": "",
    "nextPaymentsDates": [
      "2021-09-21T05:33:26.5730532"
    ]
  },
  "voucherInfo": {
    "startDate": "2021-09-21T05:33:26.6043032",
    "expiryDate": "2021-09-21T05:33:26.6043032",
    "offerInfo": {
      "name": "",
      "description": "",
      "usageType": "",
      "applicationData": {
        "name": "",
        "message": "",
        "message2": ""
      },
      "addCredits": {
        "amount": "",
        "currency": "",
        "paymentDetailsRequired": false
      },
      "lowStart": {
        "percentage": "",
        "numberOfPeriods": "",
        "lockInPeriods": "",
        "closeSubOnExpiry": false,
        "serviceIds": [
          0
        ],
        "paymentDetailsRequired": false
      },
      "percentageDiscount": {
        "percentage": "",
        "paymentDetailsRequired": false,
        "productIds": [
          0
        ]
      },
      "freePeriod": {
        "numberOfPeriods": "",
        "serviceIds": [
          0
        ],
        "paymentDetailsRequired": false
      },
      "groupDiscount": {
        "activationCodeActivated": false,
        "metaData": {
          "qualifyingItemCount": "",
          "freeItemCountOrDiscountAmount": "",
          "productIds": [
            0
          ],
          "configurationType": "",
          "productSource": "",
          "customParameters": {}
        }
      },
      "fixedPriceDiscount": {
        "discountAmounts": [
          {
            "value": "",
            "currency": ""
          }
        ],
        "paymentDetailsRequired": false,
        "subscriptionSettings": {
          "enabled": false,
          "numberOfPeriods": "",
          "lockInPeriods": "",
          "closeSubOnExpiry": false,
          "serviceIds": [
            0
          ]
        },
        "productSettings": {
          "enabled": false,
          "productIds": [
            0
          ]
        },
        "miscellaneousChargeSettings": {
          "enabled": false
        }
      }
    }
  }
}

401

// Not Authorized

403

// Offer is not for this affiate/account.

404

// Not Found

500

// Internal Server Error

Have a question?

Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.

To ask a question or participate in discussions, you'll need to authenticate first.