Sample API Workflow

Overview

You can explore the API by using our reference documentation/ test console. Our test console comes with default credentials you can use for exploring our API. Do not enter proprietary/confidential information in the default platform provided. This default platform is available to the public and any information you enter can be retrieved by others.

When you are ready, contact [email protected] to request your own sandbox credentials and schedule an API review.

Once you receive your own credentials you can set up your organization in our Sandbox environment.

Sample Workflow

Retrieve Platform Name and Key

1. Retrieve your platform name and key, provided by Tango Card securely or via Rewards Genius

Create Customer Identifier

2. Create a Customer Identifier (must be lowercase).

{
  "customerIdentifier": "string",
  "displayName": "string"
}

Create Account Identifier

3. Create a n Account Identifier under the Customer you created. (must be lowercase).

{
  "accountIdentifier": "string",
  "contactEmail": "string",
  "displayName": "string"
}

Register Credit Card

4. Register a Fake Credit Card to your Account Funding Operations

{
  "accountIdentifier": "accountId",
  "billingAddress": {
    "addressLine1": "123 Street",
    "addressLine2": "Suite 456",
    "city": "Seattle",
    "country": "US",
    "emailAddress": "[email protected]",
    "firstName": "First",
    "lastName": "Last",
    "postalCode": "12345",
    "state": "WA"
  },
  "creditCard": {
    "expiration": "2025-12",
    "number": "4111111111111111",
    "verificationNumber": "123"
  },
  "customerIdentifier": "customerId",
  "ipAddress": "100.10.SAMPLE.10",
  "label": "Test Card"
}

Fund Account

Fund your account.

{
  "accountIdentifier": "accountId",
  "amount": 1000,
  "creditCardToken": "aedafa88-9363-4d1a-a812-a912ceff2c98",
  "customerIdentifier": "customerId"
}

Check Balance

View your account balance. Perform a GET …/accounts to confirm the funding of your Account. Note your balance.

{
    "accountIdentifier": "string",
    "accountNumber": "string",
    "displayName": "string",
    "currencyCode": "USD",
    "currentBalance": 7850.94,
    "createdAt": "2016-07-19T18:19:30.855Z",
    "status": "ACTIVE",
    "contactEmail": "[email protected]"
}

Retrieve Catalog Items

See what you can order in your catalog. Perform GET …/catalogs call to view the items in your platform’s catalog.

{
    "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 Card, 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.&nbsp;You&rsquo;ll find dozens of premium gift cards, and with digital delivery you will receive the reward value instantly.&nbsp;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.&nbsp;You&rsquo;ll find dozens of premium gift cards, and with digital delivery you will receive the reward value instantly.&nbsp;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 Card, 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 &amp; 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&#39;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"
                }
            ]
        }
    ]
}

Create an Order

Create an order. Perform a POST .../orders call to order one of the UTIDs that was returned in your GET catalog call.

{
  "accountIdentifier": "accountId",
  "amount": 10,
  "campaign": "",
  "customerIdentifier": "customerId",
  "emailSubject": "",
  "externalRefID": "",
  "message": "",
  "notes": "",
  "recipient": {
    "email": "[email protected]",
    "firstName": "First",
    "lastName": ""
  },
  "sendEmail": true,
  "sender": {
    "email": "",
    "firstName": "",
    "lastName": ""
  },
  "utid": "U561593"
}

Check Balance

Observe your adjusted balance. Perform a GET …/accounts call or GET /accounts/{accountName} call to see the adjusted balance of your account following the order.

RESPONSE
{
    "accountIdentifier": "accountId",
    "accountNumber": "A123456",
    "displayName": "Account Name",
    "currencyCode": "USD",
    "currentBalance": 9127.88,
    "createdAt": "2016-07-19T18:19:30.855Z",
    "status": "ACTIVE",
    "contactEmail": "[email protected]"
}

Retrieve an Order

View a past order. Perform a GET .../orders/{referenceOrderID} call to view the details of an order you have already sent

{
    "referenceOrderID": "RA123456-7890-12",
    "externalRefID": "",
    "customerIdentifier": "customerId",
    "accountIdentifier": "accountId",
    "accountNumber": "A123456",
    "amountCharged": {
        "value": 10.00,
        "currencyCode": "USD",
        "total": 10.0
    },
    "denomination": {
        "value": 10,
        "currencyCode": "USD"
    },
    "utid": "U561593",
    "rewardName": "Reward Link",
    "sender": {
        "firstName": "",
        "lastName": "",
        "email": ""
    },
    "recipient": {
        "email": "[email protected]",
        "firstName": "First",
        "lastName": "Last"
    },
    "emailSubject": "",
    "message": "",
    "sendEmail": true,
    "etid": "E000000",
    "status": "COMPLETE",
    "campaign": "",
    "createdAt": "2020-12-22T18:23:23.472Z",
    "notes": "",
    "reward": {
        "credentials": {
            "Redemption Link": "https://sandbox.rewardlink.io/r/1/_KBqZ9x056xOCrp34qxM74R2KQqYJlHoaJKZAXbwkSQ",
            "Expiration": ""
        },
        "credentialList": [
            {
                "label": "Redemption Link",
                "value": "https://sandbox.rewardlink.io/r/1/_KBqZ9x056xOCrp34qxM74R2KQqYJlHoaJKZAXbwkSQ",
                "type": "url",
                "credentialType": "redemptionUrl"
            },
            {
                "label": "Expiration",
                "value": "",
                "type": "date",
                "credentialType": "expirationDate"
            }
        ],
        "redemptionInstructions": "<p><a href=\"https://www.rewardsgenius.com/reward-link-terms-of-service/\">Read Terms &amp; 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&#39;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 Line Items

Use the /lineItems endpoint to retrieve a list of line items ordered.

GET https://{URI} /lineItems

Sample Response

{
  "keysetPage": {
    "nextPageKeys": [
      "1668601997675",
      "RA123456-12345-12-1"
    ],
    "previousPageKeys": [
      "1668802913953",
      "RA123456-12345-12-1"
    ],
    "resultCount": 20,
    "totalCount": 10000
  },
  "lineItems": [
    {
      "referenceLineItemID": "RA123456-12345-12-1",
      "referenceOrderID": "RA123456-12345-12",
      "orderSource": "RA",
      "status": "COMPLETE",
      "orderStatus": "COMPLETE",
      "emailStatus": "DELIVERED",
      "lineNumber": 1,
      "rewardName": "Reward Link Preferred",
      "amountIssued": {
        "value": 5,
        "currencyCode": "USD"
      },
      "dateIssued": "2022-11-29T21:05:13Z",
      "accountNumber": "A12345678",
      "accountIdentifier": "byTestAccount",
      "etid": "E000000",
      "utid": "U561593",
      "customerIdentifier": "byTestCustomer",
      "recipient": {
        "email": "[email protected]",
        "firstName": "xxx",
        "lastName": "xxxx"
      }
    },
    {
      "referenceLineItemID": "RA123456-12345-12-1",
      "referenceOrderID": "RA123456-12345-12",
      "orderSource": "RA",
      "status": "COMPLETE",
      "orderStatus": "COMPLETE",
      "emailStatus": "DELIVERED",
      "lineNumber": 1,
      "rewardName": "Reward Link Preferred",
      "amountIssued": {
        "value": 5,
        "currencyCode": "USD"
      },
      "dateIssued": "2022-11-22T17:58:25Z",
      "accountNumber": "A12345678",
      "accountIdentifier": "byTestAccount",
      "etid": "E000000",
      "utid": "U561593",
      "customerIdentifier": "byTestCustomer",
      "recipient": {
        "email": "[email protected]",
        "firstName": "xxxx",
        "lastName": "xxxxx"
      }
    },
    {
      "referenceLineItemID": "R123456-12345-12-1",
      "referenceOrderID": "RA123456-12345-12",
      "orderSource": "RA",
      "status": "COMPLETE",
      "orderStatus": "COMPLETE",
      "emailStatus": "DELIVERED",
      "lineNumber": 1,
      "rewardName": "Reward Link Preferred",
      "amountIssued": {
        "value": 5,
        "currencyCode": "USD"
      },
      "dateIssued": "2022-11-21T03:00:34Z",
      "accountNumber": "A12345678",
      "accountIdentifier": "byTestAccount",
      "etid": "E000000",
      "utid": "U561593",
      "customerIdentifier": "byTestCustomer",
      "recipient": {
        "email": "[email protected]",
        "firstName": "xxx",
        "lastName": "xxxxx"
      }
    },
    {
      "referenceLineItemID": "RA123456-12345-12-1",
      "referenceOrderID": "RA123456-12345-12",
      "orderSource": "RA",
      "status": "COMPLETE",
      "orderStatus": "COMPLETE",
      "emailStatus": "NOT_APPLICABLE",
      "lineNumber": 1,
      "rewardName": "1-800-FLOWERS.COM® Gift Card $10.00",
      "amountIssued": {
        "value": 10,
        "currencyCode": "USD"
      },
      "dateIssued": "2022-11-20T13:57:23Z",
      "expirationDate": "2023-11-18T00:00:00Z",
      "accountNumber": "A12345678",
      "accountIdentifier": "zoon-test-2",
      "utid": "U935268",
      "customerIdentifier": "zoon-test-1"
    },
    {
      "referenceLineItemID": "RA123456-12345-12-1",
      "referenceOrderID": "RA123456-12345-12",
      "orderSource": "RA",
      "status": "COMPLETE",
      "orderStatus": "COMPLETE",
      "emailStatus": "NOT_APPLICABLE",
      "lineNumber": 1,
      "rewardName": "1-800-FLOWERS.COM® Gift Card $50.00",
      "amountIssued": {
        "value": 50,
        "currencyCode": "USD"
      },
      "dateIssued": "2022-11-20T03:57:21Z",
      "expirationDate": "2023-11-18T00:00:00Z",
      "accountNumber": "A12345678",
      "accountIdentifier": "zoon-test-2",
      "utid": "U106098",
      "customerIdentifier": "zoon-test-1"
    },
    {
      "referenceLineItemID": "RA123456-12345-12-1",
      "referenceOrderID": "RA123456-12345-12",
      "orderSource": "RA",
      "status": "COMPLETE",
      "orderStatus": "COMPLETE",
      "emailStatus": "NOT_APPLICABLE",
      "lineNumber": 1,
      "rewardName": "1-800-FLOWERS.COM® Gift Card $10.00",
      "amountIssued": {
        "value": 10,
        "currencyCode": "USD"
      },
      "dateIssued": "2022-11-25T08:46:14Z",
      "expirationDate": "2023-11-18T00:00:00Z",
      "accountNumber": "A12345678",
      "accountIdentifier": "pacc123",
      "utid": "U935268",
      "customerIdentifier": "pankaj123",
      "recipient": {
        "email": "[email protected]",
        "firstName": "qqqqq",
        "lastName": "qqqqqq"
      }
    },
    {
      "referenceLineItemID": "RA123456-12345-12-1",
      "referenceOrderID": "RA123456-12345-12",
      "orderSource": "RA",
      "status": "COMPLETE",
      "orderStatus": "COMPLETE",
      "emailStatus": "NOT_APPLICABLE",
      "lineNumber": 1,
      "rewardName": "1-800-FLOWERS.COM® Gift Card $10.00",
      "amountIssued": {
        "value": 10,
        "currencyCode": "USD"
      },
      "dateIssued": "2022-11-19T20:31:16Z",
      "expirationDate": "2023-11-18T00:00:00Z",
      "accountNumber": "A12345678",
      "accountIdentifier": "pacc123",
      "utid": "U935268",
      "customerIdentifier": "panka123",
      "recipient": {
        "email": "[email protected]",
        "firstName": "qqqqq",
        "lastName": "qqqqqq"
      }
    },
    {
      "referenceLineItemID": "RA123456-12345-12-1",
      "referenceOrderID": "RA123456-12345-12",
      "orderSource": "RA",
      "status": "COMPLETE",
      "orderStatus": "COMPLETE",
      "emailStatus": "NOT_APPLICABLE",
      "lineNumber": 1,
      "rewardName": "1-800-FLOWERS.COM® Gift Card $10.00",
      "amountIssued": {
        "value": 10,
        "currencyCode": "USD"
      },
      "dateIssued": "2022-11-20T13:37:23Z",
      "expirationDate": "2023-11-18T00:00:00Z",
      "accountNumber": "A12345678",
      "accountIdentifier": "pacc123",
      "utid": "U935268",
      "customerIdentifier": "panka123",
      "recipient": {
        "email": "[email protected]",
        "firstName": "qqqqq",
        "lastName": "qqqqq"
      }
    },
    {
      "referenceLineItemID": "RA123456-12345-12-1",
      "referenceOrderID": "RA123456-12345-12",
      "orderSource": "RA",
      "status": "COMPLETE",
      "orderStatus": "COMPLETE",
      "emailStatus": "NOT_APPLICABLE",
      "lineNumber": 1,
      "rewardName": "1-800-FLOWERS.COM® Gift Card $10.00",
      "amountIssued": {
        "value": 10,
        "currencyCode": "USD"
      },
      "dateIssued": "2022-11-20T12:25:18Z",
      "expirationDate": "2023-11-18T00:00:00Z",
      "accountNumber": "A12345678",
      "accountIdentifier": "pacc123",
      "utid": "U935268",
      "customerIdentifier": "qqqqq123",
      "recipient": {
        "email": "[email protected]",
        "firstName": "qqqqq",
        "lastName": "qqqqqq"
      }
    },
    {
      "referenceLineItemID": "RA123456-12345-12-1",
      "referenceOrderID": "RA123456-12345-12",
      "orderSource": "RA",
      "status": "COMPLETE",
      "orderStatus": "COMPLETE",
      "emailStatus": "DELIVERED",
      "lineNumber": 1,
      "rewardName": "Reward Link Preferred",
      "amountIssued": {
        "value": 1,
        "currencyCode": "USD"
      },
      "dateIssued": "2022-11-27T08:09:07Z",
      "accountNumber": "A12345678",
      "accountIdentifier": "123456789",
      "etid": "E070607",
      "utid": "U561593",
      "customerIdentifier": "123456789",
      "recipient": {
        "email": "[email protected]",
        "firstName": "qqqqqq",
        "lastName": "qqq"
      }
    },
    {
      "referenceLineItemID": "RA123456-12345-12-1",
      "referenceOrderID": "RA123456-12345-12",
      "orderSource": "RA",
      "status": "COMPLETE",
      "orderStatus": "COMPLETE",
      "emailStatus": "DELIVERED",
      "lineNumber": 1,
      "rewardName": "Reward Link Preferred",
      "amountIssued": {
        "value": 1,
        "currencyCode": "USD"
      },
      "dateIssued": "2022-11-27T22:26:11Z",
      "accountNumber": "A77897566",
      "accountIdentifier": "987654321",
      "etid": "E070607",
      "utid": "U561593",
      "customerIdentifier": "123456789",
      "recipient": {
        "email": "[email protected]",
        "firstName": "Qathinksterapp3",
        "lastName": "Qc"
      }
    },
    {
      "referenceLineItemID": "RA221118-77425-94-1",
      "referenceOrderID": "RA221118-77425-94",
      "orderSource": "RA",
      "status": "COMPLETE",
      "orderStatus": "COMPLETE",
      "emailStatus": "NOT_APPLICABLE",
      "lineNumber": 1,
      "rewardName": "1-800-FLOWERS.COM® Gift Card $25.00",
      "amountIssued": {
        "value": 25,
        "currencyCode": "USD"
      },
      "dateIssued": "2022-11-26T11:25:18Z",
      "expirationDate": "2023-11-18T00:00:00Z",
      "accountNumber": "A60427368",
      "accountIdentifier": "zoon-test-2",
      "utid": "U683701",
      "customerIdentifier": "zoon-test-1"
    },
    {
      "referenceLineItemID": "RA221118-77425-93-1",
      "referenceOrderID": "RA221118-77425-93",
      "orderSource": "RA",
      "status": "COMPLETE",
      "orderStatus": "COMPLETE",
      "emailStatus": "NOT_APPLICABLE",
      "lineNumber": 1,
      "rewardName": "1-800-FLOWERS.COM® Gift Card $10.00",
      "amountIssued": {
        "value": 10,
        "currencyCode": "USD"
      },
      "dateIssued": "2022-11-29T14:08:36Z",
      "expirationDate": "2023-11-18T00:00:00Z",
      "accountNumber": "A60427368",
      "accountIdentifier": "zoon-test-2",
      "utid": "U935268",
      "customerIdentifier": "zoon-test-1"
    },
    {
      "referenceLineItemID": "RA221117-77400-26-1",
      "referenceOrderID": "RA221117-77400-26",
      "orderSource": "RA",
      "status": "COMPLETE",
      "orderStatus": "COMPLETE",
      "emailStatus": "NOT_APPLICABLE",
      "lineNumber": 1,
      "rewardName": "1-800-FLOWERS.COM® Gift Card $10.00",
      "amountIssued": {
        "value": 10,
        "currencyCode": "USD"
      },
      "dateIssued": "2022-11-23T21:24:31Z",
      "expirationDate": "2023-11-17T00:00:00Z",
      "accountNumber": "A60427368",
      "accountIdentifier": "zoon-test-2",
      "utid": "U935268",
      "customerIdentifier": "zoon-test-1"
    },
    {
      "referenceLineItemID": "RA221117-77389-43-1",
      "referenceOrderID": "RA221117-77389-43",
      "orderSource": "RA",
      "status": "COMPLETE",
      "orderStatus": "COMPLETE",
      "emailStatus": "DELIVERED",
      "lineNumber": 1,
      "rewardName": "Reward Link Preferred",
      "amountIssued": {
        "value": 5,
        "currencyCode": "USD"
      },
      "dateIssued": "2022-11-18T18:47:03Z",
      "accountNumber": "A86157106",
      "accountIdentifier": "byTestAccount",
      "etid": "E000000",
      "utid": "U561593",
      "customerIdentifier": "byTestCustomer",
      "recipient": {
        "email": "[email protected]",
        "firstName": "Noah",
        "lastName": "Welter"
      }
    },
    {
      "referenceLineItemID": "RA221117-77385-40-1",
      "referenceOrderID": "RA221117-77385-40",
      "orderSource": "RA",
      "status": "COMPLETE",
      "orderStatus": "COMPLETE",
      "emailStatus": "DELIVERED",
      "lineNumber": 1,
      "rewardName": "Reward Link Preferred",
      "amountIssued": {
        "value": 5,
        "currencyCode": "USD"
      },
      "dateIssued": "2022-11-21T17:38:38Z",
      "accountNumber": "A86157106",
      "accountIdentifier": "byTestAccount",
      "etid": "E000000",
      "utid": "U561593",
      "customerIdentifier": "byTestCustomer",
      "recipient": {
        "email": "[email protected]",
        "firstName": "Noah",
        "lastName": "Welter"
      }
    },
    {
      "referenceLineItemID": "RA221117-77329-27-1",
      "referenceOrderID": "RA221117-77329-27",
      "orderSource": "RA",
      "status": "COMPLETE",
      "orderStatus": "COMPLETE",
      "emailStatus": "BOUNCE",
      "lineNumber": 1,
      "rewardName": "Amazon.com Gift Card",
      "amountIssued": {
        "value": 1,
        "currencyCode": "USD"
      },
      "dateIssued": "2022-11-24T05:45:58Z",
      "accountNumber": "A93834415",
      "accountIdentifier": "athenahealth",
      "etid": "E536319",
      "utid": "U163059",
      "customerIdentifier": "athenahealth",
      "recipient": {
        "email": "[email protected]",
        "firstName": "GATEWOODC",
        "lastName": "GATEWOODC"
      }
    },
    {
      "referenceLineItemID": "RA221117-77321-38-1",
      "referenceOrderID": "RA221117-77321-38",
      "orderSource": "RA",
      "status": "COMPLETE",
      "orderStatus": "COMPLETE",
      "emailStatus": "BOUNCE",
      "lineNumber": 1,
      "rewardName": "AE® Gift Card",
      "amountIssued": {
        "value": 0.01,
        "currencyCode": "USD"
      },
      "dateIssued": "2022-11-17T17:42:53Z",
      "accountNumber": "A93834415",
      "accountIdentifier": "athenahealth",
      "etid": "E536319",
      "utid": "U532744",
      "customerIdentifier": "athenahealth",
      "recipient": {
        "email": "[email protected]",
        "firstName": "GATEWOODC",
        "lastName": "GATEWOODC"
      }
    },
    {
      "referenceLineItemID": "RA123456-12345-12-1",
      "referenceOrderID": "RA123456-12345-12",
      "orderSource": "RA",
      "status": "COMPLETE",
      "orderStatus": "COMPLETE",
      "emailStatus": "BOUNCE",
      "lineNumber": 1,
      "rewardName": "Amazon.com Gift Card",
      "amountIssued": {
        "value": 0.01,
        "currencyCode": "USD"
      },
      "dateIssued": "2022-11-22T08:08:13Z",
      "accountNumber": "A12345678",
      "accountIdentifier": "athenahealth",
      "etid": "E536319",
      "utid": "U163059",
      "customerIdentifier": "athenahealth",
      "recipient": {
        "email": "[email protected]",
        "firstName": "GATE",
        "lastName": "GATE"
      }
    },
    {
      "referenceLineItemID": "RA123456-12345-12-1",
      "referenceOrderID": "RA123456-12345-12",
      "orderSource": "RA",
      "status": "COMPLETE",
      "orderStatus": "COMPLETE",
      "emailStatus": "DELIVERED",
      "lineNumber": 1,
      "rewardName": "Reward Link Preferred",
      "amountIssued": {
        "value": 2,
        "currencyCode": "USD"
      },
      "dateIssued": "2022-11-24T08:03:17Z",
      "accountNumber": "A12345678",
      "accountIdentifier": "987654321",
      "etid": "E070607",
      "utid": "U561593",
      "customerIdentifier": "123456789",
      "recipient": {
        "email": "[email protected]",
        "firstName": "qqqqqqq",
        "lastName": "qq"
      }
    }
  ]
}

Endpoint Filters

Endpoint Filter	Data Type	Description
referenceOrderID	string	A unique identifier for an order
externalRefId	string	Specifies the external reference order ID
status	string	The line item status to be retrieved for each line item. The available values are: - COMPLETE - PENDING - FAILED - CANCELLED
emailStatus	string	The email status to be retrieved for each line item. The available values are: - DELIVERED - NOT_DELIVERED - PENDING - SENT - DEFERRED - DROPPED - BOUNCE - BLOCKED
orderStatus	string	The order status to be retrieved for each line item. The available values are: - COMPLETE - PENDING - FAILED - CANCELLED - PARTIAL
orderSource	string	The order source to be retrieved for each line item. The available values are: - RA (orders placed using RaaS API) - RG (orders placed using Rewards Genius) - BE (orders placed using bulk-external upload) - BI (orders placed using bulk-internal upload) - CI (orders placed using code pulls) - QW (orders placed using Qualtrics)
recipientEmail	string	A recipient's email address. This will return line items across all orders.
recipientFirstName	string	The recipient’s first name. This will return line items across all orders.
recipientLastName	string	The recipient’s last name. This will return line items across all orders.
accountIdentifier	string	The account identifier used to place an order. This will return line items across all orders.
startDate	string	Specifies the starting date or date time to be queried according to RFC 3339, i.e. "2016-01-01" or "2016-01-01T00:00:00Z". See https://www.ietf.org/rfc/rfc3339.txt
endDate	string	Specifies the ending date or date time to be queried according to RFC 3339, i.e. "2016-01-01" or "2016-01-01T00:00:00Z". See https://www.ietf.org/rfc/rfc3339.txt
columnSortName	string	Specifies the column name to sort by: - accountNumber - amountIssued - dateIssued - emailStatus - externalReferenceID - status - orderSource - orderStatus - recipientFirstName - recipientLastName - rewardName If columnSortName is not specified, it will sort by dateIssued.
columnSortAscending	boolean	- True will sort by ascending order for the column specified in columnSortName. - False will sort by descending order for the column specified in columnSortName. - If columnSortName is not specified, it will sort by dateIssued.
elementsPerBlock	nt32	Specifies the number of elements returned by page
pagePrevious	boolean	- True returns the previous page - False returns the next page
PageKeys	array of strings	This filter uses keyset paging. To move to the next page, use the nextPageKeys object from the keySetPage object. The nextKeyPage object is an array of two strings.

Retrieve Details of a Specific Line Item

Use the /lineItems/{referenceLineItemID} endpoint to retrieve the details such as reward credentials of a specific line item and the redemption history. For the real-time balance of the reward, you can subtract the redemption history from the total amount issued.

GET https://{URI} /lineItems/{referenceLineItemID}

Path Parameter

{referenceLineItemID}

The identification of the line item you request to get the details. The system autogenerates it, and you can find it by using the LineItems endpoint.

Sample Response

{
    "referenceLineItemID": "RG123456-7890-12-3",
    "referenceOrderID": "RG123456-7890-12",
    "orderSource": "RG",
    "status": "COMPLETE",
    "orderStatus": "COMPLETE",
    "emailStatus": "DELIVERED",
    "lineNumber": 1,
    "rewardName": "Reward Link Preferred",
    "amountIssued": {
        "value": 10.0,
        "currencyCode": "USD"
    },
    "dateIssued": "2021-02-24T06:38:39Z",
    "accountNumber": "A13526256",
    "accountIdentifier": "A13526256",
    "etid": "E657563",
    "utid": "U655643",
    "customerIdentifier": "G38861318",
    "recipient": {
        "email": "[email protected]",
        "firstName": "Elliott",
        "lastName": ""
    },
    "sender": {
        "firstName": "Your Team",
        "lastName": "",
        "email": ""
    },
    "reward": {
        "credentials": {
            "Expiration Date": "",
            "Redemption Link": "https://sandbox.rewardlink.io/r/1/xZZa2Yu1TD831fjhkwRiA9pTLq_KMTagJoyTH8oIMyM"
        },
        "credentialList": [
            {
                "label": "Redemption Link",
                "value": "https://sandbox.rewardlink.io/r/1/xZZa2Yu1TD831fjhkwRiA9pTLq_KMTagJoyTH8oIMyM",
                "type": "url",
                "credentialType": "redemptionUrl"
            },
            {
                "label": "Expiration Date",
                "value": "",
                "type": "date",
                "credentialType": "expirationDate"
            }
        ],
        "redemptionInstructions": "<p>Read Terms & Conditions</p>\r\n\r\n<ul><li>Click the redemption link above to activate your Reward Link.</li><li>Next, spend your reward balance.</li></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"
    },
    "redemptionHistory": [
        {
            "referenceLineItemID": "RL123456-7890-12-3",
            "referenceOrderID": "RL123456-7890-12",
            "orderSource": "RL",
            "status": "COMPLETE",
            "orderStatus": "COMPLETE",
            "emailStatus": "DELIVERED",
            "lineNumber": 2,
            "rewardName": "Amazon.com Gift Card",
            "amountIssued": {
                "value": 5.0,
                "currencyCode": "USD"
            },
            "dateIssued": "2021-02-26T09:48:51Z",
            "etid": "E657563",
            "utid": "U666425",
            "recipient": {
                "email": "[email protected]",
                "firstName": "Elliott",
                "lastName": null
            },
            "sender": {
                "firstName": "Reward",
                "lastName": "Link",
                "email": "[email protected]"
            }
        },
        {
            "referenceLineItemID": "RL123456-7890-12-3",
            "referenceOrderID": "RL123456-7890-12",
            "orderSource": "RL",
            "status": "COMPLETE",
            "orderStatus": "COMPLETE",
            "emailStatus": "DELIVERED",
            "lineNumber": 1,
            "rewardName": "Starbucks eGift",
            "amountIssued": {
                "value": 5.0,
                "currencyCode": "USD"
            },
            "dateIssued": "2021-02-26T09:48:51Z",
            "etid": "E657563",
            "utid": "U761382",
            "recipient": {
                "email": "[email protected]",
                "firstName": "Elliott",
                "lastName": null
            },
            "sender": {
                "firstName": "Reward",
                "lastName": "Link",
                "email": "[email protected]"
            }
        }
    ]
}

Resend a Line Item

Use the /lineItems/{referenceLineItemID}/resends endpoint to resend a specific line item to the same email address.

POST https://{URI} / lineItems/{referenceLineItemId}/resends

Path Parameter

/ lineItems/{referenceLineItemId}/resends

So that you know – the identification of the line item you requested will be resent. The system autogenerates it, and you can find it by using the lineItem endpoint.

Sample Request

{
    "id": 957806,
    "legacyId": null,
    "createdAt": "2021-11-09T23:54:48.903Z",
    "email": "[email protected]"
}

Sample Response

{
  "ID": 0,
  "Legacy ID (only when resending v1 orders)": "string",
  "Created Date": "2022-11-14T17:02:45.166Z",
  "Email address that the resend was sent to": "string"
}

Resend an Order

Resend a past order. Perform a POST …/{referenceOrderID}/resends to resend the order

{
  "newEmail": "[email protected]"
}

github.com

tangocard/tangocard-raas-client-starter