Manage Choice products

At Tango, we offer Choice Products such as Reward Link® (RL), Promo Link (PL), and Disbursement Link (DL):

Reward Link

Reward Link is a web link distributed by your program or organization to your recipients that allows them to make their own gift card selection. Reward link holds monetary value and allows your recipient to spend that balance on a variety of popular gift cards or prepaid cards of their choice. Some links also provide the option to donate all or a portion of their balance to a select number of charities.

Promo Link

Promo Link is a web link sent by your program or organization to your recipients to incentivize your audience with a choice of digital gift cards and reclaim any unredeemed funds.

Promo Link acceptance criteria

The following rules and acceptance criteria applies to Promo Link when placing an order:

Set a specific expiration date (such as12/31/24) for a Promo Link at the time of order via Tango API.
The expiration date must be at least one (1) day in the future (compared to the order date/time) and should not be longer than 1 year into the future.
Specify the timezone, with the timezone specified by (+/-) X hours offset from UTC (see ISO 8601). For example, 2023-10-12T09:18:12.123-07:00 is PDT. If no timezone is specified, it is assumed to be in the timezone the server is set to.

Disbursement Link

Disbursement Link is a web link sent by your program or organization to your recipients to save time on payouts, and your recipients choose how they get paid. With Disbursement Link, your recipients can get money directly.

How to view the Choice products in your catalog

To determine what Choice Products are in your Tango platform's catalog, view the catalog contents of a specific Choice Product, or view the details for a specific Choice product, see our endpoints and instructions below:

Get all available Choice products

Use the GET {URI}/choiceProducts endpoint to get a list of the Choice Products in your Tango platform's catalog:

Function	Purpose
`GET {URI}/choiceProducts`	Get all available Choice products.

Here are the query parameters for theGET {URI}/choiceProducts\ :

Parameter	Data type	Description
rewardName	string	Specify the reward name to be queried.
currencyCode	string	Specify the currency code to be queried.
countries	array of strings	Specify the list of countries to be queried.

TheGET {URI}/choiceProducts payload returns all available Choice Products in your Tango platform's catalog:

{
  "choiceProducts": [
    {
      "utid": "string",
      "rewardName": "string",
      "currencyCode": "string",
      "countries": [
        "string"
      ]
    }
  ]
}

The following payload is an example of Tango Choice products in a platform's catalog:

{
  "choiceProducts": [
    {
      "utid": "U346020",
      "rewardName": "Disbursement Link",
      "currencyCode": "USD",
      "status": "active",
      "countries": [
        "US"
      ],
   },
    {
      "utid": "U088323",
      "rewardName": "Promo Link",
      "currencyCode": "USD",
      "status": "active",
      "countries": [
        "US"
      ]
    },
    {
          "utid": "U561593",
          "rewardName": "Reward Link Preferred + Donations",
          "currencyCode": "USD",
          "status": "active",
          "countries": [
            "US"
          ]
    }
]
}

The possible HTTP response status codes for this endpoint are:

200 OK
400 Bad request
401 Unauthorized
403 Forbidden

Get catalog for a specific Choice product UTID

Use the GET {URI}/choiceProducts/{choiceProductUtid}/catalog endpoint to get the catalog for a specific Choice Product in your Tango platform:

Function	Purpose
`GET {URI}/choiceProducts/{choiceProductUtid}/catalog`	Get catalog for a specific Choice product utid.

The following path parameter is used forGET {URI}/choiceProducts/{choiceProductUtid}/catalog:

Parameter	Data type	Description
choiceProductUtid	string	Specify the reward name to be queried.

The following query parameters are used forGET {URI}/choiceProducts/{choiceProductUtid}/catalog:

Parameter	Data type	Description
verbose	boolean	When true, will return the 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.
fulfillmentType	array of strings	Returns all brands and item details for a specific fulfillment type: digital and physical.
categoryIds	array of strings	Returns all brands and item details for specific brand categories. (coming in Q1 of 2024)

The GET {URI}/choiceProducts/{choiceProductUtid}/catalog endpoint payload returns the catalog for a specific Choice Product UTID for when verbose=true.

{
  "catalogName": "string",
  "brands": [
    {
      "brandKey": "string",
      "brandName": "string",
      "disclaimer": "string",
      "description": "string",
      "shortDescription": "string",
      "terms": "string",
      "createdDate": "2023-10-13T19:36:05.393Z",
      "lastUpdateDate": "2023-10-13T19:36:05.393Z",
      "brandRequirements": {
        "displayInstructions": "string",
        "termsAndConditionsInstructions": "string",
        "disclaimerInstructions": "string",
        "alwaysShowDisclaimer": true
      },
      "imageUrls": {
        "additionalProp": "string"
      },
      "status": "string",
      "items": [
        {
          "utid": "string",
          "rewardName": "string",
          "currencyCode": "string",
          "status": "string",
          "valueType": "string",
          "rewardType": "string",
          "isWholeAmountValueRequired": true,
          "exchangeRateRule": "string",
          "minValue": 0,
          "maxValue": 0,
          "faceValue": 0,
          "fee": {
            "type": "string",
            "value": 0
          },
          "createdDate": "2023-10-13T19:36:05.393Z",
          "lastUpdateDate": "2023-10-13T19:36:05.393Z",
          "countries": [
            "string"
          ],
          "credentialTypes": [
            "string"
          ],
          "redemptionInstructions": "string",
          "itemAvailability": {
            "itemAvailabilityStatus": "OPERATIONAL",
            "note": "string",
            "resolutionDate": "2023-10-13T19:36:05.393Z",
            "statusPageUrl": "string",
            "lastModifiedDate": "2023-10-13T19:36:05.393Z"
          },
          "fulfillmentType": "DIGITAL"
        }
      ],
      "categories": [
        {
          "identifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "description": "string"
        }
      ]
    }
  ]
}

The GET {URI}/choiceProducts/{choiceProductUtid}/catalog endpoint payload returns the catalog for a specific Choice Product UTID when the verbose=false:

{
  "catalogName": "string",
  "brands": [
    {
      "brandKey": "string",
      "brandName": "string",
      "disclaimer": "string",
      "description": "string",
      "shortDescription": "string",
      "terms": "string",
      "createdDate": "2023-10-13T19:36:05.393Z",
      "lastUpdateDate": "2023-10-13T19:36:05.393Z",
      "brandRequirements": {
        "displayInstructions": "string",
        "termsAndConditionsInstructions": "string",
        "disclaimerInstructions": "string",
        "alwaysShowDisclaimer": true
      },
      "imageUrls": {
        "additionalProp": "string"
      },
      "status": "string",
      "items": [
        {
          "utid": "string",
          "rewardName": "string",
          "currencyCode": "string",
          "status": "string",
          "valueType": "string",
          "rewardType": "string",
          "isWholeAmountValueRequired": true,
          "exchangeRateRule": "string",
          "minValue": 0,
          "maxValue": 0,
          "faceValue": 0,
          "fee": {
            "type": "string",
            "value": 0
          },
          "createdDate": "2023-10-13T19:36:05.393Z",
          "lastUpdateDate": "2023-10-13T19:36:05.393Z",
          "countries": [
            "string"
          ],
          "credentialTypes": [
            "string"
          ],
          "redemptionInstructions": "string",
          "itemAvailability": {
            "itemAvailabilityStatus": "OPERATIONAL",
            "note": "string",
            "resolutionDate": "2023-10-13T19:36:05.393Z",
            "statusPageUrl": "string",
            "lastModifiedDate": "2023-10-13T19:36:05.393Z"
          },
          "fulfillmentType": "DIGITAL"
        }
      ],
      "categories": [
        {
          "identifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "description": "string"
        }
      ]
    }
  ]
}

The response message for this endpoint is:

200 OK
400 Bad request
401 Unauthorized
403 Forbidden

Get details for a specific Choice product

Use theGET {URI}/choiceProducts/{utid}endpoint to return the details for a specific Choice Product on your Tango platform:

Function	Purpose
`GET {URI}/choiceProducts/{utid}`	Get details for a specific Choice Product.

The following path parameter is used forGET {URI}/choiceProducts/{utid}:

Parameter	Data type	Description
utid	string	(Required) Specify the unique identifier of the Choice Product to be queried.

The GET {URI}/choiceProducts/{utid} endpoint payload returns details for a specific Choice Product on your Tango platform:

{
  "utid": "string",
  "rewardName": "string",
  "currencyCode": "string",
  "countries": [
    "string"
  ]
}

The response message for this endpoint is:

200 OK
400 Bad request
401 Unauthorized
403 Forbidden