Get details for a specific line item

Use the following endpoint to retrieve all details for a specific line item in Tango. This endpoint looks up a line item by its unique ID, or referenceLineItemID and returns a detailed payload including: status and permissions, reward credentials, amount issued and charged, remaining balance, dates, sender and recipient information, redemption history, and much more:

EndpointDescription
GET {URI}/lineItems/{referenceLineItemID}Get details for a specific line item.

This endpoint needs the following query parameter to return detailed information. The referenceLineItemID is created by the system when the line item is issued. You can retrieve it by calling the Line Items endpoint first, then use it here to get full details.

Query paramsData typeDescription
referenceLineItemIDstringReference line item ID is returned in the Line Items response.

Remaining balance

The remaining balance in the response payload refers to the funds remaining on a card after a purchase or transaction. remainingBalance is part of the returned payload when you use the GET {URI}/lineItems/{referenceLineItemID} endpoint. Tango can only track and display the remaining balance for Choice products because these are managed within Tango’s system. For Open-loop and Closed-loop cards—such as prepaid Visa, Mastercard, or branded gift cards—Tango does not have access to real-time balances. As a result, these products will always show a balance of null in Tango, even though the card itself may still have funds.

📘

Note:

The remaining balance is only true for our Choice products. All other Open-loop and Closed-loop cards show a balance of null.

Remaining balance example

Acme Health issues digital wellness cards to employees. Both administrators and employees need to know the remaining balance on each card when checking a line item in the system. When Acme Health calls the endpoint, the response includes the remainingBalance. The cards typically fall into two categories:

  • Open-loop and Closed-loop Cards: These function like debit cards and can be used anywhere. For these cards, the remaining balance is always null because Acme Health doesn’t track spending after issuance.
  • Choice Products: Employees can select from multiple wellness options. For these cards, the remaining balance is calculated as the amount originally issued minus the total amount charged, using Acme Health’s database or cache. Choice products include Reward Link® (RL), Global Choice Link, Promo Link™ (PL), and Disbursement Link (DL). See Manage Choice products.

Reward view history

The rewardViewHistory in the response payload helps you track when a reward was viewed. This feature is used for auditing, analyzing user behavior, enhancing the user experience, and detecting fraud and unusual patterns. Each entry includes the date and status of the view event, enabling API clients to monitor reward access. Refer to the rewardViewHistory array in the response payload of GET {URI}/lineItems/{referenceLineItemID}.

{
  ...
  "rewardViewHistory": [
    {
      "date": "2026-01-13T19:32:02.154Z",
      "status": "string"
    }
  ]
}

Resend history

The resend history in the response payload tracks when a reward has been resent to the recipient. Use this when investigating fraud or determining the frequency of resending the reward. This history shows who resent the reward, when it was resent, the email address or mobile number it was sent to, and its delivery status.

"resendHistory": [
{{ {}}
{{ "dateIssued": "2023-02-02T17:16:39.269Z",}}
{{ "sender": {}}
{{ "firstName": "string",}}
{{ "lastName": "string",}}
{{ "email": "string"}}
{{ }}}
{{ "recipient": {}}
{{ "email": "string",}

Note worthy callouts...

The reward status in the response payload indicates whether a reward is frozen or active.

Note that we have deprecated credentials , but use credentialList instead. credentailList is a set of attributes that is returned on an order specifying how to access the purchased reward. credentailList contains credential type, label, value, and other stable parameters. See how to Get credential type.

{
  "referenceLineItemID": "string",
  "externalReferenceLineItemID": "string",
  "referenceOrderID": "string",
  "orderSource": "string",
  "status": "string",
  "orderStatus": "string",
  "emailStatus": "string",
  "deliveryMethod": "string",
  "deliveryStatus": "string",
  "rewardStatus": "string",
  "canCancel": true,
  "canFreeze": true,
  "lineNumber": 0,
  "rewardName": "string",
  "amountIssued": {
    "value": 0,
    "currencyCode": "string",
    "exchangeRate": 0,
    "fee": 0,
    "total": 0
  },
  "amountCharged": {
    "value": 0,
    "currencyCode": "string",
    "exchangeRate": 0,
    "fee": 0,
    "total": 0
  },
  "remainingBalance": 0,
  "dateIssued": "2026-01-13T19:32:02.154Z",
  "expirationDate": "2026-01-13T19:32:02.154Z",
  "accountNumber": "string",
  "accountIdentifier": "string",
  "etid": "string",
  "ptid": "string",
  "utid": "string",
  "customerIdentifier": "string",
  "recipient": {
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "mobileNumber": "string",
    "address": {
      "companyName": "string",
      "streetLine1": "string",
      "streetLine2": "string",
      "city": "string",
      "stateOrProvince": "string",
      "postalCode": "string",
      "country": "string"
    }
  },
  "sender": {
    "firstName": "string",
    "lastName": "string",
    "email": "string"
  },
  "purchaseOrderNumber": "string",
  "campaign": "string",
  "orderNotes": "string",
  "lineItemActionReason": "string",
  "reissuedFromReferenceLineItemId": "string",
  "reissuedToReferenceLineItemId": "string",
  "lineItemErrors": [
    {
      "error_code": "string",
      "error_message": "string"
    }
  ],
  "reward": {
    "credentials": {
      "additionalProp": "string"
    },
    "credentialList": [
      {
        "label": "string",
        "value": "string",
        "type": "string",
        "credentialType": "string"
      }
    ],
    "redemptionInstructions": "string"
  },
  "resendHistory": [
    {
      "dateIssued": "2026-01-13T19:32:02.154Z",
      "sender": {
        "firstName": "string",
        "lastName": "string",
        "email": "string"
      },
      "recipient": {
        "email": "string",
        "mobileNumber": "string"
      },
      "deliveryMethod": "string",
      "deliveryStatus": "string",
      "etid": "string",
      "reasonCode": "NOT_RECEIVED",
      "otherReason": "string"
    }
  ],
  "redemptionHistory": [
    {
      "referenceLineItemID": "string",
      "externalReferenceLineItemID": "string",
      "referenceOrderID": "string",
      "orderSource": "string",
      "status": "string",
      "orderStatus": "string",
      "emailStatus": "string",
      "deliveryMethod": "string",
      "deliveryStatus": "string",
      "rewardStatus": "string",
      "canCancel": true,
      "canFreeze": true,
      "lineNumber": 0,
      "rewardName": "string",
      "amountIssued": {
        "value": 0,
        "currencyCode": "string",
        "exchangeRate": 0,
        "fee": 0,
        "total": 0
      },
      "amountCharged": {
        "value": 0,
        "currencyCode": "string",
        "exchangeRate": 0,
        "fee": 0,
        "total": 0
      },
      "remainingBalance": 0,
      "dateIssued": "2026-01-13T19:32:02.154Z",
      "etid": "string",
      "ptid": "string",
      "utid": "string",
      "recipient": {
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "mobileNumber": "string",
        "address": {
          "companyName": "string",
          "streetLine1": "string",
          "streetLine2": "string",
          "city": "string",
          "stateOrProvince": "string",
          "postalCode": "string",
          "country": "string"
        }
      },
      "sender": {
        "firstName": "string",
        "lastName": "string",
        "email": "string"
      },
      "lineItemErrors": [
        {
          "error_code": "string",
          "error_message": "string"
        }
      ]
    }
  ],
  "lineItemActionHistory": [
    {
      "action": "string",
      "reason": "string",
      "actionDate": "string",
      "oldReferenceLineItemId": "string",
      "newReferenceLineItemId": "string"
    }
  ],
  "rewardViewHistory": [
    {
      "date": "2026-01-13T19:32:02.154Z",
      "status": "string"
    }
  ]
}

Here's an example payload for when you receive an error:

{
  "timestamp": "2025-02-21T23:23:13.930Z",
  "requestId": "string",
  "path": "string",
  "httpCode": 0,
  "httpPhrase": "string",
  "i18nKey": "string",
  "message": "The error message will show here for error codes ",
  "errors": [
    {}
  ]
}

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

ResponseDescription
200The request was successful.
400The server could not understand the request due to invalid syntax.
401Authentication is required, but it has either not been provided or failed.
403The server understood the request but refused to authorize it.
404The server could not find the requested resource. In other words, the URL you’re trying to access doesn’t point to anything that exists on the server.

© 2025 Tango API are provided by Tango, a division of BHN, Inc.