Manage Choice products

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. See About Choice product.

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:

FunctionPurpose
GET {URI}/choiceProductsGet all available Choice products.

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

ParameterData typeDescription
rewardNamestringSpecify the reward name to be queried.
currencyCodestringSpecify the currency code to be queried.
countriesarray of stringsSpecify 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:

FunctionPurpose
GET {URI}/choiceProducts/{choiceProductUtid}/catalogGet catalog for a specific Choice product utid.

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

ParameterData typeDescription
choiceProductUtidstringSpecify the reward name to be queried.

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

ParameterData typeDescription
verbosebooleanWhen true, will return the additional brand fields: status, disclaimer, description, shortDescription, terms, brandRequirements collection, and imageUrls collection.
brandKeystringReturns the brand and item details for a specific brand ID.
brandNamestringReturns the brand and item details for a specific brand name.
utidstringReturns the brand and item details for a specific utid. The utid is the unique identifier for a specific reward.
rewardNamestringReturns the brand and item details of the specified reward name.
statusstringReturns all brands and item details with the specified status. Possible statuses are: Test, Active, Inactive, Deleted.
currencyCodestringReturn all brands and item details associated with a specific currency.
countrystringReturns all brands and item details from a specific country.
fulfillmentTypearray of stringsReturns all brands and item details for a specific fulfillment type: digital and physical.
categoryIdsarray of stringsReturns 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.

isExpirable indicates whether or not the gift card has an expiry date. The value for isExpirable =boolean is true or 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",
          "isExpirable": boolean",
          "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.
isExpirable indicates whether or not the gift card has an expiry date. The value for isExpirable =boolean is true or 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",
          "isExpirable": boolean",
          "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:

FunctionPurpose
GET {URI}/choiceProducts/{utid}Get details for a specific Choice Product.

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

ParameterData typeDescription
utidstring(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

Rewards as a Service™ and the RaaS® API are provided by Tango Card, Inc. © 2024 Tango Card, Inc.