Check our Sample API

Overview

You can find some of our sample API codes here for your reference:

Create Customer Identifier

Perform a POST {URI}/customers call to create a customer identifier. The customer identifier must be lowercase.

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

Create Account Identifier

Perform a POST {URI}/accounts call to create an account identifier under the customer you created. The account identifier must be lowercase.

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

Register Credit Card

Perform a ???????????????? call to register a fake credit card to your account. For details, see how to fund your operation.

{
  "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 Your Account

Perform a POST {URI}/creditCardDeposits call to fund your account.

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

Check Balance

Perform a GET {URI}/accounts call to confirm the funding of your account and view 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

Perform a GET {URI}/catalogs call to view the items in your platform’s catalog and see what you can order.

{
    "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"
                }
            ]
        }
    ]
}

Catalog Filters
Perform a GET {URI}/catalogs call to get details for specific items or groupings using the following endpoint filters:

Endpoint FilterDescription
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.

Create an Order

Perform a POST {URI}/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

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

{
    "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

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

{
    "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

Perform a GET {URI} /lineItems call to retrieve a list of line items ordered.

{
  "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
Use the following line item filters to get more specific details regarding line items:

Endpoint FilterData TypeDescription
referenceOrderIDstringA unique identifier for an order

Retrieve Details of a Specific Line Item

Perform a GET {URI} /lineItems/{referenceLineItemID} call 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, subtract the redemption history from the total amount issued.

{
    "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

Perform a POST {URI}/ lineItems/{referenceLineItemId}/resends call to resend a specific line item to the same email address. The identification of the line item you requested will be resent. The system autogenerates it, and you can find it by using the line Item 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

Perform a POST {URI}/orders/{referenceOrderID}/resends to resend a previous-sent order.

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