Get Program Brand
Endpoint: https://rest.virtualincentives.com/{version}/{format}/programs/{programId}/products/{sku}
Method: GET
Definitions
Field | Type | Description |
---|---|---|
programId | required integer | The programid identifies the program. |
sku | required string(50) | Prepaid product SKU. |
currency | response only string | Brand currency. |
country | response only string(2) | Brand country (ISO 3166-2). |
base-url | response only string | Base URL. |
redemptions | response only string | List indicating redeemable brands. Values include Online and In-Store . |
denomination | response only object | List of fixed and ranged denominations. |
fixed_discount | response only decimal | SKU level fixed discount. |
fixed_fee | response only decimal | SKU level fixed fee. |
variable_discount_percentage | response only decimal | SKU level variable discount. |
variable_fee_percentage | response only decimal | SKU level variable fee. |
initial_reloadable_fee | response only decimal | Initial card creation fee for reloadable SKU. |
faceplate | response only string | Client supplied unique identifier for the order. |
marketing | response only string(500) | Marketing reward information. |
terms | response only string(500) | Terms and Conditions for utilizing the product. |
value | response only decimal | Fixed denomination of the product. |
min | response only decimal | Minimum product denomination of the range. |
max | response only decimal | Maximum 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>®</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>®</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"
}
]
},
]
}
Updated 11 months ago