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. |
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. |
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>
<denomination>
<range min="5.00" max="100.00" />
</denomination>
<base-url />
<redemptions />
</product>
<product>
<name>Virtual Visa® Reward (United States) - 6-Month</name>
<sku>UVC-V-A97</sku>
<currency>USD</currency>
<denomination>
<fixed value="150.00" />
</denomination>
<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",
"denomination":{
"range":[
{
"min":5.00,
"max":100.00
}
]
},
"base-url":"",
"redemptions":[]
},
{
"name":"Virtual Visa® Reward (United States) - 6-Month",
"sku":"UVC-V-A97",
"currency":"USD",
"denomination":{
"fixed":[
{
"value":150.00,
}
]
},
"base-url":"",
"redemptions":[
{
"name":"In-Store",
"name":"Online"
}
]
},
]
}
Updated almost 3 years ago