Get Program Brand

Endpoint: https://rest.virtualincentives.com/{version}/{format}/programs/{programId}/products/{sku}

Method: GET

Definitions

FieldTypeDescription
programIdrequired
integer
The programid identifies the program.
skurequired
string(50)
Prepaid product SKU.
currencyresponse only
string
Brand currency.
countryresponse only
string(2)
Brand country (ISO 3166-2).
base-urlresponse only
string
Base URL.
redemptionsresponse only
string
List indicating redeemable brands. Values include Online and In-Store.
denominationresponse only
object
List of fixed and ranged denominations.
fixed_discountresponse only
decimal
SKU level fixed discount.
fixed_feeresponse only
decimal
SKU level fixed fee.
variable_discount_percentageresponse only
decimal
SKU level variable discount.
variable_fee_percentageresponse only
decimal
SKU level variable fee.
initial_reloadable_feeresponse only
decimal
Initial card creation fee for reloadable SKU.
faceplateresponse only
string
Client supplied unique identifier for the order.
marketingresponse only
string(500)
Marketing reward information.
termsresponse only
string(500)
Terms and Conditions for utilizing the product.
valueresponse only
decimal
Fixed denomination of the product.
minresponse only
decimal
Minimum product denomination of the range.
maxresponse only decimalMaximum product denomination of the range.

Examples

Response XML

<products>
 <product>
  <name>Virtual Visa® Reward (United States) - 3-Month</name>
  <sku>UVC-V-A96</sku>
  <currency>USD</currency>
  <country>US</country>
  <denomination>
   <range min="5.00" max="100.00" fixed_fee="1.00" variable_fee_percentage="0.02" fixed_discount="3.00" variable_discount_percentage="0.04" />
   <initial_reloadable_fee>5.00</initial_reloadable_fee>
  </denomination>
  <faceplate>www.virtualrewardcenter.com/images/cards/Virtual_Visa.png</faceplate>
 <marketing>
    The Visa Reward Card can be used to buy what you want, when you want it. 
    Because it is so flexible and convenient, the Visa Reward Card makes it easy 
    to treat yourself to something special or to help cover your everyday expenses.
    The decision is yours.
 </marketing>
 <terms>
    *Cards are issued by Citibank, N.A. pursuant to a license from.
    Visa U.S.A. Inc. and managed by Citi Prepaid Services. This
    card can be used everywhere Visa debit cards are accepted.
 </terms>
  <base-url />
  <redemptions />
 </product>
 <product>
  <name>Virtual Visa® Reward (United States) - 6-Month</name>
  <sku>UVC-V-A97</sku>
  <currency>USD</currency>
  <country>US</country>
  <denomination>
   <fixed value="150.00" fixed_fee="1.00" variable_fee_percentage="0.02" fixed_discount="3.00" variable_discount_percentage="0.04" />
   <initial_reloadable_fee>5.00</initial_reloadable_fee>
  </denomination>
  <faceplate>www.virtualrewardcenter.com/images/cards/Virtual_Visa.png</faceplate>
 <marketing>
    The Visa Reward Card can be used to buy what you want, when you want it. 
    Because it is so flexible and convenient, the Visa Reward Card makes it easy 
    to treat yourself to something special or to help cover your everyday expenses.
    The decision is yours.
 </marketing>
 <terms>
    *Cards are issued by Citibank, N.A. pursuant to a license from.
    Visa U.S.A. Inc. and managed by Citi Prepaid Services. This
    card can be used everywhere Visa debit cards are accepted.
 </terms>
  <base-url />
  <redemptions>
   <redemption>
    <name>Online</name>
   </redemption>
   <redemption>
    <name>In-Store</name>
   </redemption>
  <redemptions/>
 </product>
<products>

Response JSON

{
 "products":[
  {
   "name":"Virtual Visa® Reward (United States) - 3-Month",
   "sku":"UVC-V-A96",
   "currency":"USD",
   "country": "US",
   "denomination":{
    "range":[
     {
      "min":5.00,
      "max":100.00,
      "fixed_discount":3,
      "fixed_fee":1,
      "variable_discount_percentage":0.04,
      "variable_fee_percentage":0.02
     }
    ],
    "initial_reloadable_fee":5
    },
    "faceplate":"//www.virtualrewardcenter.com/images/cards/Virtual_Visa.png",
    "marketing":"The Visa<sup>&reg;</sup> Reward Card can be used to ,
       buy what you want when you want it. Because it is so
       flexible and convenient, the Visa Reward Card makes it easy to treat 
       yourself to something special or to help cover your everyday
       expenses. The decision is yours.",
     "terms":"*Cards are issued by Citibank, N.A. pursuant to a license from.
       Visa U.S.A. Inc. and managed by Citi Prepaid Services. This
       card can be used everywhere Visa debit cards are accepted."
   },
   "base-url":"",
   "redemptions":[]
  },
  {
   "name":"Virtual Visa® Reward (United States) - 6-Month",
   "sku":"UVC-V-A97",
   "currency":"USD",
   "country": "US",
   "denomination":{
    "denomination":{
    "fixed":[
    {
     "value":150.00,
     "fixed_discount":3,
     "fixed_fee":1,
     "variable_discount_percentage":0.04,
     "variable_fee_percentage":0.02
     }
    ],
    "initial_reloadable_fee":5
    },
    "faceplate":"//www.virtualrewardcenter.com/images/cards/Virtual_Visa.png",
    "marketing":"The Visa<sup>&reg;</sup> Reward Card can be used to ,
       buy what you want when you want it. Because it is so
       flexible and convenient, the Visa Reward Card makes it easy to treat 
       yourself to something special or to help cover your everyday
       expenses. The decision is yours.",
     "terms":"*Cards are issued by Citibank, N.A. pursuant to a license from.
       Visa U.S.A. Inc. and managed by Citi Prepaid Services. This
       card can be used everywhere Visa debit cards are accepted."
   },
   "base-url":"",
   "redemptions":[
    {
     "name":"In-Store",
     "name":"Online"
    } 
   ]
  },
 ]
}