Get embedded URL

Use this Tango endpoint to obtain the secure, temporary embedded reward URL after placing an order. You later use this URL to integrate Tango's landing page into your application, eliminating the need to send rewards via email, or open a separate browser window/tab. See Gift card experience to learn about his feature.

Endpoint

Not all UTIDs support embedded URL. Use the following endpoint to get an embedded URL for eligible rewards:

How does it work?

If a UTID supports embedded, you can:

1. Use GET {URI}/catalogs to list all UTIDs available in catalog. The UTIDs provide itemAttribute which shows the delivery method.
2. Take the UTID with the embedded delivery method and place an order with POST {URI}/orders.
3. After placing the order, the response payload returns a referenceLineItemID.
4. Use that referenceLineItemID to call the GET {URI}/lineItems/{referenceLineItemID}/embeddedUrl endpoint to return a URL with a temporary token.
5. Embed the token in your software iFrame to load the reward experience into your application:
   • The token expires after five minutes and is evaluated on page load.
   • Once displayed, your recipient has eight hours to unlock the reward.

📘

Note:

This endpoint only works for items that return credentialTypesof rewardSecurityUrland rewardSecurityCode.

Parameters

The following path parameter can be used for this endpoint:

Examples

Here's an example payload of a successful response:

{
  "url": "https://sandbox.rewardcodes.com/r2/1/F4I45887987"
}

Response codes

The possible response codes for this endpoint are as follows. For details, see i18nkey codes and their error messages: