View Catalog
A Catalog is a named collection of rewards. All rewards must be attached to a catalog to place an order and send to a recipient. Each reward has a Unique Tango Identifier (UTID) that is used when placing an order. Each Platform has its own catalog and is established when the platform is set up. The Catalog can be changed at any time by contacting Tango.
Tango offers rewards in a variety of domestic and international branded gift cards such as those of physical stores and online retailers, prepaid cards, digital delivery of grocery and restaurant food, donations to charitable foundations, or our own Tango Choice Product (Reward Link, Promotion Link, or Disbursement Link). Using Tango API, you can view items in the platform catalog, the reward brand details, and the reward brand item (UTID) detailed information used for placing an order. For a complete list of our rewards catalog, see the full Tango Catalog.
API users that create their own in-app catalog should keep in mind that reward parameters may change from time to time. Brands often update their images, description, terms, redemption instructions, and sometimes even their names and available denominations. Use the UTID and Brand Key as your primary identifier for programmatic decisions.
Warning!
We recommend to call
GET {URI}/catalogs
endpoint semi-daily (at most) to check the current list of content and their status. This catalog endpoint should not be used per individual order or with frequent polling system.
Get all items in the platform catalog
Use GET {URI}/catalogs
endpoint to get all items in the platform's Catalog:
Endpoint | Purpose |
---|---|
GET {URI}/catalogs | Get all items in the platform's catalog. It provides the credential types information for each item in the Catalog. See about Get Credential Types . |
Catalog filters
Perform GET {URI}/catalogs
to get details for specific items or groupings using the following endpoint filters:
Endpoint Filter | Description |
---|---|
GET {URI}/catalogs?utid={{utid}} | Return the details for a specific item (utid). |
GET {URI}/catalogs?brandKey={{brandKey}} | Return all the items and details for a specific brand. |
GET {URI}/catalogs?currencyCode=*{{currencyCode}} | Return items of a specific currency. |
GET {URI}/catalogs?country=((2-digit country code)) | Return items from a specific country; the value can be found in the countries collection. |
Here are the query parameters:
Query Parameter | Data Type | Description |
---|---|---|
verbose | boolean (false/true) | When true, returns additional brand fields: status, disclaimer, description, shortDescription, terms, brandRequirements collection, and imageUrls collection. |
brandKey | string | Returns the brand and item details for a specific brand ID. |
brandName | string | Returns the brand and item details for a specific brand name. |
utid | string | Returns the brand and item details for a specific utid. The utid is the unique identifier for a specific reward. |
rewardName | string | Returns the brand and item details of the specified reward name. |
status | string | Returns all brands and item details with the specified status. Possible statuses are: “test", “active", “inactive", "deleted". |
currencyCode | string | Return all brands and item details associated with a specific currency. |
country | string | Returns all brands and item details from a specific country. Country codes are two-digits. |
The response code for this endpoint is:
- 200 OK
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
Retrieve Catalog items when verbose is True
Use the GET {URI}/catalogs
endpoint to view the items in your platform’s catalog and see what you can order. The following payload is with verbose=true. When the verbose is true, it returns the additional brand fields, such as status, disclaimer, description, shortDescription, terms, brandRequirements collection, and imageUrls collection:
{
"catalogName": "BrianBiz120ca73b-51d6-4b9",
"brands": [
{
"brandKey": "B077325",
"brandName": "Reward Link Preferred",
"disclaimer": "<p>THE FOLLOWING TERMS AND CONDITIONS APPLY TO REWARD LINK: Reward Link is managed by Tango, Inc. Reward Links expire on the date stated on the Reward and are valid within the USA only. Reward Links are issued to Reward Recipient without charge for loyalty, award, or promotional purposes, and are not sold to consumers. Your Reward Link balance may be redeemed for national gift cards and can be accessed at any time by clicking the Reward Link URL. Reward can only be redeemed by the Reward Recipient; Reward cannot be transferred, sold or exchanged. All redemptions are final. Reward Link balances from different programs cannot be combined. No fees apply to Reward Link. Please treat like cash. Please view our full terms of service at <a href="https://www.rewardsgenius.com/reward-link-terms-of-service\"https://www.rewardsgenius.com/reward-link-terms-of-service</a>.> Use of this Reward constitutes acceptance of the Reward Link terms of service. Separate terms and conditions apply after Reward Link redemption based on merchant selected for redemption.</p>\r\n",
"description": "<p>A Reward Link is simply the easiest way to give the gift of choice. You'll find dozens of premium gift cards, and with digital delivery you will receive the reward value instantly. You are a few simple clicks away from choosing the gift card you really want.</p>\r\n",
"shortDescription": "<p>A Reward Link is simply the easiest way to give the gift of choice. You'll find dozens of premium gift cards, and with digital delivery you will receive the reward value instantly. You are a few simple clicks away from choosing the gift card you really want.</p>\r\n",
"terms": "<p>THE FOLLOWING TERMS AND CONDITIONS APPLY TO REWARD LINK: Reward Link is managed by Tango, Inc. Reward Links expire on the date stated on the Reward and are valid within the USA only. Reward Links are issued to Reward Recipient without charge for loyalty, award, or promotional purposes, and are not sold to consumers. Your Reward Link balance may be redeemed for national gift cards and can be accessed at any time by clicking the Reward Link URL. Reward can only be redeemed by the Reward Recipient; Reward cannot be transferred, sold or exchanged. All redemptions are final. Reward Link balances from different programs cannot be combined. No fees apply to Reward Link. Please treat like cash. Please view our full terms of service at <a href="https://www.rewardsgenius.com/reward-link-terms-of-service\"https://www.rewardsgenius.com/reward-link-terms-of-service</a>.> Use of this Reward constitutes acceptance of the Reward Link terms of service. Separate terms and conditions apply after Reward Link redemption based on merchant selected for redemption.</p>\r\n",
"createdDate": "2016-10-14T20:46:49Z",
"lastUpdateDate": "2019-01-14T22:33:08Z",
"brandRequirements": {
"displayInstructions": "",
"termsAndConditionsInstructions": "",
"disclaimerInstructions": "",
"alwaysShowDisclaimer": false
},
"imageUrls": {
"80w-326ppi": "https://dwwvg90koz96l.cloudfront.net/images/brands/b674993-80w-326ppi.png",
"130w-326ppi": "https://dwwvg90koz96l.cloudfront.net/images/brands/b674993-130w-326ppi.png",
"200w-326ppi": "https://dwwvg90koz96l.cloudfront.net/images/brands/b674993-200w-326ppi.png",
"278w-326ppi": "https://dwwvg90koz96l.cloudfront.net/images/brands/b674993-278w-326ppi.png",
"300w-326ppi": "https://dwwvg90koz96l.cloudfront.net/images/brands/b674993-300w-326ppi.png",
"1200w-326ppi": "https://dwwvg90koz96l.cloudfront.net/images/brands/b674993-1200w-326ppi.png"
},
"status": "active",
"items": [
{
"utid": "U561593",
"rewardName": "Reward Link",
"currencyCode": "USD",
"status": "active",
"valueType": "VARIABLE_VALUE",
"rewardType": "reward link",
"isWholeAmountValueRequired": false,
"minValue": 0.01,
"maxValue": 2000,
"createdDate": "2016-11-01T17:18:31.027Z",
"lastUpdateDate": "2020-05-13T16:10:18.44Z",
"countries": [
"US"
],
"credentialTypes": [
"expirationDate",
"redemptionUrl"
],
"redemptionInstructions": "<p><a href="https://www.rewardsgenius.com/reward-link-terms-of-service/\"Read> Terms & Conditions</a></p>\r\n\r\n<ul>\r\n\t<li>Click the redemption link above to activate your Reward Link.</li>\r\n\t<li>Next, you will be able to spend your balance on retail gift cards.</li>\r\n</ul>\r\n\r\n<p>If you don't want to spend your entire Reward Link value right away, save the email or URL and return via the redemption link before the expiration date provided with your Reward Link.</p>\r\n"
}
]
}
]
}
Retrieve Catalog items when verbose is False
Use the GET {URI}/catalogs
endpoint, to retrieve catalog items. The following response shows the most relevant fields when verbose=false:
{
"catalogName": "TangoCard417306f0-be34-46",
"brands": [
{
"brandKey": "B734388",
"brandName": "Amazon.ca",
"createdDate": "2016-07-12T23:48:48Z",
"lastUpdateDate": "2022-02-24T19:47:26Z",
"items": [
{
"utid": "U126596",
"rewardName": "Amazon.ca Gift Certificate",
"currencyCode": "CAD",
"status": "active",
"valueType": "VARIABLE_VALUE",
"rewardType": "gift card",
"isWholeAmountValueRequired": false,
"minValue": 0.05,
"maxValue": 2000,
"createdDate": "2022-02-22T22:31:30.845Z",
"lastUpdateDate": "2022-02-24T19:46:55.204Z",
"countries": [
"CA"
],
"credentialTypes": [
"cardNumber",
"rewardSecurityCode",
"rewardSecurityUrl"
],
"redemptionInstructions": "<p>Click the Redemption URL and enter Security Code to access the redemption instructions on the landing page.</p>\n<p><strong>Please note: the Security Code above is not the rewards Claim Code used at checkout. Please only use the Claim Code provided on the following landing page.</strong></p>\n<p> </p>\n<p> </p>\n<p>Cliquez sur l'URL d'échange et saisissez le code de sécurité pour accéder aux instructions d'échange sur la page de destination.</p>\n<p><strong>Veuillez noter : le code de sécurité ci-dessus n'est pas le code de réclamation des récompenses utilisé lors du paiement. Veuillez utiliser uniquement le code de réclamation fourni sur la page de destination suivante.</strong></p>"
}
Check item Availability
Note:
- Item availability is on limited release. Contact your Tango representative or email Technical Support specialists at [email protected] for more questions.
When placing an order, an item may or may not be available. The ItemAvailability will provide details such as when we are experiencing an issue or when the item is no longer available.
Note:
To avoid performance issues, only use ItemAvailability with a utid filter for a specific gift card, and verbose = true. Do not check the ItemAvailability for the entire catalog when utid= blank/null.
The following code structure shows item availability payload retrieved using GET {URI}/catalogs
when verbose=true:
"itemAvailability": {
"itemAvailabilityStatus": "Availability Status",
"note": "string",
"resolutionDate": "2022-12-22T00:06:30.401Z",
"statusPageUrl": "string",
"lastModifiedDate": "2022-12-22T00:06:30.401Z"
}
Note:
When the item availability status is “Available”, the note, resolutionDate, statusPageUrl, and lastModifiedDate is not returned in the payload (null).
The following table shows the list of statuses for an utid (item) returned by ItemAvailabilityStatus:
Availability Status | Description |
---|---|
AVAILABLE | This item is available for ordering. |
DEGRADED | This item is currently experiencing higher than usual errors. We are working to restore this item for you. We will have an update for you shortly. |
UNAVAILABLE | This item is currently unavailable. We are working to restore this item for you. We will have an update for you shortly. |
DEPRECAED | This item is permanently unavailable. |
"itemAvailability": {
"itemAvailabilityStatus": "AVAILABLE",
"note": "resolution date added",
"resolutionDate": "2021-07-22T07:00:00Z",
"statusPageUrl": "https://www.tangocard.com",
"lastModifiedDate": "2021-07-06T20:51:14.943Z"
}
Other response parameters may include:
- notes: Any relevant notes regarding availability. The notes are entered manually by the user.
- resolutionDate: If known, the anticipated date to return to the Available status. The resolutionDate is manually entered by the user.
- statusPageUrl: If applicable, contains a link to the StatusPage posting, subscribe to updates available. statusPageUrl is a manual field that contains a link to a manually-created StatusPage entry.
- lastModifiedDate: Shows the most recent update and is an automated timestamp.
Coming soon:
The global attribute of lang helps define the language of your catalog. For example,
<span lang=“US-EN”>This is the English Text</span>
shows the US English language and<span lang=“CA-FR”>This is the French Canadian text</span>
shows the Canadian French.
See the example payload below for when utid=U561593 and verbose=true:
{
"catalogName": "Don_Testd6c0e6dc-6ed2-4013-a305-47785fe30cf8",
"brands": [
{
"brandKey": "B077325",
"brandName": "Reward Link Preferred",
"disclaimer": "<p>THE FOLLOWING TERMS AND CONDITIONS APPLY TO REWARD LINK: Reward Link is managed by Tango, Inc. Reward Links expire on the date stated on the Reward and are valid within the USA only. Reward Links are issued to Reward Recipient without charge for loyalty, award, or promotional purposes, and are not sold to consumers. Your Reward Link balance may be redeemed for national gift cards and can be accessed at any time by clicking the Reward Link URL. Reward can only be redeemed by the Reward Recipient; Reward cannot be transferred, sold or exchanged. All redemptions are final. Reward Link balances from different programs cannot be combined. No fees apply to Reward Link. Please treat like cash. Please view our full terms of service at <a href=\"https://www.rewardsgenius.com/reward-link-terms-of-service\">https://www.rewardsgenius.com/reward-link-terms-of-service</a>. Use of this Reward constitutes acceptance of the Reward Link terms of service. Separate terms and conditions apply after Reward Link redemption based on merchant selected for redemption.</p>\r\n",
"description": "<p>A Reward Link is simply the easiest way to give the gift of choice. You’ll find dozens of premium gift cards, and with digital delivery you will receive the reward value instantly. You are a few simple clicks away from choosing the gift card you really want.</p>\r\n",
"shortDescription": "<p>A Reward Link is simply the easiest way to give the gift of choice. You’ll find dozens of premium gift cards, and with digital delivery you will receive the reward value instantly. You are a few simple clicks away from choosing the gift card you really want.</p>\r\n",
"terms": "<p>THE FOLLOWING TERMS AND CONDITIONS APPLY TO REWARD LINK: Reward Link is managed by Tango, Inc. Reward Links expire on the date stated on the Reward and are valid within the USA only. Reward Links are issued to Reward Recipient without charge for loyalty, award, or promotional purposes, and are not sold to consumers. Your Reward Link balance may be redeemed for national gift cards and can be accessed at any time by clicking the Reward Link URL. Reward can only be redeemed by the Reward Recipient; Reward cannot be transferred, sold or exchanged. All redemptions are final. Reward Link balances from different programs cannot be combined. No fees apply to Reward Link. Please treat like cash. Please view our full terms of service at <a href=\"https://www.rewardsgenius.com/reward-link-terms-of-service\">https://www.rewardsgenius.com/reward-link-terms-of-service</a>. Use of this Reward constitutes acceptance of the Reward Link terms of service. Separate terms and conditions apply after Reward Link redemption based on merchant selected for redemption.</p>\r\n",
"createdDate": "2016-10-14T20:46:49Z",
"lastUpdateDate": "2022-07-14T01:02:51Z",
"brandRequirements": {
"displayInstructions": "",
"termsAndConditionsInstructions": "",
"disclaimerInstructions": "",
"alwaysShowDisclaimer": false
},
"imageUrls": {
"80w-326ppi": "https://dwwvg90koz96l.cloudfront.net/images/brands/b077325-80w-326ppi.png",
"130w-326ppi": "https://dwwvg90koz96l.cloudfront.net/images/brands/b077325-130w-326ppi.png",
"200w-326ppi": "https://dwwvg90koz96l.cloudfront.net/images/brands/b077325-200w-326ppi.png",
"278w-326ppi": "https://dwwvg90koz96l.cloudfront.net/images/brands/b077325-278w-326ppi.png",
"300w-326ppi": "https://dwwvg90koz96l.cloudfront.net/images/brands/b077325-300w-326ppi.png",
"1200w-326ppi": "https://dwwvg90koz96l.cloudfront.net/images/brands/b077325-1200w-326ppi.png"
},
"status": "active",
"items": [
{
"utid": "U561593",
"rewardName": "Reward Link Preferred",
"currencyCode": "USD",
"status": "active",
"valueType": "VARIABLE_VALUE",
"rewardType": "reward link",
"isWholeAmountValueRequired": false,
"minValue": 0.01,
"maxValue": 2000,
"createdDate": "2016-11-01T17:18:31.027Z",
"lastUpdateDate": "2022-04-27T20:23:02.196Z",
"countries": [
"US"
],
"credentialTypes": [
"expirationDate",
"redemptionUrl"
],
"redemptionInstructions": "<p><a href=\"https://www.rewardsgenius.com/reward-link-terms-of-service/\">Read Terms & Conditions</a></p>\n<ul>\n<li>Click the redemption link above to activate your Reward Link.</li>\n<li>Next, you will be able to spend your balance on retail gift cards.</li>\n</ul>\n<p>If you don't want to spend your entire Reward Link value right away, save the email or URL and return via the redemption link.</p>",
"itemAvailability": {
"itemAvailabilityStatus": "AVAILABLE"
}
}
]
}
]
}
GET {URI}/catalogs
provides the credential types information for each item in the catalog. See our topic on how to Get Credential Types.
Updated 21 days ago